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: 22
Protobuf type google.cloud.networkconnectivity.v1.PolicyBasedRoute
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INTERCONNECT_ATTACHMENT_FIELD_NUMBER
public static final int INTERCONNECT_ATTACHMENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NEXT_HOP_ILB_IP_FIELD_NUMBER
public static final int NEXT_HOP_ILB_IP_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NEXT_HOP_OTHER_ROUTES_FIELD_NUMBER
public static final int NEXT_HOP_OTHER_ROUTES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VIRTUAL_MACHINE_FIELD_NUMBER
public static final int VIRTUAL_MACHINE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
WARNINGS_FIELD_NUMBER
public static final int WARNINGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static PolicyBasedRoute getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PolicyBasedRoute.Builder newBuilder()
newBuilder(PolicyBasedRoute prototype)
public static PolicyBasedRoute.Builder newBuilder(PolicyBasedRoute prototype)
public static PolicyBasedRoute parseDelimitedFrom(InputStream input)
public static PolicyBasedRoute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PolicyBasedRoute parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PolicyBasedRoute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PolicyBasedRoute parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PolicyBasedRoute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PolicyBasedRoute parseFrom(CodedInputStream input)
public static PolicyBasedRoute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PolicyBasedRoute parseFrom(InputStream input)
public static PolicyBasedRoute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PolicyBasedRoute parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PolicyBasedRoute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PolicyBasedRoute> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
User-defined labels.
map<string, string> labels = 4;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
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()
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.
|
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];
| 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()
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;
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;
| Parameter |
|---|
| Name | Description |
key | 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()
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];
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.
|
getParserForType()
public Parser<PolicyBasedRoute> getParserForType()
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
- 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getTargetCase()
public PolicyBasedRoute.TargetCase getTargetCase()
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.
|
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
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
|
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PolicyBasedRoute.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PolicyBasedRoute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public PolicyBasedRoute.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
