public final class HttpRoute extends GeneratedMessageV3 implements HttpRouteOrBuilder
HttpRoute is the resource defining how HTTP traffic should be routed by a
Mesh or Gateway resource.
Protobuf type google.events.cloud.networkservices.v1.HttpRoute
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 |
|
GATEWAYS_FIELD_NUMBER
public static final int GATEWAYS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HOSTNAMES_FIELD_NUMBER
public static final int HOSTNAMES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MESHES_FIELD_NUMBER
public static final int MESHES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RULES_FIELD_NUMBER
public static final int RULES_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 |
|
Static Methods
getDefaultInstance()
public static HttpRoute getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static HttpRoute.Builder newBuilder()
newBuilder(HttpRoute prototype)
public static HttpRoute.Builder newBuilder(HttpRoute prototype)
| Parameter |
| Name |
Description |
prototype |
HttpRoute
|
public static HttpRoute parseDelimitedFrom(InputStream input)
public static HttpRoute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static HttpRoute parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HttpRoute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static HttpRoute parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRoute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpRoute parseFrom(CodedInputStream input)
public static HttpRoute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HttpRoute parseFrom(InputStream input)
public static HttpRoute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static HttpRoute parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HttpRoute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<HttpRoute> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Optional. Set of label tags associated with the HttpRoute resource.
map<string, string> labels = 10;
| 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. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3;
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3;
getDefaultInstanceForType()
public HttpRoute getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. A free-text description of the resource. Max length 1024
characters.
string description = 2;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. A free-text description of the resource. Max length 1024
characters.
string description = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getGateways(int index)
public String getGateways(int index)
Optional. Gateways defines a list of gateways this HttpRoute 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 |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The gateways at the given index.
|
getGatewaysBytes(int index)
public ByteString getGatewaysBytes(int index)
Optional. Gateways defines a list of gateways this HttpRoute 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 |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the gateways at the given index.
|
getGatewaysCount()
public int getGatewaysCount()
Optional. Gateways defines a list of gateways this HttpRoute 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 |
| Type |
Description |
int |
The count of gateways.
|
getGatewaysList()
public ProtocolStringList getGatewaysList()
Optional. Gateways defines a list of gateways this HttpRoute 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;
getHostnames(int index)
public String getHostnames(int index)
Required. Hostnames define a set of hosts that should match against the
HTTP host header to select a HttpRoute to process the request. Hostname is
the fully qualified domain name of a network host, as defined by RFC 1123
with the exception that:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard
label must appear by itself as the first label.
Hostname can be "precise" which is a domain name without the terminating
dot of a network host (e.g. foo.example.com) or "wildcard", which is a
domain name prefixed with a single wildcard label (e.g. .example.com).
Note that as per RFC1035 and RFC1123, a label must consist of lower case
alphanumeric characters or '-', and must start and end with an alphanumeric
character. No other punctuation is allowed.
The routes associated with a Mesh or Gateways must have unique hostnames.
If you attempt to attach multiple routes with conflicting hostnames,
the configuration will be rejected.
For example, while it is acceptable for routes for the hostnames
.foo.bar.com and .bar.com to be associated with the same Mesh (or
Gateways under the same scope), it is not possible to associate two routes
both with *.bar.com or both with bar.com.
repeated string hostnames = 5;
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The hostnames at the given index.
|
getHostnamesBytes(int index)
public ByteString getHostnamesBytes(int index)
Required. Hostnames define a set of hosts that should match against the
HTTP host header to select a HttpRoute to process the request. Hostname is
the fully qualified domain name of a network host, as defined by RFC 1123
with the exception that:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard
label must appear by itself as the first label.
Hostname can be "precise" which is a domain name without the terminating
dot of a network host (e.g. foo.example.com) or "wildcard", which is a
domain name prefixed with a single wildcard label (e.g. .example.com).
Note that as per RFC1035 and RFC1123, a label must consist of lower case
alphanumeric characters or '-', and must start and end with an alphanumeric
character. No other punctuation is allowed.
The routes associated with a Mesh or Gateways must have unique hostnames.
If you attempt to attach multiple routes with conflicting hostnames,
the configuration will be rejected.
For example, while it is acceptable for routes for the hostnames
.foo.bar.com and .bar.com to be associated with the same Mesh (or
Gateways under the same scope), it is not possible to associate two routes
both with *.bar.com or both with bar.com.
repeated string hostnames = 5;
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the hostnames at the given index.
|
getHostnamesCount()
public int getHostnamesCount()
Required. Hostnames define a set of hosts that should match against the
HTTP host header to select a HttpRoute to process the request. Hostname is
the fully qualified domain name of a network host, as defined by RFC 1123
with the exception that:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard
label must appear by itself as the first label.
Hostname can be "precise" which is a domain name without the terminating
dot of a network host (e.g. foo.example.com) or "wildcard", which is a
domain name prefixed with a single wildcard label (e.g. .example.com).
Note that as per RFC1035 and RFC1123, a label must consist of lower case
alphanumeric characters or '-', and must start and end with an alphanumeric
character. No other punctuation is allowed.
The routes associated with a Mesh or Gateways must have unique hostnames.
If you attempt to attach multiple routes with conflicting hostnames,
the configuration will be rejected.
For example, while it is acceptable for routes for the hostnames
.foo.bar.com and .bar.com to be associated with the same Mesh (or
Gateways under the same scope), it is not possible to associate two routes
both with *.bar.com or both with bar.com.
repeated string hostnames = 5;
| Returns |
| Type |
Description |
int |
The count of hostnames.
|
getHostnamesList()
public ProtocolStringList getHostnamesList()
Required. Hostnames define a set of hosts that should match against the
HTTP host header to select a HttpRoute to process the request. Hostname is
the fully qualified domain name of a network host, as defined by RFC 1123
with the exception that:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard
label must appear by itself as the first label.
Hostname can be "precise" which is a domain name without the terminating
dot of a network host (e.g. foo.example.com) or "wildcard", which is a
domain name prefixed with a single wildcard label (e.g. .example.com).
Note that as per RFC1035 and RFC1123, a label must consist of lower case
alphanumeric characters or '-', and must start and end with an alphanumeric
character. No other punctuation is allowed.
The routes associated with a Mesh or Gateways must have unique hostnames.
If you attempt to attach multiple routes with conflicting hostnames,
the configuration will be rejected.
For example, while it is acceptable for routes for the hostnames
.foo.bar.com and .bar.com to be associated with the same Mesh (or
Gateways under the same scope), it is not possible to associate two routes
both with *.bar.com or both with bar.com.
repeated string hostnames = 5;
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Optional. Set of label tags associated with the HttpRoute resource.
map<string, string> labels = 10;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. Set of label tags associated with the HttpRoute resource.
map<string, string> labels = 10;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. Set of label tags associated with the HttpRoute resource.
map<string, string> labels = 10;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. Set of label tags associated with the HttpRoute resource.
map<string, string> labels = 10;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getMeshes(int index)
public String getMeshes(int index)
Optional. Meshes defines a list of meshes this HttpRoute 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 |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The meshes at the given index.
|
getMeshesBytes(int index)
public ByteString getMeshesBytes(int index)
Optional. Meshes defines a list of meshes this HttpRoute 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 |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the meshes at the given index.
|
getMeshesCount()
public int getMeshesCount()
Optional. Meshes defines a list of meshes this HttpRoute 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 |
| Type |
Description |
int |
The count of meshes.
|
getMeshesList()
public ProtocolStringList getMeshesList()
Optional. Meshes defines a list of meshes this HttpRoute 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;
getName()
Required. Name of the HttpRoute resource. It matches pattern
projects/*/locations/global/httpRoutes/http_route_name>.
string name = 1;
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. Name of the HttpRoute resource. It matches pattern
projects/*/locations/global/httpRoutes/http_route_name>.
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<HttpRoute> getParserForType()
Overrides
getRules(int index)
public HttpRoute.RouteRule getRules(int index)
Required. Rules that define how traffic is routed and handled.
Rules will be matched sequentially based on the RouteMatch specified for
the rule.
repeated .google.events.cloud.networkservices.v1.HttpRoute.RouteRule rules = 6;
| Parameter |
| Name |
Description |
index |
int
|
getRulesCount()
public int getRulesCount()
Required. Rules that define how traffic is routed and handled.
Rules will be matched sequentially based on the RouteMatch specified for
the rule.
repeated .google.events.cloud.networkservices.v1.HttpRoute.RouteRule rules = 6;
| Returns |
| Type |
Description |
int |
|
getRulesList()
public List<HttpRoute.RouteRule> getRulesList()
Required. Rules that define how traffic is routed and handled.
Rules will be matched sequentially based on the RouteMatch specified for
the rule.
repeated .google.events.cloud.networkservices.v1.HttpRoute.RouteRule rules = 6;
getRulesOrBuilder(int index)
public HttpRoute.RouteRuleOrBuilder getRulesOrBuilder(int index)
Required. Rules that define how traffic is routed and handled.
Rules will be matched sequentially based on the RouteMatch specified for
the rule.
repeated .google.events.cloud.networkservices.v1.HttpRoute.RouteRule rules = 6;
| Parameter |
| Name |
Description |
index |
int
|
getRulesOrBuilderList()
public List<? extends HttpRoute.RouteRuleOrBuilder> getRulesOrBuilderList()
Required. Rules that define how traffic is routed and handled.
Rules will be matched sequentially based on the RouteMatch specified for
the rule.
repeated .google.events.cloud.networkservices.v1.HttpRoute.RouteRule rules = 6;
| Returns |
| Type |
Description |
List<? extends com.google.events.cloud.networkservices.v1.HttpRoute.RouteRuleOrBuilder> |
|
getSelfLink()
public String getSelfLink()
Output only. Server-defined URL of this resource
string self_link = 11;
| Returns |
| Type |
Description |
String |
The selfLink.
|
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
Output only. Server-defined URL of this resource
string self_link = 11;
| Returns |
| Type |
Description |
ByteString |
The bytes for selfLink.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4;
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4;
hasCreateTime()
public boolean hasCreateTime()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3;
| Returns |
| Type |
Description |
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 = 4;
| Returns |
| Type |
Description |
boolean |
Whether the updateTime 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 HttpRoute.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HttpRoute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public HttpRoute.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
