BackendRuleArgs

data class BackendRuleArgs(val address: Output<String>? = null, val deadline: Output<Double>? = null, val disableAuth: Output<Boolean>? = null, val jwtAudience: Output<String>? = null, val minDeadline: Output<Double>? = null, val operationDeadline: Output<Double>? = null, val overridesByRequestProtocol: Output<Map<String, String>>? = null, val pathTranslation: Output<BackendRulePathTranslation>? = null, val protocol: Output<String>? = null, val selector: Output<String>? = null) : ConvertibleToJava<BackendRuleArgs>

A backend rule provides configuration for an individual API element.

Constructors

Link copied to clipboard
fun BackendRuleArgs(address: Output<String>? = null, deadline: Output<Double>? = null, disableAuth: Output<Boolean>? = null, jwtAudience: Output<String>? = null, minDeadline: Output<Double>? = null, operationDeadline: Output<Double>? = null, overridesByRequestProtocol: Output<Map<String, String>>? = null, pathTranslation: Output<BackendRulePathTranslation>? = null, protocol: Output<String>? = null, selector: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): BackendRuleArgs

Properties

Link copied to clipboard
val address: Output<String>? = null

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

Link copied to clipboard
val deadline: Output<Double>? = null

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

Link copied to clipboard
val disableAuth: Output<Boolean>? = null

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

Link copied to clipboard
val jwtAudience: Output<String>? = null

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

Link copied to clipboard
val minDeadline: Output<Double>? = null

Deprecated, do not use.

Link copied to clipboard
val operationDeadline: Output<Double>? = null

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

Link copied to clipboard

The map between request protocol and the backend address.

Link copied to clipboard
Link copied to clipboard
val protocol: Output<String>? = null

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

Link copied to clipboard
val selector: Output<String>? = null

Selects the methods to which this rule applies. Refer to selector for syntax details.