Class TcpRoute (0.15.0)

public final class TcpRoute extends GeneratedMessageV3 implements TcpRouteOrBuilder

TcpRoute is the resource defining how TCP traffic should be routed by a Mesh/Gateway resource.

Protobuf type google.events.cloud.networkservices.v1.TcpRoute

Implements

TcpRouteOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

GATEWAYS_FIELD_NUMBER

public static final int GATEWAYS_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MESHES_FIELD_NUMBER

public static final int MESHES_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TcpRoute getDefaultInstance()
Returns
TypeDescription
TcpRoute

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TcpRoute.Builder newBuilder()
Returns
TypeDescription
TcpRoute.Builder

newBuilder(TcpRoute prototype)

public static TcpRoute.Builder newBuilder(TcpRoute prototype)
Parameter
NameDescription
prototypeTcpRoute
Returns
TypeDescription
TcpRoute.Builder

parseDelimitedFrom(InputStream input)

public static TcpRoute parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TcpRoute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TcpRoute parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TcpRoute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TcpRoute parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TcpRoute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TcpRoute parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TcpRoute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TcpRoute parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TcpRoute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TcpRoute parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TcpRoute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TcpRoute
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TcpRoute> parser()
Returns
TypeDescription
Parser<TcpRoute>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Set of label tags associated with the TcpRoute resource.

map<string, string> labels = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public TcpRoute getDefaultInstanceForType()
Returns
TypeDescription
TcpRoute

getDescription()

public String getDescription()

Optional. A free-text description of the resource. Max length 1024 characters.

string description = 4;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A free-text description of the resource. Max length 1024 characters.

string description = 4;

Returns
TypeDescription
ByteString

The bytes for description.

getGateways(int index)

public String getGateways(int index)

Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name>

repeated string gateways = 9;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The gateways at the given index.

getGatewaysBytes(int index)

public ByteString getGatewaysBytes(int index)

Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name>

repeated string gateways = 9;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the gateways at the given index.

getGatewaysCount()

public int getGatewaysCount()

Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name>

repeated string gateways = 9;

Returns
TypeDescription
int

The count of gateways.

getGatewaysList()

public ProtocolStringList getGatewaysList()

Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: projects/*/locations/global/gateways/<gateway_name>

repeated string gateways = 9;

Returns
TypeDescription
ProtocolStringList

A list containing the gateways.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Set of label tags associated with the TcpRoute resource.

map<string, string> labels = 10;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Set of label tags associated with the TcpRoute resource.

map<string, string> labels = 10;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Set of label tags associated with the TcpRoute resource.

map<string, string> labels = 10;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Set of label tags associated with the TcpRoute resource.

map<string, string> labels = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMeshes(int index)

public String getMeshes(int index)

Optional. Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name> The attached Mesh should be of a type SIDECAR

repeated string meshes = 8;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The meshes at the given index.

getMeshesBytes(int index)

public ByteString getMeshesBytes(int index)

Optional. Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name> The attached Mesh should be of a type SIDECAR

repeated string meshes = 8;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the meshes at the given index.

getMeshesCount()

public int getMeshesCount()

Optional. Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name> The attached Mesh should be of a type SIDECAR

repeated string meshes = 8;

Returns
TypeDescription
int

The count of meshes.

getMeshesList()

public ProtocolStringList getMeshesList()

Optional. Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: projects/*/locations/global/meshes/<mesh_name> The attached Mesh should be of a type SIDECAR

repeated string meshes = 8;

Returns
TypeDescription
ProtocolStringList

A list containing the meshes.

getName()

public String getName()

Required. Name of the TcpRoute resource. It matches pattern projects/*/locations/global/tcpRoutes/tcp_route_name>.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Name of the TcpRoute resource. It matches pattern projects/*/locations/global/tcpRoutes/tcp_route_name>.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<TcpRoute> getParserForType()
Returns
TypeDescription
Parser<TcpRoute>
Overrides

getRules(int index)

public TcpRoute.RouteRule getRules(int index)

Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match.

repeated .google.events.cloud.networkservices.v1.TcpRoute.RouteRule rules = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
TcpRoute.RouteRule

getRulesCount()

public int getRulesCount()

Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match.

repeated .google.events.cloud.networkservices.v1.TcpRoute.RouteRule rules = 5;

Returns
TypeDescription
int

getRulesList()

public List<TcpRoute.RouteRule> getRulesList()

Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match.

repeated .google.events.cloud.networkservices.v1.TcpRoute.RouteRule rules = 5;

Returns
TypeDescription
List<RouteRule>

getRulesOrBuilder(int index)

public TcpRoute.RouteRuleOrBuilder getRulesOrBuilder(int index)

Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match.

repeated .google.events.cloud.networkservices.v1.TcpRoute.RouteRule rules = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
TcpRoute.RouteRuleOrBuilder

getRulesOrBuilderList()

public List<? extends TcpRoute.RouteRuleOrBuilder> getRulesOrBuilderList()

Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match.

repeated .google.events.cloud.networkservices.v1.TcpRoute.RouteRule rules = 5;

Returns
TypeDescription
List<? extends com.google.events.cloud.networkservices.v1.TcpRoute.RouteRuleOrBuilder>
public String getSelfLink()

Output only. Server-defined URL of this resource

string self_link = 11;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

Output only. Server-defined URL of this resource

string self_link = 11;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TcpRoute.Builder newBuilderForType()
Returns
TypeDescription
TcpRoute.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TcpRoute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TcpRoute.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TcpRoute.Builder toBuilder()
Returns
TypeDescription
TcpRoute.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException