Package com.google.cloud.location

Interface LocationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Location, Location.Builder
public interface LocationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsLabels(String key)
    Cross-service attributes for the location.
    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.
    Map<String,String>
    getLabels()
    Deprecated.
    int
    getLabelsCount()
    Cross-service attributes for the location.
    Map<String,String>
    getLabelsMap()
    Cross-service attributes for the location.
    String
    getLabelsOrDefault(String key, String defaultValue)
    Cross-service attributes for the location.
    String
    getLabelsOrThrow(String key)
    Cross-service attributes for the location.
    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.
    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.
    boolean
    hasMetadata()
    Service-specific metadata.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

      String getName()
       Resource name for the location, which may vary between implementations.
 For example: `"projects/example-project/locations/us-east1"`
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • getLocationId

      String getLocationId()
       The canonical id for this location. For example: `"us-east1"`.
      string location_id = 4;
      Returns:
      The locationId.

    • getLocationIdBytes

      com.google.protobuf.ByteString getLocationIdBytes()
       The canonical id for this location. For example: `"us-east1"`.
      string location_id = 4;
      Returns:
      The bytes for locationId.

    • getDisplayName

      String getDisplayName()
       The friendly name for this location, typically a nearby city name.
 For example, "Tokyo".
      string display_name = 5;
      Returns:
      The displayName.

    • getDisplayNameBytes

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

    • getLabelsCount

      int getLabelsCount()
       Cross-service attributes for the location. For example

     {"cloud.googleapis.com/region": "us-east1"}
      map<string, string> labels = 2;

    • containsLabels

      boolean containsLabels(String key)
       Cross-service attributes for the location. For example

     {"cloud.googleapis.com/region": "us-east1"}
      map<string, string> labels = 2;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Cross-service attributes for the location. For example

     {"cloud.googleapis.com/region": "us-east1"}
      map<string, string> labels = 2;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Cross-service attributes for the location. For example

     {"cloud.googleapis.com/region": "us-east1"}
      map<string, string> labels = 2;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Cross-service attributes for the location. For example

     {"cloud.googleapis.com/region": "us-east1"}
      map<string, string> labels = 2;

    • hasMetadata

      boolean hasMetadata()
       Service-specific metadata. For example the available capacity at the given
 location.
      .google.protobuf.Any metadata = 3;
      Returns:
      Whether the metadata field is set.

    • getMetadata

      com.google.protobuf.Any getMetadata()
       Service-specific metadata. For example the available capacity at the given
 location.
      .google.protobuf.Any metadata = 3;
      Returns:
      The metadata.

    • getMetadataOrBuilder

      com.google.protobuf.AnyOrBuilder getMetadataOrBuilder()
       Service-specific metadata. For example the available capacity at the given
 location.
      .google.protobuf.Any metadata = 3;