Class Location (2.9.1)

Stay organized with collections Save and categorize content based on your preferences.
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
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Location getDefaultInstance()
Returns
TypeDescription
Location

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Location.Builder newBuilder()
Returns
TypeDescription
Location.Builder

newBuilder(Location prototype)

public static Location.Builder newBuilder(Location prototype)
Parameter
NameDescription
prototypeLocation
Returns
TypeDescription
Location.Builder

parseDelimitedFrom(InputStream input)

public static Location parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Location
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Location parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Location
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Location parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Location
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Location parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Location
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Location parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Location
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Location parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Location
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Location parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Location
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Location parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Location
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Location parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Location
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Location parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Location
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Location parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Location
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Location parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Location
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Location> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Location getDefaultInstanceForType()
Returns
TypeDescription
Location

getDisplayName()

public String getDisplayName()

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

string display_name = 5;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for displayName.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getLocationId()

public String getLocationId()

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

string location_id = 4;

Returns
TypeDescription
String

The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

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

string location_id = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Location> getParserForType()
Returns
TypeDescription
Parser<Location>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasMetadata()

public boolean hasMetadata()

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

.google.protobuf.Any metadata = 3;

Returns
TypeDescription
boolean

Whether the metadata field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Location.Builder newBuilderForType()
Returns
TypeDescription
Location.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Location.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Location.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Location.Builder toBuilder()
Returns
TypeDescription
Location.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException