Package com.google.cloud.compute.v1

Class LocationPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.LocationPolicy
All Implemented Interfaces:
LocationPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class LocationPolicy extends com.google.protobuf.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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    LocationPolicy.Builder
    Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).
    static enum 
    LocationPolicy.TargetShape
    Strategy for distributing VMs across zones in a region.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    LOCATIONS_FIELD_NUMBER
     
    static final int
    TARGET_SHAPE_FIELD_NUMBER
     
    static final int
    ZONES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsLocations(String key)
    Location configurations mapped by location name.
    boolean
    equals(Object obj)
     
    static LocationPolicy
    getDefaultInstance()
     
    LocationPolicy
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Map<String,LocationPolicyLocation>
    getLocations()
    Deprecated.
    int
    getLocationsCount()
    Location configurations mapped by location name.
    Map<String,LocationPolicyLocation>
    getLocationsMap()
    Location configurations mapped by location name.
    LocationPolicyLocation
    getLocationsOrDefault(String key, LocationPolicyLocation defaultValue)
    Location configurations mapped by location name.
    LocationPolicyLocation
    getLocationsOrThrow(String key)
    Location configurations mapped by location name.
    com.google.protobuf.Parser<LocationPolicy>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getTargetShape()
    Strategy for distributing VMs across zones in a region.
    com.google.protobuf.ByteString
    getTargetShapeBytes()
    Strategy for distributing VMs across zones in a region.
    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.
    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.
    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.
    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.
    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.
    int
    hashCode()
     
    boolean
    hasTargetShape()
    Strategy for distributing VMs across zones in a region.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static LocationPolicy.Builder
    newBuilder()
     
    static LocationPolicy.Builder
    newBuilder(LocationPolicy prototype)
     
    LocationPolicy.Builder
    newBuilderForType()
     
    protected LocationPolicy.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static LocationPolicy
    parseDelimitedFrom(InputStream input)
     
    static LocationPolicy
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocationPolicy
    parseFrom(byte[] data)
     
    static LocationPolicy
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocationPolicy
    parseFrom(com.google.protobuf.ByteString data)
     
    static LocationPolicy
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocationPolicy
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static LocationPolicy
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocationPolicy
    parseFrom(InputStream input)
     
    static LocationPolicy
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static LocationPolicy
    parseFrom(ByteBuffer data)
     
    static LocationPolicy
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<LocationPolicy>
    parser()
     
    LocationPolicy.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getLocationsCount

      public int getLocationsCount()
      Description copied from interface: LocationPolicyOrBuilder
       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;
      Specified by:
      getLocationsCount in interface LocationPolicyOrBuilder

    • containsLocations

      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;
      Specified by:
      containsLocations in interface LocationPolicyOrBuilder

    • getLocations

      @Deprecated public Map<String,LocationPolicyLocation> getLocations()
      Deprecated.
      Use getLocationsMap() instead.
      Specified by:
      getLocations in interface LocationPolicyOrBuilder

    • 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;
      Specified by:
      getLocationsMap in interface LocationPolicyOrBuilder

    • getLocationsOrDefault

      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;
      Specified by:
      getLocationsOrDefault in interface LocationPolicyOrBuilder

    • getLocationsOrThrow

      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;
      Specified by:
      getLocationsOrThrow in interface LocationPolicyOrBuilder

    • 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;
      Specified by:
      hasTargetShape in interface LocationPolicyOrBuilder
      Returns:
      Whether the targetShape field is set.

    • 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;
      Specified by:
      getTargetShape in interface LocationPolicyOrBuilder
      Returns:
      The targetShape.

    • getTargetShapeBytes

      public com.google.protobuf.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;
      Specified by:
      getTargetShapeBytes in interface LocationPolicyOrBuilder
      Returns:
      The bytes for targetShape.

    • 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;
      Specified by:
      getZonesList in interface LocationPolicyOrBuilder

    • 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;
      Specified by:
      getZonesOrBuilderList in interface LocationPolicyOrBuilder

    • 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;
      Specified by:
      getZonesCount in interface LocationPolicyOrBuilder

    • getZones

      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;
      Specified by:
      getZones in interface LocationPolicyOrBuilder

    • getZonesOrBuilder

      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;
      Specified by:
      getZonesOrBuilder in interface LocationPolicyOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static LocationPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LocationPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LocationPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LocationPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LocationPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LocationPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static LocationPolicy parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static LocationPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static LocationPolicy parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static LocationPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static LocationPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static LocationPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public LocationPolicy.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static LocationPolicy.Builder newBuilder()

    • newBuilder

      public static LocationPolicy.Builder newBuilder(LocationPolicy prototype)

    • toBuilder

      public LocationPolicy.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected LocationPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static LocationPolicy getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<LocationPolicy> parser()

    • getParserForType

      public com.google.protobuf.Parser<LocationPolicy> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public LocationPolicy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder