Class Location.Builder (2.43.0)

public static final class Location.Builder extends GeneratedMessageV3.Builder<Location.Builder> implements LocationOrBuilder

A resource that represents Google Cloud Platform location.

Protobuf type google.cloud.location.Location

Implements

LocationOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Location.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Location.Builder
Overrides

build()

public Location build()
Returns
Type Description
Location

buildPartial()

public Location buildPartial()
Returns
Type Description
Location

clear()

public Location.Builder clear()
Returns
Type Description
Location.Builder
Overrides

clearDisplayName()

public Location.Builder clearDisplayName()

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

string display_name = 5;

Returns
Type Description
Location.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Location.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Location.Builder
Overrides

clearLabels()

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

clearLocationId()

public Location.Builder clearLocationId()

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

string location_id = 4;

Returns
Type Description
Location.Builder

This builder for chaining.

clearMetadata()

public Location.Builder clearMetadata()

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

.google.protobuf.Any metadata = 3;

Returns
Type Description
Location.Builder

clearName()

public Location.Builder clearName()

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

string name = 1;

Returns
Type Description
Location.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Location.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Location.Builder
Overrides

clone()

public Location.Builder clone()
Returns
Type Description
Location.Builder
Overrides

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

getDefaultInstanceForType()

public Location getDefaultInstanceForType()
Returns
Type Description
Location

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getMetadataBuilder()

public Any.Builder getMetadataBuilder()

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

.google.protobuf.Any metadata = 3;

Returns
Type Description
Builder

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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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.

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Location other)

public Location.Builder mergeFrom(Location other)
Parameter
Name Description
other Location
Returns
Type Description
Location.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Location.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Location.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Location.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Location.Builder
Overrides

mergeMetadata(Any value)

public Location.Builder mergeMetadata(Any value)

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

.google.protobuf.Any metadata = 3;

Parameter
Name Description
value Any
Returns
Type Description
Location.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Location.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Location.Builder
Overrides

putAllLabels(Map<String,String> values)

public Location.Builder putAllLabels(Map<String,String> values)

Cross-service attributes for the location. For example

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

map<string, string> labels = 2;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Location.Builder

putLabels(String key, String value)

public Location.Builder putLabels(String key, String value)

Cross-service attributes for the location. For example

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

map<string, string> labels = 2;

Parameters
Name Description
key String
value String
Returns
Type Description
Location.Builder

removeLabels(String key)

public Location.Builder removeLabels(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
Location.Builder

setDisplayName(String value)

public Location.Builder setDisplayName(String value)

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

string display_name = 5;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Location.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Location.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 5;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Location.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Location.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Location.Builder
Overrides

setLocationId(String value)

public Location.Builder setLocationId(String value)

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

string location_id = 4;

Parameter
Name Description
value String

The locationId to set.

Returns
Type Description
Location.Builder

This builder for chaining.

setLocationIdBytes(ByteString value)

public Location.Builder setLocationIdBytes(ByteString value)

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

string location_id = 4;

Parameter
Name Description
value ByteString

The bytes for locationId to set.

Returns
Type Description
Location.Builder

This builder for chaining.

setMetadata(Any value)

public Location.Builder setMetadata(Any value)

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

.google.protobuf.Any metadata = 3;

Parameter
Name Description
value Any
Returns
Type Description
Location.Builder

setMetadata(Any.Builder builderForValue)

public Location.Builder setMetadata(Any.Builder builderForValue)

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

.google.protobuf.Any metadata = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Location.Builder

setName(String value)

public Location.Builder setName(String value)

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

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Location.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Location.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Location.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Location.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Location.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Location.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Location.Builder
Overrides