Google Native

Pulumi Official
Package maintained by Pulumi
v0.23.0 published on Thursday, Aug 11, 2022 by Pulumi

getGrpcRoute

Gets details of a single GrpcRoute.

Using getGrpcRoute

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGrpcRoute(args: GetGrpcRouteArgs, opts?: InvokeOptions): Promise<GetGrpcRouteResult>
function getGrpcRouteOutput(args: GetGrpcRouteOutputArgs, opts?: InvokeOptions): Output<GetGrpcRouteResult>
def get_grpc_route(grpc_route_id: Optional[str] = None,
                   location: Optional[str] = None,
                   project: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetGrpcRouteResult
def get_grpc_route_output(grpc_route_id: Optional[pulumi.Input[str]] = None,
                   location: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetGrpcRouteResult]
func LookupGrpcRoute(ctx *Context, args *LookupGrpcRouteArgs, opts ...InvokeOption) (*LookupGrpcRouteResult, error)
func LookupGrpcRouteOutput(ctx *Context, args *LookupGrpcRouteOutputArgs, opts ...InvokeOption) LookupGrpcRouteResultOutput

> Note: This function is named LookupGrpcRoute in the Go SDK.

public static class GetGrpcRoute 
{
    public static Task<GetGrpcRouteResult> InvokeAsync(GetGrpcRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetGrpcRouteResult> Invoke(GetGrpcRouteInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGrpcRouteResult> getGrpcRoute(GetGrpcRouteArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:networkservices/v1beta1:getGrpcRoute
  Arguments:
    # Arguments dictionary

The following arguments are supported:

GrpcRouteId string
Location string
Project string
GrpcRouteId string
Location string
Project string
grpcRouteId String
location String
project String
grpcRouteId string
location string
project string
grpcRouteId String
location String
project String

getGrpcRoute Result

The following output properties are available:

CreateTime string

The timestamp when the resource was created.

Description string

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

Gateways List<string>

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 List<string>

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 Dictionary<string, string>

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

Meshes List<string>

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 string

Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/

Rules List<Pulumi.GoogleNative.NetworkServices.V1Beta1.Outputs.GrpcRouteRouteRuleResponse>

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.

SelfLink string

Server-defined URL of this resource

UpdateTime string

The timestamp when the resource was updated.

CreateTime string

The timestamp when the resource was created.

Description string

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

Gateways []string

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 []string

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 map[string]string

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

Meshes []string

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 string

Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/

Rules []GrpcRouteRouteRuleResponse

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.

SelfLink string

Server-defined URL of this resource

UpdateTime string

The timestamp when the resource was updated.

createTime String

The timestamp when the resource was created.

description String

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

gateways List<String>

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 List<String>

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 Map<String,String>

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

meshes List<String>

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 String

Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/

rules List<GrpcRouteRouteRuleResponse>

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.

selfLink String

Server-defined URL of this resource

updateTime String

The timestamp when the resource was updated.

createTime string

The timestamp when the resource was created.

description string

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

gateways string[]

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 string[]

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 {[key: string]: string}

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

meshes string[]

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 string

Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/

rules GrpcRouteRouteRuleResponse[]

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.

selfLink string

Server-defined URL of this resource

updateTime string

The timestamp when the resource was updated.

create_time str

The timestamp when the resource was created.

description str

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

gateways Sequence[str]

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 Sequence[str]

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 Mapping[str, str]

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

meshes Sequence[str]

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 str

Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/

rules Sequence[GrpcRouteRouteRuleResponse]

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.

self_link str

Server-defined URL of this resource

update_time str

The timestamp when the resource was updated.

createTime String

The timestamp when the resource was created.

description String

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

gateways List<String>

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 List<String>

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 Map<String>

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

meshes List<String>

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 String

Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/

rules List<Property Map>

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.

selfLink String

Server-defined URL of this resource

updateTime String

The timestamp when the resource was updated.

Supporting Types

GrpcRouteDestinationResponse

ServiceName string

The URL of a destination service to which to route traffic. Must refer to either a BackendService or ServiceDirectoryService.

Weight int

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.

ServiceName string

The URL of a destination service to which to route traffic. Must refer to either a BackendService or ServiceDirectoryService.

Weight int

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.

serviceName String

The URL of a destination service to which to route traffic. Must refer to either a BackendService or ServiceDirectoryService.

weight Integer

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.

serviceName string

The URL of a destination service to which to route traffic. Must refer to either a BackendService or ServiceDirectoryService.

weight number

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.

service_name str

The URL of a destination service to which to route traffic. Must refer to either a BackendService or ServiceDirectoryService.

weight int

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.

serviceName String

The URL of a destination service to which to route traffic. Must refer to either a BackendService or ServiceDirectoryService.

weight Number

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.

GrpcRouteFaultInjectionPolicyAbortResponse

HttpStatus int

The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.

Percentage int

The percentage of traffic which will be aborted. The value must be between [0, 100]

HttpStatus int

The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.

Percentage int

The percentage of traffic which will be aborted. The value must be between [0, 100]

httpStatus Integer

The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.

percentage Integer

The percentage of traffic which will be aborted. The value must be between [0, 100]

httpStatus number

The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.

percentage number

The percentage of traffic which will be aborted. The value must be between [0, 100]

http_status int

The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.

percentage int

The percentage of traffic which will be aborted. The value must be between [0, 100]

httpStatus Number

The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.

percentage Number

The percentage of traffic which will be aborted. The value must be between [0, 100]

GrpcRouteFaultInjectionPolicyDelayResponse

FixedDelay string

Specify a fixed delay before forwarding the request.

Percentage int

The percentage of traffic on which delay will be injected. The value must be between [0, 100]

FixedDelay string

Specify a fixed delay before forwarding the request.

Percentage int

The percentage of traffic on which delay will be injected. The value must be between [0, 100]

fixedDelay String

Specify a fixed delay before forwarding the request.

percentage Integer

The percentage of traffic on which delay will be injected. The value must be between [0, 100]

fixedDelay string

Specify a fixed delay before forwarding the request.

percentage number

The percentage of traffic on which delay will be injected. The value must be between [0, 100]

fixed_delay str

Specify a fixed delay before forwarding the request.

percentage int

The percentage of traffic on which delay will be injected. The value must be between [0, 100]

fixedDelay String

Specify a fixed delay before forwarding the request.

percentage Number

The percentage of traffic on which delay will be injected. The value must be between [0, 100]

GrpcRouteFaultInjectionPolicyResponse

Abort GrpcRouteFaultInjectionPolicyAbortResponse

The specification for aborting to client requests.

Delay GrpcRouteFaultInjectionPolicyDelayResponse

The specification for injecting delay to client requests.

abort GrpcRouteFaultInjectionPolicyAbortResponse

The specification for aborting to client requests.

delay GrpcRouteFaultInjectionPolicyDelayResponse

The specification for injecting delay to client requests.

abort GrpcRouteFaultInjectionPolicyAbortResponse

The specification for aborting to client requests.

delay GrpcRouteFaultInjectionPolicyDelayResponse

The specification for injecting delay to client requests.

abort GrpcRouteFaultInjectionPolicyAbortResponse

The specification for aborting to client requests.

delay GrpcRouteFaultInjectionPolicyDelayResponse

The specification for injecting delay to client requests.

abort Property Map

The specification for aborting to client requests.

delay Property Map

The specification for injecting delay to client requests.

GrpcRouteHeaderMatchResponse

Key string

The key of the header.

Type string

Optional. Specifies how to match against the value of the header. If not specified, a default value of EXACT is used.

Value string

The value of the header.

Key string

The key of the header.

Type string

Optional. Specifies how to match against the value of the header. If not specified, a default value of EXACT is used.

Value string

The value of the header.

key String

The key of the header.

type String

Optional. Specifies how to match against the value of the header. If not specified, a default value of EXACT is used.

value String

The value of the header.

key string

The key of the header.

type string

Optional. Specifies how to match against the value of the header. If not specified, a default value of EXACT is used.

value string

The value of the header.

key str

The key of the header.

type str

Optional. Specifies how to match against the value of the header. If not specified, a default value of EXACT is used.

value str

The value of the header.

key String

The key of the header.

type String

Optional. Specifies how to match against the value of the header. If not specified, a default value of EXACT is used.

value String

The value of the header.

GrpcRouteMethodMatchResponse

CaseSensitive bool

Optional. Specifies that matches are case sensitive. The default value is true. case_sensitive must not be used with a type of REGULAR_EXPRESSION.

GrpcMethod string

Name of the method to match against. If unspecified, will match all methods.

GrpcService string

Name of the service to match against. If unspecified, will match all services.

Type string

Optional. Specifies how to match against the name. If not specified, a default value of "EXACT" is used.

CaseSensitive bool

Optional. Specifies that matches are case sensitive. The default value is true. case_sensitive must not be used with a type of REGULAR_EXPRESSION.

GrpcMethod string

Name of the method to match against. If unspecified, will match all methods.

GrpcService string

Name of the service to match against. If unspecified, will match all services.

Type string

Optional. Specifies how to match against the name. If not specified, a default value of "EXACT" is used.

caseSensitive Boolean

Optional. Specifies that matches are case sensitive. The default value is true. case_sensitive must not be used with a type of REGULAR_EXPRESSION.

grpcMethod String

Name of the method to match against. If unspecified, will match all methods.

grpcService String

Name of the service to match against. If unspecified, will match all services.

type String

Optional. Specifies how to match against the name. If not specified, a default value of "EXACT" is used.

caseSensitive boolean

Optional. Specifies that matches are case sensitive. The default value is true. case_sensitive must not be used with a type of REGULAR_EXPRESSION.

grpcMethod string

Name of the method to match against. If unspecified, will match all methods.

grpcService string

Name of the service to match against. If unspecified, will match all services.

type string

Optional. Specifies how to match against the name. If not specified, a default value of "EXACT" is used.

case_sensitive bool

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 str

Name of the method to match against. If unspecified, will match all methods.

grpc_service str

Name of the service to match against. If unspecified, will match all services.

type str

Optional. Specifies how to match against the name. If not specified, a default value of "EXACT" is used.

caseSensitive Boolean

Optional. Specifies that matches are case sensitive. The default value is true. case_sensitive must not be used with a type of REGULAR_EXPRESSION.

grpcMethod String

Name of the method to match against. If unspecified, will match all methods.

grpcService String

Name of the service to match against. If unspecified, will match all services.

type String

Optional. Specifies how to match against the name. If not specified, a default value of "EXACT" is used.

GrpcRouteRetryPolicyResponse

NumRetries int

Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.

RetryConditions List<string>
  • 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
NumRetries int

Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.

RetryConditions []string
  • 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
numRetries Integer

Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.

retryConditions List<String>
  • 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
numRetries number

Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.

retryConditions string[]
  • 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
num_retries int

Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.

retry_conditions Sequence[str]
  • 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
numRetries Number

Specifies the allowed number of retries. This number must be > 0. If not specified, default to 1.

retryConditions List<String>
  • 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

GrpcRouteRouteActionResponse

Destinations List<Pulumi.GoogleNative.NetworkServices.V1Beta1.Inputs.GrpcRouteDestinationResponse>

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.

FaultInjectionPolicy Pulumi.GoogleNative.NetworkServices.V1Beta1.Inputs.GrpcRouteFaultInjectionPolicyResponse

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

RetryPolicy Pulumi.GoogleNative.NetworkServices.V1Beta1.Inputs.GrpcRouteRetryPolicyResponse

Optional. Specifies the retry policy associated with this route.

Timeout string

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.

Destinations []GrpcRouteDestinationResponse

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.

FaultInjectionPolicy GrpcRouteFaultInjectionPolicyResponse

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

RetryPolicy GrpcRouteRetryPolicyResponse

Optional. Specifies the retry policy associated with this route.

Timeout string

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.

destinations List<GrpcRouteDestinationResponse>

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.

faultInjectionPolicy GrpcRouteFaultInjectionPolicyResponse

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

retryPolicy GrpcRouteRetryPolicyResponse

Optional. Specifies the retry policy associated with this route.

timeout String

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.

destinations GrpcRouteDestinationResponse[]

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.

faultInjectionPolicy GrpcRouteFaultInjectionPolicyResponse

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

retryPolicy GrpcRouteRetryPolicyResponse

Optional. Specifies the retry policy associated with this route.

timeout string

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.

destinations Sequence[GrpcRouteDestinationResponse]

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.

fault_injection_policy GrpcRouteFaultInjectionPolicyResponse

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

retry_policy GrpcRouteRetryPolicyResponse

Optional. Specifies the retry policy associated with this route.

timeout str

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.

destinations List<Property Map>

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.

faultInjectionPolicy Property Map

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

retryPolicy Property Map

Optional. Specifies the retry policy associated with this route.

timeout String

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.

GrpcRouteRouteMatchResponse

Headers List<Pulumi.GoogleNative.NetworkServices.V1Beta1.Inputs.GrpcRouteHeaderMatchResponse>

Optional. Specifies a collection of headers to match.

Method Pulumi.GoogleNative.NetworkServices.V1Beta1.Inputs.GrpcRouteMethodMatchResponse

Optional. A gRPC method to match against. If this field is empty or omitted, will match all methods.

Headers []GrpcRouteHeaderMatchResponse

Optional. Specifies a collection of headers to match.

Method GrpcRouteMethodMatchResponse

Optional. A gRPC method to match against. If this field is empty or omitted, will match all methods.

headers List<GrpcRouteHeaderMatchResponse>

Optional. Specifies a collection of headers to match.

method GrpcRouteMethodMatchResponse

Optional. A gRPC method to match against. If this field is empty or omitted, will match all methods.

headers GrpcRouteHeaderMatchResponse[]

Optional. Specifies a collection of headers to match.

method GrpcRouteMethodMatchResponse

Optional. A gRPC method to match against. If this field is empty or omitted, will match all methods.

headers Sequence[GrpcRouteHeaderMatchResponse]

Optional. Specifies a collection of headers to match.

method GrpcRouteMethodMatchResponse

Optional. A gRPC method to match against. If this field is empty or omitted, will match all methods.

headers List<Property Map>

Optional. Specifies a collection of headers to match.

method Property Map

Optional. A gRPC method to match against. If this field is empty or omitted, will match all methods.

GrpcRouteRouteRuleResponse

Action Pulumi.GoogleNative.NetworkServices.V1Beta1.Inputs.GrpcRouteRouteActionResponse

A detailed rule defining how to route traffic. This field is required.

Matches List<Pulumi.GoogleNative.NetworkServices.V1Beta1.Inputs.GrpcRouteRouteMatchResponse>

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.

Action GrpcRouteRouteActionResponse

A detailed rule defining how to route traffic. This field is required.

Matches []GrpcRouteRouteMatchResponse

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.

action GrpcRouteRouteActionResponse

A detailed rule defining how to route traffic. This field is required.

matches List<GrpcRouteRouteMatchResponse>

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.

action GrpcRouteRouteActionResponse

A detailed rule defining how to route traffic. This field is required.

matches GrpcRouteRouteMatchResponse[]

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.

action GrpcRouteRouteActionResponse

A detailed rule defining how to route traffic. This field is required.

matches Sequence[GrpcRouteRouteMatchResponse]

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.

action Property Map

A detailed rule defining how to route traffic. This field is required.

matches List<Property Map>

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.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0