Class BackendRule (2.10.0)

A backend rule provides configuration for an individual API element.

Field number for the "address" field.

Field number for the "deadline" field.

Field number for the "disable_auth" field.

Field number for the "jwt_audience" field.

Field number for the "min_deadline" field.

Field number for the "operation_deadline" field.

Field number for the "overrides_by_request_protocol" field.

Field number for the "path_translation" field.

Field number for the "protocol" field.

Field number for the "selector" field.

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][google.api.BackendRule.protocol] to specify the protocol version.

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

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.

Gets whether the "disable_auth" field is set

Gets whether the "jwt_audience" field is set

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.

Deprecated, do not use.

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

The map between request protocol and the backend address.

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][google.api.BackendRule.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.

Selects the methods to which this rule applies.

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

Clears the value of the oneof if it's currently set to "disable_auth"

Clears the value of the oneof if it's currently set to "jwt_audience"