Class PolicyBasedRoute.Builder (1.52.0) 

public static final class PolicyBasedRoute.Builder extends GeneratedMessageV3.Builder<PolicyBasedRoute.Builder> implements PolicyBasedRouteOrBuilder

Policy Based Routes (PBR) are more powerful routes that allows GCP customers to route their L4 network traffic based on not just destination IP, but also source IP, protocol and more. A PBR always take precedence when it conflicts with other types of routes. Next id: 22

Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PolicyBasedRoute.Builder

Static Methods

getDescriptor()

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

Methods

addAllWarnings(Iterable<? extends PolicyBasedRoute.Warnings> values)

public PolicyBasedRoute.Builder addAllWarnings(Iterable<? extends PolicyBasedRoute.Warnings> values)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings>
Returns
Type Description
PolicyBasedRoute.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addWarnings(PolicyBasedRoute.Warnings value)

public PolicyBasedRoute.Builder addWarnings(PolicyBasedRoute.Warnings value)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value PolicyBasedRoute.Warnings
Returns
Type Description
PolicyBasedRoute.Builder

addWarnings(PolicyBasedRoute.Warnings.Builder builderForValue)

public PolicyBasedRoute.Builder addWarnings(PolicyBasedRoute.Warnings.Builder builderForValue)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue PolicyBasedRoute.Warnings.Builder
Returns
Type Description
PolicyBasedRoute.Builder

addWarnings(int index, PolicyBasedRoute.Warnings value)

public PolicyBasedRoute.Builder addWarnings(int index, PolicyBasedRoute.Warnings value)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value PolicyBasedRoute.Warnings
Returns
Type Description
PolicyBasedRoute.Builder

addWarnings(int index, PolicyBasedRoute.Warnings.Builder builderForValue)

public PolicyBasedRoute.Builder addWarnings(int index, PolicyBasedRoute.Warnings.Builder builderForValue)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue PolicyBasedRoute.Warnings.Builder
Returns
Type Description
PolicyBasedRoute.Builder

addWarningsBuilder()

public PolicyBasedRoute.Warnings.Builder addWarningsBuilder()

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PolicyBasedRoute.Warnings.Builder

addWarningsBuilder(int index)

public PolicyBasedRoute.Warnings.Builder addWarningsBuilder(int index)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PolicyBasedRoute.Warnings.Builder

build()

public PolicyBasedRoute build()
Returns
Type Description
PolicyBasedRoute

buildPartial()

public PolicyBasedRoute buildPartial()
Returns
Type Description
PolicyBasedRoute

clear()

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

clearCreateTime()

public PolicyBasedRoute.Builder clearCreateTime()

Output only. Time when the PolicyBasedRoute was created.

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

Returns
Type Description
PolicyBasedRoute.Builder

clearDescription()

public PolicyBasedRoute.Builder clearDescription()

Optional. An optional description of this resource. Provide this field when you create the resource.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public PolicyBasedRoute.Builder clearFilter()

Required. The filter to match L4 traffic.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter filter = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PolicyBasedRoute.Builder

clearInterconnectAttachment()

public PolicyBasedRoute.Builder clearInterconnectAttachment()

Optional. The interconnect attachments to which this route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.InterconnectAttachment interconnect_attachment = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.Builder

clearKind()

public PolicyBasedRoute.Builder clearKind()

Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources.

string kind = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

clearLabels()

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

clearName()

public PolicyBasedRoute.Builder clearName()

Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}

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

Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

clearNetwork()

public PolicyBasedRoute.Builder clearNetwork()

Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network.

string network = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

clearNextHop()

public PolicyBasedRoute.Builder clearNextHop()
Returns
Type Description
PolicyBasedRoute.Builder

clearNextHopIlbIp()

public PolicyBasedRoute.Builder clearNextHopIlbIp()

Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported.

string next_hop_ilb_ip = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

clearNextHopOtherRoutes()

public PolicyBasedRoute.Builder clearNextHopOtherRoutes()

Optional. Other routes that will be referenced to determine the next hop of the packet.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.OtherRoutes next_hop_other_routes = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPriority()

public PolicyBasedRoute.Builder clearPriority()

