Class LocationPolicy (1.105.0)

1.105.0 (latest) 1.104.0 1.103.0 1.101.0 1.98.0 1.97.0 1.95.0 1.93.0 1.92.0 1.91.0 1.90.0 1.88.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.80.0 1.78.0 1.77.0 1.74.0 1.73.0 1.72.0 1.70.0 1.69.0 1.68.0 1.67.0 1.66.0 1.65.0 1.64.0 1.63.0 1.62.0 1.61.0 1.59.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.0 1.12.1 1.11.0 1.9.1 1.8.1 1.7.2 1.6.0-beta

public final class LocationPolicy extends GeneratedMessage implements LocationPolicyOrBuilder

Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).

Protobuf type google.cloud.compute.v1.LocationPolicy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > LocationPolicy

Implements

LocationPolicyOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

LOCATIONS_FIELD_NUMBER

public static final int LOCATIONS_FIELD_NUMBER

Field Value
Type	Description
int

TARGET_SHAPE_FIELD_NUMBER

public static final int TARGET_SHAPE_FIELD_NUMBER

Field Value
Type	Description
int

ZONES_FIELD_NUMBER

public static final int ZONES_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static LocationPolicy getDefaultInstance()

Returns
Type	Description
LocationPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static LocationPolicy.Builder newBuilder()

Returns
Type	Description
LocationPolicy.Builder

newBuilder(LocationPolicy prototype)

public static LocationPolicy.Builder newBuilder(LocationPolicy prototype)

Parameter
Name	Description
prototype	LocationPolicy

Returns
Type	Description
LocationPolicy.Builder

parseDelimitedFrom(InputStream input)

public static LocationPolicy parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocationPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static LocationPolicy parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LocationPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LocationPolicy parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LocationPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LocationPolicy parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LocationPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static LocationPolicy parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LocationPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static LocationPolicy parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LocationPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LocationPolicy

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<LocationPolicy> parser()

Returns
Type	Description
Parser<LocationPolicy>

Methods

containsLocations(String key)

public boolean containsLocations(String key)

Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a. The bulkInsert operation doesn't create instances in an AI zone, even if an AI zone is available in the specified region. For example, if you set a DENY preference for us-central1-a, Compute Engine will consider us-central1-b and us-central1-c for instance creation, but not us-central1-ai1a. Also, you can't use the locations[] configuration to allow instance creation in an AI zone. To include an AI zone in bulkInsert operations, use the locationPolicy.zones[] field.

map<string, .google.cloud.compute.v1.LocationPolicyLocation> locations = 413423454;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public LocationPolicy getDefaultInstanceForType()

Returns
Type	Description
LocationPolicy

getLocations() (deprecated)

public Map<String,LocationPolicyLocation> getLocations()

Use #getLocationsMap() instead.

Returns
Type	Description
Map<String,LocationPolicyLocation>

getLocationsCount()

public int getLocationsCount()

Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a. The bulkInsert operation doesn't create instances in an AI zone, even if an AI zone is available in the specified region. For example, if you set a DENY preference for us-central1-a, Compute Engine will consider us-central1-b and us-central1-c for instance creation, but not us-central1-ai1a. Also, you can't use the locations[] configuration to allow instance creation in an AI zone. To include an AI zone in bulkInsert operations, use the locationPolicy.zones[] field.

map<string, .google.cloud.compute.v1.LocationPolicyLocation> locations = 413423454;

Returns
Type	Description
int

getLocationsMap()

public Map<String,LocationPolicyLocation> getLocationsMap()

Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a. The bulkInsert operation doesn't create instances in an AI zone, even if an AI zone is available in the specified region. For example, if you set a DENY preference for us-central1-a, Compute Engine will consider us-central1-b and us-central1-c for instance creation, but not us-central1-ai1a. Also, you can't use the locations[] configuration to allow instance creation in an AI zone. To include an AI zone in bulkInsert operations, use the locationPolicy.zones[] field.

map<string, .google.cloud.compute.v1.LocationPolicyLocation> locations = 413423454;

Returns
Type	Description
Map<String,LocationPolicyLocation>

getLocationsOrDefault(String key, LocationPolicyLocation defaultValue)

