This product is not supported for your selected Datadog site. ().

gcp_networkservices_grpc_route

ancestors

Type: UNORDERED_LIST_STRING

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. The timestamp when the resource was created.

description

Type: STRING
Provider name: description
Description: Optional. A free-text description of the resource. Max length 1024 characters.

gateways

Type: UNORDERED_LIST_STRING
Provider name: gateways
Description: 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/

hostnames

Type: UNORDERED_LIST_STRING
Provider name: hostnames
Description: Required. Service hostnames with an optional port for which this route describes traffic. Format: [:] 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”).

labels

Type: UNORDERED_LIST_STRING

meshes

Type: UNORDERED_LIST_STRING
Provider name: meshes
Description: 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/

name

Type: STRING
Provider name: name
Description: Identifier. Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

rules

Type: UNORDERED_LIST_STRUCT
Provider name: rules
Description: 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.

  • action
    Type: STRUCT
    Provider name: action
    Description: Required. A detailed rule defining how to route traffic. This field is required.
    • destinations
      Type: UNORDERED_LIST_STRUCT
      Provider name: destinations
      Description: Optional. The destination services to which traffic should be forwarded. If multiple destinations are specified, traffic will be split between Backend Service(s) according to the weight field of these destinations.
      • service_name
        Type: STRING
        Provider name: serviceName
        Description: Required. The URL of a destination service to which to route traffic. Must refer to either a BackendService or ServiceDirectoryService.
      • weight
        Type: INT32
        Provider name: weight
        Description: Optional. Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
    • fault_injection_policy
      Type: STRUCT
      Provider name: faultInjectionPolicy
      Description: Optional. The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced on a percentage of requests before sending those requests to the destination service. Similarly requests from clients can be aborted by for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy
      • abort
        Type: STRUCT
        Provider name: abort
        Description: The specification for aborting to client requests.
        • http_status
          Type: INT32
          Provider name: httpStatus
          Description: The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.
        • percentage
          Type: INT32
          Provider name: percentage
          Description: The percentage of traffic which will be aborted. The value must be between [0, 100]
      • delay
        Type: STRUCT
        Provider name: delay
        Description: The specification for injecting delay to client requests.
        • fixed_delay
          Type: STRING
          Provider name: fixedDelay
          Description: Specify a fixed delay before forwarding the request.
        • percentage
          Type: INT32
          Provider name: percentage
          Description: The percentage of traffic on which delay will be injected. The value must be between [0, 100]
    • idle_timeout
      Type: STRING
      Provider name: idleTimeout
      Description: Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled.
    • retry_policy
      Type: STRUCT
      Provider name: retryPolicy
      Description: Optional. Specifies the retry policy associated with this route.
      • num_retries
        Type: INT32
        Provider name: numRetries
        Description: Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.
      • retry_conditions
        Type: UNORDERED_LIST_STRING
        Provider name: retryConditions
        Description: - connect-failure: Router will retry on failures connecting to Backend Services, for example due to connection timeouts. - refused-stream: Router will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: Router will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Router will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Router will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Router will retry if the gRPC status code in the response header is set to unavailable
    • stateful_session_affinity
      Type: STRUCT
      Provider name: statefulSessionAffinity
      Description: Optional. Specifies cookie-based stateful session affinity.
      • cookie_ttl
        Type: STRING
        Provider name: cookieTtl
        Description: Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive. Set this to 0s to use a session cookie and disable cookie expiration.
    • timeout
      Type: STRING
      Provider name: timeout
      Description: Optional. Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.
  • matches
    Type: UNORDERED_LIST_STRUCT
    Provider name: matches
    Description: Optional. Matches define conditions used for matching the rule against incoming gRPC requests. Each match is independent, i.e. this rule will be matched if ANY one of the matches is satisfied. If no matches field is specified, this rule will unconditionally match traffic.
    • headers
      Type: UNORDERED_LIST_STRUCT
      Provider name: headers
      Description: Optional. Specifies a collection of headers to match.
      • key
        Type: STRING
        Provider name: key
        Description: Required. The key of the header.
      • type
        Type: STRING
        Provider name: type
        Description: Optional. Specifies how to match against the value of the header. If not specified, a default value of EXACT is used.
        Possible values:
        • TYPE_UNSPECIFIED - Unspecified.
        • EXACT - Will only match the exact value provided.
        • REGULAR_EXPRESSION - Will match paths conforming to the prefix specified by value. RE2 syntax is supported.
      • value
        Type: STRING
        Provider name: value
        Description: Required. The value of the header.
    • method
      Type: STRUCT
      Provider name: method
      Description: Optional. A gRPC method to match against. If this field is empty or omitted, will match all methods.
      • case_sensitive
        Type: BOOLEAN
        Provider name: caseSensitive
        Description: Optional. Specifies that matches are case sensitive. The default value is true. case_sensitive must not be used with a type of REGULAR_EXPRESSION.
      • grpc_method
        Type: STRING
        Provider name: grpcMethod
        Description: Required. Name of the method to match against. If unspecified, will match all methods.
      • grpc_service
        Type: STRING
        Provider name: grpcService
        Description: Required. Name of the service to match against. If unspecified, will match all services.
      • type
        Type: STRING
        Provider name: type
        Description: Optional. Specifies how to match against the name. If not specified, a default value of “EXACT” is used.
        Possible values:
        • TYPE_UNSPECIFIED - Unspecified.
        • EXACT - Will only match the exact name provided.
        • REGULAR_EXPRESSION - Will interpret grpc_method and grpc_service as regexes. RE2 syntax is supported.

Type: STRING
Provider name: selfLink
Description: Output only. Server-defined URL of this resource

tags

Type: UNORDERED_LIST_STRING

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The timestamp when the resource was updated.