Class BackendRule (2.24.0)

A backend rule provides configuration for an individual API element.

Protobuf type google.api.BackendRule

The map between request protocol and the backend address.

map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

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.

string address = 2;

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.

string address = 2;

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

double deadline = 3;

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.

bool disable_auth = 8;

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.

string jwt_audience = 7;

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.

string jwt_audience = 7;

Deprecated. google.api.BackendRule.min_deadline is deprecated. See google/api/backend.proto;l=124

Deprecated, do not use.

double min_deadline = 4 [deprecated = true];

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

double operation_deadline = 5;

Use #getOverridesByRequestProtocolMap() instead.

The map between request protocol and the backend address.

map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

The map between request protocol and the backend address.

map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

The map between request protocol and the backend address.

map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

The map between request protocol and the backend address.

map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

.google.api.BackendRule.PathTranslation path_translation = 6;

.google.api.BackendRule.PathTranslation path_translation = 6;

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.

string protocol = 9;

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.

string protocol = 9;

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

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.

bool disable_auth = 8;

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.

string jwt_audience = 7;