public LocationPolicyLocation getLocationsOrDefault(String key, LocationPolicyLocation defaultValue)

Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a. The bulkInsert operation doesn't create instances in an AI zone, even if an AI zone is available in the specified region. For example, if you set a DENY preference for us-central1-a, Compute Engine will consider us-central1-b and us-central1-c for instance creation, but not us-central1-ai1a. Also, you can't use the locations[] configuration to allow instance creation in an AI zone. To include an AI zone in bulkInsert operations, use the locationPolicy.zones[] field.

map<string, .google.cloud.compute.v1.LocationPolicyLocation> locations = 413423454;

Parameters
Name	Description
key	String
defaultValue	LocationPolicyLocation

Returns
Type	Description
LocationPolicyLocation

getLocationsOrThrow(String key)

public LocationPolicyLocation getLocationsOrThrow(String key)

Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a. The bulkInsert operation doesn't create instances in an AI zone, even if an AI zone is available in the specified region. For example, if you set a DENY preference for us-central1-a, Compute Engine will consider us-central1-b and us-central1-c for instance creation, but not us-central1-ai1a. Also, you can't use the locations[] configuration to allow instance creation in an AI zone. To include an AI zone in bulkInsert operations, use the locationPolicy.zones[] field.

map<string, .google.cloud.compute.v1.LocationPolicyLocation> locations = 413423454;

Parameter
Name	Description
key	String

Returns
Type	Description
LocationPolicyLocation

getParserForType()

public Parser<LocationPolicy> getParserForType()

Returns
Type	Description
Parser<LocationPolicy>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getTargetShape()

public String getTargetShape()

Strategy for distributing VMs across zones in a region. Check the TargetShape enum for the list of possible values.

optional string target_shape = 338621299;

Returns
Type	Description
String	The targetShape.

getTargetShapeBytes()

public ByteString getTargetShapeBytes()

Strategy for distributing VMs across zones in a region. Check the TargetShape enum for the list of possible values.

optional string target_shape = 338621299;

Returns
Type	Description
ByteString	The bytes for targetShape.

getZones(int index)

public LocationPolicyZoneConfiguration getZones(int index)

The bulkInsert operation applies any preferences set in the locations field to the specific zones listed in the zones field if the same zones are specified in both fields.

repeated .google.cloud.compute.v1.LocationPolicyZoneConfiguration zones = 116085319;

Parameter
Name	Description
index	int

Returns
Type	Description
LocationPolicyZoneConfiguration

getZonesCount()

public int getZonesCount()

The bulkInsert operation applies any preferences set in the locations field to the specific zones listed in the zones field if the same zones are specified in both fields.

repeated .google.cloud.compute.v1.LocationPolicyZoneConfiguration zones = 116085319;

Returns
Type	Description
int

getZonesList()

public List<LocationPolicyZoneConfiguration> getZonesList()

The bulkInsert operation applies any preferences set in the locations field to the specific zones listed in the zones field if the same zones are specified in both fields.

repeated .google.cloud.compute.v1.LocationPolicyZoneConfiguration zones = 116085319;

Returns
Type	Description
List<LocationPolicyZoneConfiguration>

getZonesOrBuilder(int index)

public LocationPolicyZoneConfigurationOrBuilder getZonesOrBuilder(int index)

The bulkInsert operation applies any preferences set in the locations field to the specific zones listed in the zones field if the same zones are specified in both fields.

repeated .google.cloud.compute.v1.LocationPolicyZoneConfiguration zones = 116085319;

Parameter
Name	Description
index	int

Returns
Type	Description
LocationPolicyZoneConfigurationOrBuilder

getZonesOrBuilderList()

public List<? extends LocationPolicyZoneConfigurationOrBuilder> getZonesOrBuilderList()

The bulkInsert operation applies any preferences set in the locations field to the specific zones listed in the zones field if the same zones are specified in both fields.

repeated .google.cloud.compute.v1.LocationPolicyZoneConfiguration zones = 116085319;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.LocationPolicyZoneConfigurationOrBuilder>

hasTargetShape()

public boolean hasTargetShape()

Strategy for distributing VMs across zones in a region. Check the TargetShape enum for the list of possible values.

optional string target_shape = 338621299;

Returns
Type	Description
boolean	Whether the targetShape field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public LocationPolicy.Builder newBuilderForType()

Returns
Type	Description
LocationPolicy.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected LocationPolicy.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
LocationPolicy.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public LocationPolicy.Builder toBuilder()

Returns
Type	Description
LocationPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException