Class GatewayAdvertisedRoute.Builder (1.87.0)

public static final class GatewayAdvertisedRoute.Builder extends GeneratedMessage.Builder<GatewayAdvertisedRoute.Builder> implements GatewayAdvertisedRouteOrBuilder

A gateway advertised route is a route that a gateway spoke advertises somewhere.

Protobuf type google.cloud.networkconnectivity.v1beta.GatewayAdvertisedRoute

Static Methods

getDescriptor()

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

Methods

build()

public GatewayAdvertisedRoute build()
Returns
Type Description
GatewayAdvertisedRoute

buildPartial()

public GatewayAdvertisedRoute buildPartial()
Returns
Type Description
GatewayAdvertisedRoute

clear()

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

clearCreateTime()

public GatewayAdvertisedRoute.Builder clearCreateTime()

Output only. The time the gateway advertised route was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
GatewayAdvertisedRoute.Builder

clearDescription()

public GatewayAdvertisedRoute.Builder clearDescription()

An optional description of the gateway advertised route.

string description = 5;

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

clearIpRange()

public GatewayAdvertisedRoute.Builder clearIpRange()

Immutable. This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128.

string ip_range = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

clearLabels()

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

clearName()

public GatewayAdvertisedRoute.Builder clearName()

Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

clearPriority()

public GatewayAdvertisedRoute.Builder clearPriority()

Optional. The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.

optional int32 priority = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

clearRecipient()

public GatewayAdvertisedRoute.Builder clearRecipient()

Optional. The recipient of this advertised route.

.google.cloud.networkconnectivity.v1beta.GatewayAdvertisedRoute.Recipient recipient = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

clearState()

public GatewayAdvertisedRoute.Builder clearState()

Output only. The current lifecycle state of this gateway advertised route.

.google.cloud.networkconnectivity.v1beta.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

clearUniqueId()

public GatewayAdvertisedRoute.Builder clearUniqueId()

Output only. The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different unique_id.

string unique_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

clearUpdateTime()

public GatewayAdvertisedRoute.Builder clearUpdateTime()

Output only. The time the gateway advertised route was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
GatewayAdvertisedRoute.Builder

containsLabels(String key)

public boolean containsLabels(String key)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the gateway advertised route was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time the gateway advertised route was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the gateway advertised route was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public GatewayAdvertisedRoute getDefaultInstanceForType()
Returns
Type Description
GatewayAdvertisedRoute

getDescription()

public String getDescription()

An optional description of the gateway advertised route.

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of the gateway advertised route.

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getIpRange()

public String getIpRange()

Immutable. This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128.

string ip_range = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The ipRange.

getIpRangeBytes()

public ByteString getIpRangeBytes()

Immutable. This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128.

string ip_range = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for ipRange.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPriority()

public int getPriority()

Optional. The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.

optional int32 priority = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The priority.

getRecipient()

public GatewayAdvertisedRoute.Recipient getRecipient()

Optional. The recipient of this advertised route.

.google.cloud.networkconnectivity.v1beta.GatewayAdvertisedRoute.Recipient recipient = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GatewayAdvertisedRoute.Recipient

The recipient.

getRecipientValue()

public int getRecipientValue()

Optional. The recipient of this advertised route.

.google.cloud.networkconnectivity.v1beta.GatewayAdvertisedRoute.Recipient recipient = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for recipient.

getState()

public State getState()

Output only. The current lifecycle state of this gateway advertised route.

.google.cloud.networkconnectivity.v1beta.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
State

The state.

getStateValue()

public int getStateValue()

Output only. The current lifecycle state of this gateway advertised route.

.google.cloud.networkconnectivity.v1beta.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUniqueId()

public String getUniqueId()

Output only. The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different unique_id.

string unique_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uniqueId.

getUniqueIdBytes()

public ByteString getUniqueIdBytes()

Output only. The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different unique_id.

string unique_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uniqueId.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the gateway advertised route was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time the gateway advertised route was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the gateway advertised route was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time the gateway advertised route was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasPriority()

public boolean hasPriority()

Optional. The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.

optional int32 priority = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the priority field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the gateway advertised route was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public GatewayAdvertisedRoute.Builder mergeCreateTime(Timestamp value)

Output only. The time the gateway advertised route was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
GatewayAdvertisedRoute.Builder

mergeFrom(GatewayAdvertisedRoute other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUpdateTime(Timestamp value)

public GatewayAdvertisedRoute.Builder mergeUpdateTime(Timestamp value)

Output only. The time the gateway advertised route was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
GatewayAdvertisedRoute.Builder

putAllLabels(Map<String,String> values)

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

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 4;

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

putLabels(String key, String value)

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

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 4;

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

removeLabels(String key)

public GatewayAdvertisedRoute.Builder removeLabels(String key)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
GatewayAdvertisedRoute.Builder

setCreateTime(Timestamp value)

public GatewayAdvertisedRoute.Builder setCreateTime(Timestamp value)

Output only. The time the gateway advertised route was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
GatewayAdvertisedRoute.Builder

setCreateTime(Timestamp.Builder builderForValue)

public GatewayAdvertisedRoute.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time the gateway advertised route was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
GatewayAdvertisedRoute.Builder

setDescription(String value)

public GatewayAdvertisedRoute.Builder setDescription(String value)

An optional description of the gateway advertised route.

string description = 5;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public GatewayAdvertisedRoute.Builder setDescriptionBytes(ByteString value)

An optional description of the gateway advertised route.

string description = 5;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setIpRange(String value)

public GatewayAdvertisedRoute.Builder setIpRange(String value)

Immutable. This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128.

string ip_range = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The ipRange to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setIpRangeBytes(ByteString value)

public GatewayAdvertisedRoute.Builder setIpRangeBytes(ByteString value)

Immutable. This route's advertised IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a /32 singular IP address range, and, for IPv6, /128.

string ip_range = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for ipRange to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setName(String value)

public GatewayAdvertisedRoute.Builder setName(String value)

Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GatewayAdvertisedRoute.Builder setNameBytes(ByteString value)

Identifier. The name of the gateway advertised route. Route names must be unique and use the following form: projects/{project_number}/locations/{region}/spokes/{spoke}/gatewayAdvertisedRoutes/{gateway_advertised_route_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setPriority(int value)

public GatewayAdvertisedRoute.Builder setPriority(int value)

Optional. The priority of this advertised route. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges.

optional int32 priority = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The priority to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setRecipient(GatewayAdvertisedRoute.Recipient value)

public GatewayAdvertisedRoute.Builder setRecipient(GatewayAdvertisedRoute.Recipient value)

Optional. The recipient of this advertised route.

.google.cloud.networkconnectivity.v1beta.GatewayAdvertisedRoute.Recipient recipient = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value GatewayAdvertisedRoute.Recipient

The recipient to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setRecipientValue(int value)

public GatewayAdvertisedRoute.Builder setRecipientValue(int value)

Optional. The recipient of this advertised route.

.google.cloud.networkconnectivity.v1beta.GatewayAdvertisedRoute.Recipient recipient = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for recipient to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setState(State value)

public GatewayAdvertisedRoute.Builder setState(State value)

Output only. The current lifecycle state of this gateway advertised route.

.google.cloud.networkconnectivity.v1beta.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value State

The state to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setStateValue(int value)

public GatewayAdvertisedRoute.Builder setStateValue(int value)

Output only. The current lifecycle state of this gateway advertised route.

.google.cloud.networkconnectivity.v1beta.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setUniqueId(String value)

public GatewayAdvertisedRoute.Builder setUniqueId(String value)

Output only. The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different unique_id.

string unique_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The uniqueId to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setUniqueIdBytes(ByteString value)

public GatewayAdvertisedRoute.Builder setUniqueIdBytes(ByteString value)

Output only. The Google-generated UUID for the gateway advertised route. This value is unique across all gateway advertised route resources. If a gateway advertised route is deleted and another with the same name is created, the new route is assigned a different unique_id.

string unique_id = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for uniqueId to set.

Returns
Type Description
GatewayAdvertisedRoute.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public GatewayAdvertisedRoute.Builder setUpdateTime(Timestamp value)

Output only. The time the gateway advertised route was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
GatewayAdvertisedRoute.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public GatewayAdvertisedRoute.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time the gateway advertised route was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
GatewayAdvertisedRoute.Builder