Interface GrpcRouteOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GrpcRoute, GrpcRoute.Builder

@Generated public interface GrpcRouteOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getName

      String getName()
       Identifier. Name of the GrpcRoute resource. It matches pattern
       `projects/*/locations/global/grpcRoutes/<grpc_route_name>`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. Name of the GrpcRoute resource. It matches pattern
       `projects/*/locations/global/grpcRoutes/<grpc_route_name>`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.
    • getSelfLink

      String getSelfLink()
       Output only. Server-defined URL of this resource
       
      string self_link = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The selfLink.
    • getSelfLinkBytes

      com.google.protobuf.ByteString getSelfLinkBytes()
       Output only. Server-defined URL of this resource
       
      string self_link = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for selfLink.
    • hasCreateTime

      boolean hasCreateTime()
       Output only. The timestamp when the resource was created.
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp when the resource was created.
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp when the resource was created.
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The timestamp when the resource was updated.
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The timestamp when the resource was updated.
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The timestamp when the resource was updated.
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getLabelsCount

      int getLabelsCount()
       Optional. Set of label tags associated with the GrpcRoute resource.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
    • containsLabels

      boolean containsLabels(String key)
       Optional. Set of label tags associated with the GrpcRoute resource.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getLabels

      Deprecated.
      Use getLabelsMap() instead.
    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. Set of label tags associated with the GrpcRoute resource.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Optional. Set of label tags associated with the GrpcRoute resource.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional. Set of label tags associated with the GrpcRoute resource.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getDescription

      String getDescription()
       Optional. A free-text description of the resource. Max length 1024
       characters.
       
      string description = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.
    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. A free-text description of the resource. Max length 1024
       characters.
       
      string description = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.
    • getHostnamesList

      List<String> getHostnamesList()
       Required. Service hostnames with an optional port for which this route
       describes traffic.
      
       Format: <hostname>[:<port>]
      
       Hostname is the fully qualified domain name of a network host. This matches
       the RFC 1123 definition of a hostname with 2 notable exceptions:
       - 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 Gateway 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 route, it is
       not possible to associate two routes both with `*.bar.com` or both with
       `bar.com`.
      
       If a port is specified, then gRPC clients must use the channel URI with the
       port to match this rule (i.e. "xds:///service:123"), otherwise they must
       supply the URI without a port (i.e. "xds:///service").
       
      repeated string hostnames = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      A list containing the hostnames.
    • getHostnamesCount

      int getHostnamesCount()
       Required. Service hostnames with an optional port for which this route
       describes traffic.
      
       Format: <hostname>[:<port>]
      
       Hostname is the fully qualified domain name of a network host. This matches
       the RFC 1123 definition of a hostname with 2 notable exceptions:
       - 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 Gateway 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 route, it is
       not possible to associate two routes both with `*.bar.com` or both with
       `bar.com`.
      
       If a port is specified, then gRPC clients must use the channel URI with the
       port to match this rule (i.e. "xds:///service:123"), otherwise they must
       supply the URI without a port (i.e. "xds:///service").
       
      repeated string hostnames = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The count of hostnames.
    • getHostnames

      String getHostnames(int index)
       Required. Service hostnames with an optional port for which this route
       describes traffic.
      
       Format: <hostname>[:<port>]
      
       Hostname is the fully qualified domain name of a network host. This matches
       the RFC 1123 definition of a hostname with 2 notable exceptions:
       - 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 Gateway 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 route, it is
       not possible to associate two routes both with `*.bar.com` or both with
       `bar.com`.
      
       If a port is specified, then gRPC clients must use the channel URI with the
       port to match this rule (i.e. "xds:///service:123"), otherwise they must
       supply the URI without a port (i.e. "xds:///service").
       
      repeated string hostnames = 6 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the element to return.
      Returns:
      The hostnames at the given index.
    • getHostnamesBytes

      com.google.protobuf.ByteString getHostnamesBytes(int index)
       Required. Service hostnames with an optional port for which this route
       describes traffic.
      
       Format: <hostname>[:<port>]
      
       Hostname is the fully qualified domain name of a network host. This matches
       the RFC 1123 definition of a hostname with 2 notable exceptions:
       - 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 Gateway 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 route, it is
       not possible to associate two routes both with `*.bar.com` or both with
       `bar.com`.
      
       If a port is specified, then gRPC clients must use the channel URI with the
       port to match this rule (i.e. "xds:///service:123"), otherwise they must
       supply the URI without a port (i.e. "xds:///service").
       
      repeated string hostnames = 6 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the hostnames at the given index.
    • getMeshesList

      List<String> getMeshesList()
       Optional. Meshes defines a list of meshes this GrpcRoute 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>`
       
      repeated string meshes = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the meshes.
    • getMeshesCount

      int getMeshesCount()
       Optional. Meshes defines a list of meshes this GrpcRoute 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>`
       
      repeated string meshes = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The count of meshes.
    • getMeshes

      String getMeshes(int index)
       Optional. Meshes defines a list of meshes this GrpcRoute 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>`
       
      repeated string meshes = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The meshes at the given index.
    • getMeshesBytes

      com.google.protobuf.ByteString getMeshesBytes(int index)
       Optional. Meshes defines a list of meshes this GrpcRoute 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>`
       
      repeated string meshes = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the meshes at the given index.
    • getGatewaysList

      List<String> getGatewaysList()
       Optional. Gateways defines a list of gateways this GrpcRoute 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 = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      A list containing the gateways.
    • getGatewaysCount

      int getGatewaysCount()
       Optional. Gateways defines a list of gateways this GrpcRoute 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 = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The count of gateways.
    • getGateways

      String getGateways(int index)
       Optional. Gateways defines a list of gateways this GrpcRoute 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 = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The gateways at the given index.
    • getGatewaysBytes

      com.google.protobuf.ByteString getGatewaysBytes(int index)
       Optional. Gateways defines a list of gateways this GrpcRoute 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 = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the gateways at the given index.
    • getRulesList

      List<GrpcRoute.RouteRule> getRulesList()
       Required. A list of detailed rules defining how to route traffic.
      
       Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the
       first matching GrpcRoute.RouteRule will be executed. At least one rule
       must be supplied.
       
      repeated .google.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7 [(.google.api.field_behavior) = REQUIRED];
    • getRules

      GrpcRoute.RouteRule getRules(int index)
       Required. A list of detailed rules defining how to route traffic.
      
       Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the
       first matching GrpcRoute.RouteRule will be executed. At least one rule
       must be supplied.
       
      repeated .google.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7 [(.google.api.field_behavior) = REQUIRED];
    • getRulesCount

      int getRulesCount()
       Required. A list of detailed rules defining how to route traffic.
      
       Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the
       first matching GrpcRoute.RouteRule will be executed. At least one rule
       must be supplied.
       
      repeated .google.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7 [(.google.api.field_behavior) = REQUIRED];
    • getRulesOrBuilderList

      List<? extends GrpcRoute.RouteRuleOrBuilder> getRulesOrBuilderList()
       Required. A list of detailed rules defining how to route traffic.
      
       Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the
       first matching GrpcRoute.RouteRule will be executed. At least one rule
       must be supplied.
       
      repeated .google.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7 [(.google.api.field_behavior) = REQUIRED];
    • getRulesOrBuilder

      GrpcRoute.RouteRuleOrBuilder getRulesOrBuilder(int index)
       Required. A list of detailed rules defining how to route traffic.
      
       Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the
       first matching GrpcRoute.RouteRule will be executed. At least one rule
       must be supplied.
       
      repeated .google.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7 [(.google.api.field_behavior) = REQUIRED];