Class Location

  • All Implemented Interfaces:
    LocationOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

    public final class Location
    extends com.google.protobuf.GeneratedMessageV3
    implements LocationOrBuilder
     A resource that represents Google Cloud Platform location.
     
    Protobuf type google.cloud.location.Location
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Location.Builder
      A resource that represents Google Cloud Platform location.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsLabels​(java.lang.String key)
      Cross-service attributes for the location.
      boolean equals​(java.lang.Object obj)  
      static Location getDefaultInstance()  
      Location getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getDisplayName()
      The friendly name for this location, typically a nearby city name.
      com.google.protobuf.ByteString getDisplayNameBytes()
      The friendly name for this location, typically a nearby city name.
      java.util.Map<java.lang.String,​java.lang.String> getLabels()
      Deprecated.
      int getLabelsCount()
      Cross-service attributes for the location.
      java.util.Map<java.lang.String,​java.lang.String> getLabelsMap()
      Cross-service attributes for the location.
      java.lang.String getLabelsOrDefault​(java.lang.String key, java.lang.String defaultValue)
      Cross-service attributes for the location.
      java.lang.String getLabelsOrThrow​(java.lang.String key)
      Cross-service attributes for the location.
      java.lang.String getLocationId()
      The canonical id for this location.
      com.google.protobuf.ByteString getLocationIdBytes()
      The canonical id for this location.
      com.google.protobuf.Any getMetadata()
      Service-specific metadata.
      com.google.protobuf.AnyOrBuilder getMetadataOrBuilder()
      Service-specific metadata.
      java.lang.String getName()
      Resource name for the location, which may vary between implementations.
      com.google.protobuf.ByteString getNameBytes()
      Resource name for the location, which may vary between implementations.
      com.google.protobuf.Parser<Location> getParserForType()  
      int getSerializedSize()  
      int hashCode()  
      boolean hasMetadata()
      Service-specific metadata.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection​(int number)  
      boolean isInitialized()  
      static Location.Builder newBuilder()  
      static Location.Builder newBuilder​(Location prototype)  
      Location.Builder newBuilderForType()  
      protected Location.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Location parseDelimitedFrom​(java.io.InputStream input)  
      static Location parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Location parseFrom​(byte[] data)  
      static Location parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Location parseFrom​(com.google.protobuf.ByteString data)  
      static Location parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Location parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Location parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Location parseFrom​(java.io.InputStream input)  
      static Location parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Location parseFrom​(java.nio.ByteBuffer data)  
      static Location parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Location> parser()  
      Location.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType
      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, isStringEmpty, 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
    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getName

        public java.lang.String getName()
         Resource name for the location, which may vary between implementations.
         For example: `"projects/example-project/locations/us-east1"`
         
        string name = 1;
        Specified by:
        getName in interface LocationOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Resource name for the location, which may vary between implementations.
         For example: `"projects/example-project/locations/us-east1"`
         
        string name = 1;
        Specified by:
        getNameBytes in interface LocationOrBuilder
        Returns:
        The bytes for name.
      • getLocationId

        public java.lang.String getLocationId()
         The canonical id for this location. For example: `"us-east1"`.
         
        string location_id = 4;
        Specified by:
        getLocationId in interface LocationOrBuilder
        Returns:
        The locationId.
      • getLocationIdBytes

        public com.google.protobuf.ByteString getLocationIdBytes()
         The canonical id for this location. For example: `"us-east1"`.
         
        string location_id = 4;
        Specified by:
        getLocationIdBytes in interface LocationOrBuilder
        Returns:
        The bytes for locationId.
      • getDisplayName

        public java.lang.String getDisplayName()
         The friendly name for this location, typically a nearby city name.
         For example, "Tokyo".
         
        string display_name = 5;
        Specified by:
        getDisplayName in interface LocationOrBuilder
        Returns:
        The displayName.
      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The friendly name for this location, typically a nearby city name.
         For example, "Tokyo".
         
        string display_name = 5;
        Specified by:
        getDisplayNameBytes in interface LocationOrBuilder
        Returns:
        The bytes for displayName.
      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: LocationOrBuilder
         Cross-service attributes for the location. For example
        
             {"cloud.googleapis.com/region": "us-east1"}
         
        map<string, string> labels = 2;
        Specified by:
        getLabelsCount in interface LocationOrBuilder
      • containsLabels

        public boolean containsLabels​(java.lang.String key)
         Cross-service attributes for the location. For example
        
             {"cloud.googleapis.com/region": "us-east1"}
         
        map<string, string> labels = 2;
        Specified by:
        containsLabels in interface LocationOrBuilder
      • getLabelsMap

        public java.util.Map<java.lang.String,​java.lang.String> getLabelsMap()
         Cross-service attributes for the location. For example
        
             {"cloud.googleapis.com/region": "us-east1"}
         
        map<string, string> labels = 2;
        Specified by:
        getLabelsMap in interface LocationOrBuilder
      • getLabelsOrDefault

        public java.lang.String getLabelsOrDefault​(java.lang.String key,
                                                   java.lang.String defaultValue)
         Cross-service attributes for the location. For example
        
             {"cloud.googleapis.com/region": "us-east1"}
         
        map<string, string> labels = 2;
        Specified by:
        getLabelsOrDefault in interface LocationOrBuilder
      • getLabelsOrThrow

        public java.lang.String getLabelsOrThrow​(java.lang.String key)
         Cross-service attributes for the location. For example
        
             {"cloud.googleapis.com/region": "us-east1"}
         
        map<string, string> labels = 2;
        Specified by:
        getLabelsOrThrow in interface LocationOrBuilder
      • hasMetadata

        public boolean hasMetadata()
         Service-specific metadata. For example the available capacity at the given
         location.
         
        .google.protobuf.Any metadata = 3;
        Specified by:
        hasMetadata in interface LocationOrBuilder
        Returns:
        Whether the metadata field is set.
      • getMetadata

        public com.google.protobuf.Any getMetadata()
         Service-specific metadata. For example the available capacity at the given
         location.
         
        .google.protobuf.Any metadata = 3;
        Specified by:
        getMetadata in interface LocationOrBuilder
        Returns:
        The metadata.
      • getMetadataOrBuilder

        public com.google.protobuf.AnyOrBuilder getMetadataOrBuilder()
         Service-specific metadata. For example the available capacity at the given
         location.
         
        .google.protobuf.Any metadata = 3;
        Specified by:
        getMetadataOrBuilder in interface LocationOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.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​(java.lang.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 Location parseFrom​(java.nio.ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Location parseFrom​(java.nio.ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Location parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static Location parseFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static Location parseFrom​(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static Location parseDelimitedFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static Location parseDelimitedFrom​(java.io.InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static Location parseFrom​(com.google.protobuf.CodedInputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static Location parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

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

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

        protected Location.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Location getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Location> parser()
      • getParserForType

        public com.google.protobuf.Parser<Location> 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 Location getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder