public static final class HttpRoute.Builder extends GeneratedMessageV3.Builder<HttpRoute.Builder> implements HttpRouteOrBuilderHttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.
Protobuf type google.events.cloud.networkservices.v1.HttpRoute
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > HttpRoute.BuilderImplements
HttpRouteOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllGateways(Iterable<String> values)
public HttpRoute.Builder addAllGateways(Iterable<String> values) 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 |
values |
Iterable<String>The gateways to add. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
addAllHostnames(Iterable<String> values)
public HttpRoute.Builder addAllHostnames(Iterable<String> values)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.comand.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.com.
repeated string hostnames = 5;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The hostnames to add. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
addAllMeshes(Iterable<String> values)
public HttpRoute.Builder addAllMeshes(Iterable<String> values) 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 |
values |
Iterable<String>The meshes to add. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
addAllRules(Iterable<? extends HttpRoute.RouteRule> values)
public HttpRoute.Builder addAllRules(Iterable<? extends HttpRoute.RouteRule> values)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 |
values |
Iterable<? extends com.google.events.cloud.networkservices.v1.HttpRoute.RouteRule> |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
addGateways(String value)
public HttpRoute.Builder addGateways(String value) 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 |
value |
StringThe gateways to add. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
addGatewaysBytes(ByteString value)
public HttpRoute.Builder addGatewaysBytes(ByteString value) 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 |
value |
ByteStringThe bytes of the gateways to add. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
addHostnames(String value)
public HttpRoute.Builder addHostnames(String value)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.comand.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.com.
repeated string hostnames = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe hostnames to add. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
addHostnamesBytes(ByteString value)
public HttpRoute.Builder addHostnamesBytes(ByteString value)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.comand.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.com.
repeated string hostnames = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the hostnames to add. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
addMeshes(String value)
public HttpRoute.Builder addMeshes(String value) 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 |
value |
StringThe meshes to add. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
addMeshesBytes(ByteString value)
public HttpRoute.Builder addMeshesBytes(ByteString value) 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 |
value |
ByteStringThe bytes of the meshes to add. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public HttpRoute.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
addRules(HttpRoute.RouteRule value)
public HttpRoute.Builder addRules(HttpRoute.RouteRule value)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 |
value |
HttpRoute.RouteRule |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
addRules(HttpRoute.RouteRule.Builder builderForValue)
public HttpRoute.Builder addRules(HttpRoute.RouteRule.Builder builderForValue)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 |
builderForValue |
HttpRoute.RouteRule.Builder |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
addRules(int index, HttpRoute.RouteRule value)
public HttpRoute.Builder addRules(int index, HttpRoute.RouteRule value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
HttpRoute.RouteRule |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
addRules(int index, HttpRoute.RouteRule.Builder builderForValue)
public HttpRoute.Builder addRules(int index, HttpRoute.RouteRule.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
HttpRoute.RouteRule.Builder |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
addRulesBuilder()
public HttpRoute.RouteRule.Builder addRulesBuilder()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 |
HttpRoute.RouteRule.Builder |
|
addRulesBuilder(int index)
public HttpRoute.RouteRule.Builder addRulesBuilder(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 |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.RouteRule.Builder |
|
build()
public HttpRoute build()| Returns | |
|---|---|
| Type | Description |
HttpRoute |
|
buildPartial()
public HttpRoute buildPartial()| Returns | |
|---|---|
| Type | Description |
HttpRoute |
|
clear()
public HttpRoute.Builder clear()| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
clearCreateTime()
public HttpRoute.Builder clearCreateTime()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
clearDescription()
public HttpRoute.Builder clearDescription()Optional. A free-text description of the resource. Max length 1024 characters.
string description = 2;
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public HttpRoute.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
clearGateways()
public HttpRoute.Builder clearGateways() 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 |
HttpRoute.Builder |
This builder for chaining. |
clearHostnames()
public HttpRoute.Builder clearHostnames()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.comand.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.com.
repeated string hostnames = 5;
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
clearLabels()
public HttpRoute.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
clearMeshes()
public HttpRoute.Builder clearMeshes() 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 |
HttpRoute.Builder |
This builder for chaining. |
clearName()
public HttpRoute.Builder clearName() Required. Name of the HttpRoute resource. It matches pattern
projects/*/locations/global/httpRoutes/http_route_name>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public HttpRoute.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
clearRules()
public HttpRoute.Builder clearRules()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 |
HttpRoute.Builder |
|
clearSelfLink()
public HttpRoute.Builder clearSelfLink()Output only. Server-defined URL of this resource
string self_link = 11;
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
clearUpdateTime()
public HttpRoute.Builder clearUpdateTime()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4;
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
clone()
public HttpRoute.Builder clone()| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public HttpRoute getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
HttpRoute |
|
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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
intThe 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 |
intThe 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the gateways. |
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.comand.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.com.
repeated string hostnames = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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.comand.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.com.
repeated string hostnames = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe 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.comand.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.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.comand.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.com.
repeated string hostnames = 5;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the hostnames. |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| 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 |
intThe 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 |
intThe 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the meshes. |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public String 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. |
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 |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.RouteRule |
|
getRulesBuilder(int index)
public HttpRoute.RouteRule.Builder getRulesBuilder(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 |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.RouteRule.Builder |
|
getRulesBuilderList()
public List<HttpRoute.RouteRule.Builder> getRulesBuilderList()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<Builder> |
|
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;
| Returns | |
|---|---|
| Type | Description |
List<RouteRule> |
|
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 |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.RouteRuleOrBuilder |
|
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. |
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCreateTime(Timestamp value)
public HttpRoute.Builder mergeCreateTime(Timestamp value)Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
mergeFrom(HttpRoute other)
public HttpRoute.Builder mergeFrom(HttpRoute other)| Parameter | |
|---|---|
| Name | Description |
other |
HttpRoute |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public HttpRoute.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public HttpRoute.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final HttpRoute.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
mergeUpdateTime(Timestamp value)
public HttpRoute.Builder mergeUpdateTime(Timestamp value)Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
putAllLabels(Map<String,String> values)
public HttpRoute.Builder putAllLabels(Map<String,String> values)Optional. Set of label tags associated with the HttpRoute resource.
map<string, string> labels = 10;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
putLabels(String key, String value)
public HttpRoute.Builder putLabels(String key, String value)Optional. Set of label tags associated with the HttpRoute resource.
map<string, string> labels = 10;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
removeLabels(String key)
public HttpRoute.Builder removeLabels(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 |
HttpRoute.Builder |
|
removeRules(int index)
public HttpRoute.Builder removeRules(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 |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
setCreateTime(Timestamp value)
public HttpRoute.Builder setCreateTime(Timestamp value)Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public HttpRoute.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
setDescription(String value)
public HttpRoute.Builder setDescription(String value)Optional. A free-text description of the resource. Max length 1024 characters.
string description = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public HttpRoute.Builder setDescriptionBytes(ByteString value)Optional. A free-text description of the resource. Max length 1024 characters.
string description = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public HttpRoute.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
setGateways(int index, String value)
public HttpRoute.Builder setGateways(int index, String value) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe gateways to set. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
setHostnames(int index, String value)
public HttpRoute.Builder setHostnames(int index, String value)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.comand.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.com.
repeated string hostnames = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe hostnames to set. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
setMeshes(int index, String value)
public HttpRoute.Builder setMeshes(int index, String value) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe meshes to set. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
setName(String value)
public HttpRoute.Builder setName(String value) Required. Name of the HttpRoute resource. It matches pattern
projects/*/locations/global/httpRoutes/http_route_name>.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public HttpRoute.Builder setNameBytes(ByteString value) Required. Name of the HttpRoute resource. It matches pattern
projects/*/locations/global/httpRoutes/http_route_name>.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public HttpRoute.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
setRules(int index, HttpRoute.RouteRule value)
public HttpRoute.Builder setRules(int index, HttpRoute.RouteRule value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
HttpRoute.RouteRule |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
setRules(int index, HttpRoute.RouteRule.Builder builderForValue)
public HttpRoute.Builder setRules(int index, HttpRoute.RouteRule.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
HttpRoute.RouteRule.Builder |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
setSelfLink(String value)
public HttpRoute.Builder setSelfLink(String value)Output only. Server-defined URL of this resource
string self_link = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe selfLink to set. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
setSelfLinkBytes(ByteString value)
public HttpRoute.Builder setSelfLinkBytes(ByteString value)Output only. Server-defined URL of this resource
string self_link = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for selfLink to set. |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final HttpRoute.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
setUpdateTime(Timestamp value)
public HttpRoute.Builder setUpdateTime(Timestamp value)Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public HttpRoute.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
HttpRoute.Builder |
|