Optional. The priority of this policy based route. Priority is used to break ties in cases where there are more than one matching policy based routes found. In cases where multiple policy based routes are matched, the one with the lowest-numbered priority value wins. The default value is

  1. The priority value must be from 1 to 65535, inclusive.

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

Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

clearSelfLink()

public PolicyBasedRoute.Builder clearSelfLink()

Output only. Server-defined fully-qualified URL for this resource.

string self_link = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

clearTarget()

public PolicyBasedRoute.Builder clearTarget()
Returns
Type Description
PolicyBasedRoute.Builder

clearUpdateTime()

public PolicyBasedRoute.Builder clearUpdateTime()

Output only. Time when the PolicyBasedRoute was updated.

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

Returns
Type Description
PolicyBasedRoute.Builder

clearVirtualMachine()

public PolicyBasedRoute.Builder clearVirtualMachine()

Optional. VM instances to which this policy based route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.VirtualMachine virtual_machine = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.Builder

clearWarnings()

public PolicyBasedRoute.Builder clearWarnings()

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PolicyBasedRoute.Builder

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

User-defined labels.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when the PolicyBasedRoute 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. Time when the PolicyBasedRoute was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when the PolicyBasedRoute was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public PolicyBasedRoute getDefaultInstanceForType()
Returns
Type Description
PolicyBasedRoute

getDescription()

public String getDescription()

Optional. An optional description of this resource. Provide this field when you create the resource.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. An optional description of this resource. Provide this field when you create the resource.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getFilter()

public PolicyBasedRoute.Filter getFilter()

Required. The filter to match L4 traffic.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter filter = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PolicyBasedRoute.Filter

The filter.

getFilterBuilder()

public PolicyBasedRoute.Filter.Builder getFilterBuilder()

Required. The filter to match L4 traffic.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter filter = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PolicyBasedRoute.Filter.Builder

getFilterOrBuilder()

public PolicyBasedRoute.FilterOrBuilder getFilterOrBuilder()

Required. The filter to match L4 traffic.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter filter = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PolicyBasedRoute.FilterOrBuilder

getInterconnectAttachment()

public PolicyBasedRoute.InterconnectAttachment getInterconnectAttachment()

Optional. The interconnect attachments to which this route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.InterconnectAttachment interconnect_attachment = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.InterconnectAttachment

The interconnectAttachment.

getInterconnectAttachmentBuilder()

public PolicyBasedRoute.InterconnectAttachment.Builder getInterconnectAttachmentBuilder()

Optional. The interconnect attachments to which this route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.InterconnectAttachment interconnect_attachment = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.InterconnectAttachment.Builder

getInterconnectAttachmentOrBuilder()

public PolicyBasedRoute.InterconnectAttachmentOrBuilder getInterconnectAttachmentOrBuilder()

Optional. The interconnect attachments to which this route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.InterconnectAttachment interconnect_attachment = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.InterconnectAttachmentOrBuilder

getKind()

public String getKind()

Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources.

string kind = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources.

string kind = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for kind.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

User-defined labels.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

User-defined labels.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

User-defined 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)

User-defined 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()

Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}

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

Returns
Type Description
ByteString

The bytes for name.

getNetwork()

public String getNetwork()

Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network.

string network = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network.

string network = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for network.

getNextHopCase()

public PolicyBasedRoute.NextHopCase getNextHopCase()
Returns
Type Description
PolicyBasedRoute.NextHopCase

getNextHopIlbIp()

public String getNextHopIlbIp()

Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported.

string next_hop_ilb_ip = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The nextHopIlbIp.

getNextHopIlbIpBytes()

public ByteString getNextHopIlbIpBytes()

Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported.

string next_hop_ilb_ip = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for nextHopIlbIp.

getNextHopOtherRoutes()

public PolicyBasedRoute.OtherRoutes getNextHopOtherRoutes()

Optional. Other routes that will be referenced to determine the next hop of the packet.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.OtherRoutes next_hop_other_routes = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.OtherRoutes

The nextHopOtherRoutes.

getNextHopOtherRoutesValue()

public int getNextHopOtherRoutesValue()

Optional. Other routes that will be referenced to determine the next hop of the packet.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.OtherRoutes next_hop_other_routes = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for nextHopOtherRoutes.

getPriority()

public int getPriority()

Optional. The priority of this policy based route. Priority is used to break ties in cases where there are more than one matching policy based routes found. In cases where multiple policy based routes are matched, the one with the lowest-numbered priority value wins. The default value is

  1. The priority value must be from 1 to 65535, inclusive.

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

Returns
Type Description
int

The priority.

getSelfLink()

public String getSelfLink()

Output only. Server-defined fully-qualified URL for this resource.

string self_link = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

Output only. Server-defined fully-qualified URL for this resource.

string self_link = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for selfLink.

getTargetCase()

public PolicyBasedRoute.TargetCase getTargetCase()
Returns
Type Description
PolicyBasedRoute.TargetCase

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time when the PolicyBasedRoute was 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. Time when the PolicyBasedRoute was updated.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when the PolicyBasedRoute was updated.

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

Returns
Type Description
TimestampOrBuilder

getVirtualMachine()

public PolicyBasedRoute.VirtualMachine getVirtualMachine()

Optional. VM instances to which this policy based route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.VirtualMachine virtual_machine = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.VirtualMachine

The virtualMachine.

getVirtualMachineBuilder()

public PolicyBasedRoute.VirtualMachine.Builder getVirtualMachineBuilder()

Optional. VM instances to which this policy based route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.VirtualMachine virtual_machine = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.VirtualMachine.Builder

getVirtualMachineOrBuilder()

public PolicyBasedRoute.VirtualMachineOrBuilder getVirtualMachineOrBuilder()

Optional. VM instances to which this policy based route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.VirtualMachine virtual_machine = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyBasedRoute.VirtualMachineOrBuilder

getWarnings(int index)

public PolicyBasedRoute.Warnings getWarnings(int index)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PolicyBasedRoute.Warnings

getWarningsBuilder(int index)

public PolicyBasedRoute.Warnings.Builder getWarningsBuilder(int index)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PolicyBasedRoute.Warnings.Builder

getWarningsBuilderList()

public List<PolicyBasedRoute.Warnings.Builder> getWarningsBuilderList()

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getWarningsCount()

public int getWarningsCount()

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getWarningsList()

public List<PolicyBasedRoute.Warnings> getWarningsList()

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Warnings>

getWarningsOrBuilder(int index)

public PolicyBasedRoute.WarningsOrBuilder getWarningsOrBuilder(int index)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PolicyBasedRoute.WarningsOrBuilder

getWarningsOrBuilderList()

public List<? extends PolicyBasedRoute.WarningsOrBuilder> getWarningsOrBuilderList()

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.networkconnectivity.v1.PolicyBasedRoute.WarningsOrBuilder>

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when the PolicyBasedRoute was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasFilter()

public boolean hasFilter()

Required. The filter to match L4 traffic.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter filter = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the filter field is set.

hasInterconnectAttachment()

public boolean hasInterconnectAttachment()

Optional. The interconnect attachments to which this route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.InterconnectAttachment interconnect_attachment = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the interconnectAttachment field is set.

hasNextHopIlbIp()

public boolean hasNextHopIlbIp()

Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported.

string next_hop_ilb_ip = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the nextHopIlbIp field is set.

hasNextHopOtherRoutes()

public boolean hasNextHopOtherRoutes()

Optional. Other routes that will be referenced to determine the next hop of the packet.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.OtherRoutes next_hop_other_routes = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the nextHopOtherRoutes field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time when the PolicyBasedRoute was updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hasVirtualMachine()

public boolean hasVirtualMachine()

Optional. VM instances to which this policy based route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.VirtualMachine virtual_machine = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the virtualMachine 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

mergeCreateTime(Timestamp value)

public PolicyBasedRoute.Builder mergeCreateTime(Timestamp value)

Output only. Time when the PolicyBasedRoute was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PolicyBasedRoute.Builder

mergeFilter(PolicyBasedRoute.Filter value)

public PolicyBasedRoute.Builder mergeFilter(PolicyBasedRoute.Filter value)

Required. The filter to match L4 traffic.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter filter = 10 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value PolicyBasedRoute.Filter
Returns
Type Description
PolicyBasedRoute.Builder

mergeFrom(PolicyBasedRoute other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeInterconnectAttachment(PolicyBasedRoute.InterconnectAttachment value)

public PolicyBasedRoute.Builder mergeInterconnectAttachment(PolicyBasedRoute.InterconnectAttachment value)

Optional. The interconnect attachments to which this route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.InterconnectAttachment interconnect_attachment = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PolicyBasedRoute.InterconnectAttachment
Returns
Type Description
PolicyBasedRoute.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public PolicyBasedRoute.Builder mergeUpdateTime(Timestamp value)

Output only. Time when the PolicyBasedRoute was updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PolicyBasedRoute.Builder

mergeVirtualMachine(PolicyBasedRoute.VirtualMachine value)

public PolicyBasedRoute.Builder mergeVirtualMachine(PolicyBasedRoute.VirtualMachine value)

Optional. VM instances to which this policy based route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.VirtualMachine virtual_machine = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PolicyBasedRoute.VirtualMachine
Returns
Type Description
PolicyBasedRoute.Builder

putAllLabels(Map<String,String> values)

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

User-defined labels.

map<string, string> labels = 4;

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

putLabels(String key, String value)

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

User-defined labels.

map<string, string> labels = 4;

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

removeLabels(String key)

public PolicyBasedRoute.Builder removeLabels(String key)

User-defined labels.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
PolicyBasedRoute.Builder

removeWarnings(int index)

public PolicyBasedRoute.Builder removeWarnings(int index)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
PolicyBasedRoute.Builder

setCreateTime(Timestamp value)

public PolicyBasedRoute.Builder setCreateTime(Timestamp value)

Output only. Time when the PolicyBasedRoute was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PolicyBasedRoute.Builder

setCreateTime(Timestamp.Builder builderForValue)

public PolicyBasedRoute.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when the PolicyBasedRoute was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PolicyBasedRoute.Builder

setDescription(String value)

public PolicyBasedRoute.Builder setDescription(String value)

Optional. An optional description of this resource. Provide this field when you create the resource.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public PolicyBasedRoute.Builder setDescriptionBytes(ByteString value)

Optional. An optional description of this resource. Provide this field when you create the resource.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(PolicyBasedRoute.Filter value)

public PolicyBasedRoute.Builder setFilter(PolicyBasedRoute.Filter value)

Required. The filter to match L4 traffic.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter filter = 10 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value PolicyBasedRoute.Filter
Returns
Type Description
PolicyBasedRoute.Builder

setFilter(PolicyBasedRoute.Filter.Builder builderForValue)

public PolicyBasedRoute.Builder setFilter(PolicyBasedRoute.Filter.Builder builderForValue)

Required. The filter to match L4 traffic.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.Filter filter = 10 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue PolicyBasedRoute.Filter.Builder
Returns
Type Description
PolicyBasedRoute.Builder

setInterconnectAttachment(PolicyBasedRoute.InterconnectAttachment value)

public PolicyBasedRoute.Builder setInterconnectAttachment(PolicyBasedRoute.InterconnectAttachment value)

Optional. The interconnect attachments to which this route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.InterconnectAttachment interconnect_attachment = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PolicyBasedRoute.InterconnectAttachment
Returns
Type Description
PolicyBasedRoute.Builder

setInterconnectAttachment(PolicyBasedRoute.InterconnectAttachment.Builder builderForValue)

public PolicyBasedRoute.Builder setInterconnectAttachment(PolicyBasedRoute.InterconnectAttachment.Builder builderForValue)

Optional. The interconnect attachments to which this route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.InterconnectAttachment interconnect_attachment = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue PolicyBasedRoute.InterconnectAttachment.Builder
Returns
Type Description
PolicyBasedRoute.Builder

setKind(String value)

public PolicyBasedRoute.Builder setKind(String value)

Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources.

string kind = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setKindBytes(ByteString value)

public PolicyBasedRoute.Builder setKindBytes(ByteString value)

Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources.

string kind = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setName(String value)

public PolicyBasedRoute.Builder setName(String value)

Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setNameBytes(ByteString value)

public PolicyBasedRoute.Builder setNameBytes(ByteString value)

Immutable. A unique name of the resource in the form of projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setNetwork(String value)

public PolicyBasedRoute.Builder setNetwork(String value)

Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network.

string network = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The network to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setNetworkBytes(ByteString value)

public PolicyBasedRoute.Builder setNetworkBytes(ByteString value)

Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network.

string network = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for network to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setNextHopIlbIp(String value)

public PolicyBasedRoute.Builder setNextHopIlbIp(String value)

Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported.

string next_hop_ilb_ip = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The nextHopIlbIp to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setNextHopIlbIpBytes(ByteString value)

public PolicyBasedRoute.Builder setNextHopIlbIpBytes(ByteString value)

Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported.

string next_hop_ilb_ip = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for nextHopIlbIp to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setNextHopOtherRoutes(PolicyBasedRoute.OtherRoutes value)

public PolicyBasedRoute.Builder setNextHopOtherRoutes(PolicyBasedRoute.OtherRoutes value)

Optional. Other routes that will be referenced to determine the next hop of the packet.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.OtherRoutes next_hop_other_routes = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PolicyBasedRoute.OtherRoutes

The nextHopOtherRoutes to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setNextHopOtherRoutesValue(int value)

public PolicyBasedRoute.Builder setNextHopOtherRoutesValue(int value)

Optional. Other routes that will be referenced to determine the next hop of the packet.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.OtherRoutes next_hop_other_routes = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for nextHopOtherRoutes to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setPriority(int value)

public PolicyBasedRoute.Builder setPriority(int value)

Optional. The priority of this policy based route. Priority is used to break ties in cases where there are more than one matching policy based routes found. In cases where multiple policy based routes are matched, the one with the lowest-numbered priority value wins. The default value is

  1. The priority value must be from 1 to 65535, inclusive.

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

Parameter
Name Description
value int

The priority to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

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

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

setSelfLink(String value)

public PolicyBasedRoute.Builder setSelfLink(String value)

Output only. Server-defined fully-qualified URL for this resource.

string self_link = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public PolicyBasedRoute.Builder setSelfLinkBytes(ByteString value)

Output only. Server-defined fully-qualified URL for this resource.

string self_link = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
PolicyBasedRoute.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public PolicyBasedRoute.Builder setUpdateTime(Timestamp value)

Output only. Time when the PolicyBasedRoute was updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
PolicyBasedRoute.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public PolicyBasedRoute.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Time when the PolicyBasedRoute was updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PolicyBasedRoute.Builder

setVirtualMachine(PolicyBasedRoute.VirtualMachine value)

public PolicyBasedRoute.Builder setVirtualMachine(PolicyBasedRoute.VirtualMachine value)

Optional. VM instances to which this policy based route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.VirtualMachine virtual_machine = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PolicyBasedRoute.VirtualMachine
Returns
Type Description
PolicyBasedRoute.Builder

setVirtualMachine(PolicyBasedRoute.VirtualMachine.Builder builderForValue)

public PolicyBasedRoute.Builder setVirtualMachine(PolicyBasedRoute.VirtualMachine.Builder builderForValue)

Optional. VM instances to which this policy based route applies to.

.google.cloud.networkconnectivity.v1.PolicyBasedRoute.VirtualMachine virtual_machine = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue PolicyBasedRoute.VirtualMachine.Builder
Returns
Type Description
PolicyBasedRoute.Builder

setWarnings(int index, PolicyBasedRoute.Warnings value)

public PolicyBasedRoute.Builder setWarnings(int index, PolicyBasedRoute.Warnings value)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value PolicyBasedRoute.Warnings
Returns
Type Description
PolicyBasedRoute.Builder

setWarnings(int index, PolicyBasedRoute.Warnings.Builder builderForValue)

public PolicyBasedRoute.Builder setWarnings(int index, PolicyBasedRoute.Warnings.Builder builderForValue)

Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.

repeated .google.cloud.networkconnectivity.v1.PolicyBasedRoute.Warnings warnings = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue PolicyBasedRoute.Warnings.Builder
Returns
Type Description
PolicyBasedRoute.Builder