Class Location (2.40.0)

public final class Location extends GeneratedMessageV3 implements LocationOrBuilder

A resource that represents Google Cloud Platform location.

Protobuf type google.cloud.location.Location

Implements

LocationOrBuilder

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Location getDefaultInstance()
Returns
Type Description
Location

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Location.Builder newBuilder()
Returns
Type Description
Location.Builder

newBuilder(Location prototype)

public static Location.Builder newBuilder(Location prototype)
Parameter
Name Description
prototype Location
Returns
Type Description
Location.Builder

parseDelimitedFrom(InputStream input)

public static Location parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Location
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Location parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Location
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Location parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Location
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Location parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Location
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Location parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Location
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Location parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Location
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Location parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Location
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Location parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Location
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Location parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Location
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Location parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Location
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Location parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Location
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Location parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Location
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Location> parser()
Returns
Type Description
Parser<Location>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Cross-service attributes for the location. For example

 {"cloud.googleapis.com/region": "us-east1"}

map<string, string> labels = 2;

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

getDefaultInstanceForType()

public Location getDefaultInstanceForType()
Returns
Type Description
Location

getDisplayName()

public String getDisplayName()

The friendly name for this location, typically a nearby city name. For example, "Tokyo".

string display_name = 5;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The friendly name for this location, typically a nearby city name. For example, "Tokyo".

string display_name = 5;

Returns
Type Description
ByteString

The bytes for displayName.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Cross-service attributes for the location. For example

 {"cloud.googleapis.com/region": "us-east1"}

map<string, string> labels = 2;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Cross-service attributes for the location. For example

 {"cloud.googleapis.com/region": "us-east1"}

map<string, string> labels = 2;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public 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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Cross-service attributes for the location. For example

 {"cloud.googleapis.com/region": "us-east1"}

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getLocationId()

public String getLocationId()

The canonical id for this location. For example: "us-east1".

string location_id = 4;

Returns
Type Description
String

The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

The canonical id for this location. For example: "us-east1".

string location_id = 4;

Returns
Type Description
ByteString

The bytes for locationId.

getMetadata()

public Any getMetadata()

Service-specific metadata. For example the available capacity at the given location.

.google.protobuf.Any metadata = 3;

Returns
Type Description
Any

The metadata.

getMetadataOrBuilder()

public AnyOrBuilder getMetadataOrBuilder()

Service-specific metadata. For example the available capacity at the given location.

.google.protobuf.Any metadata = 3;

Returns
Type Description
AnyOrBuilder

getName()

public String getName()

Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Location> getParserForType()
Returns
Type Description
Parser<Location>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMetadata()

public boolean hasMetadata()

Service-specific metadata. For example the available capacity at the given location.

.google.protobuf.Any metadata = 3;

Returns
Type Description
boolean

Whether the metadata field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Location.Builder newBuilderForType()
Returns
Type Description
Location.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Location.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Location.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Location.Builder toBuilder()
Returns
Type Description
Location.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException