public final class PolicyBasedRoute extends GeneratedMessageV3 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: 19
Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
INTERCONNECT_ATTACHMENT_FIELD_NUMBER
public static final int INTERCONNECT_ATTACHMENT_FIELD_NUMBER
Field Value
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
Field Value
NEXT_HOP_ILB_IP_FIELD_NUMBER
public static final int NEXT_HOP_ILB_IP_FIELD_NUMBER
Field Value
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
Field Value
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
VIRTUAL_MACHINE_FIELD_NUMBER
public static final int VIRTUAL_MACHINE_FIELD_NUMBER
Field Value
WARNINGS_FIELD_NUMBER
public static final int WARNINGS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PolicyBasedRoute getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PolicyBasedRoute.Builder newBuilder()
Returns
newBuilder(PolicyBasedRoute prototype)
public static PolicyBasedRoute.Builder newBuilder(PolicyBasedRoute prototype)
Parameter
Returns
public static PolicyBasedRoute parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PolicyBasedRoute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PolicyBasedRoute parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PolicyBasedRoute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PolicyBasedRoute parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PolicyBasedRoute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PolicyBasedRoute parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PolicyBasedRoute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PolicyBasedRoute parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PolicyBasedRoute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PolicyBasedRoute parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PolicyBasedRoute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PolicyBasedRoute> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
User-defined labels.
map<string, string> labels = 4;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. Time when the PolicyBasedRoute was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time when the PolicyBasedRoute was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public PolicyBasedRoute getDefaultInstanceForType()
Returns
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];
| 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];
| Type | Description |
| ByteString | The bytes for description.
|
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];
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];
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];
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];
getKind()
Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for
Policy Based Route resources.
string kind = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
User-defined labels.
map<string, string> labels = 4;
getLabelsMap()
public Map<String,String> getLabelsMap()
User-defined labels.
map<string, string> labels = 4;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
User-defined labels.
map<string, string> labels = 4;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
User-defined labels.
map<string, string> labels = 4;
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];
| 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];
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) = { ... }
| 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) = { ... }
getNextHopCase()
public PolicyBasedRoute.NextHopCase getNextHopCase()
Returns
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];
| 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];
| Type | Description |
| ByteString | The bytes for nextHopIlbIp.
|
getParserForType()
public Parser<PolicyBasedRoute> getParserForType()
Returns
Overrides
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 1000. The
priority value must be from 1 to 65535, inclusive.
int32 priority = 11 [(.google.api.field_behavior) = OPTIONAL];
| 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];
| 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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTargetCase()
public PolicyBasedRoute.TargetCase getTargetCase()
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Time when the PolicyBasedRoute was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time when the PolicyBasedRoute was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
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];
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];
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];
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];
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];
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];
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the nextHopIlbIp 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];
| 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];
| Type | Description |
| boolean | Whether the virtualMachine field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PolicyBasedRoute.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PolicyBasedRoute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PolicyBasedRoute.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
