Interface BackendRuleOrBuilder (2.44.0)

Version 2.44.0

• 2.50.0 (latest)
• 2.49.0
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface BackendRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsOverridesByRequestProtocol(String key)

public abstract boolean containsOverridesByRequestProtocol(String key)

The map between request protocol and the backend address.

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

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAddress()

public abstract String getAddress()

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;

Returns
Type	Description
String	The address.

getAddressBytes()

public abstract ByteString getAddressBytes()

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;

Returns
Type	Description
ByteString	The bytes for address.

getAuthenticationCase()

public abstract BackendRule.AuthenticationCase getAuthenticationCase()

Returns
Type	Description
BackendRule.AuthenticationCase

getDeadline()

public abstract double getDeadline()

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;

Returns
Type	Description
double	The deadline.

getDisableAuth()

public abstract boolean getDisableAuth()

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;

Returns
Type	Description
boolean	The disableAuth.

getJwtAudience()

public abstract String getJwtAudience()

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;

Returns
Type	Description
String	The jwtAudience.

getJwtAudienceBytes()

public abstract ByteString getJwtAudienceBytes()

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;

Returns
Type	Description
ByteString	The bytes for jwtAudience.

getMinDeadline() (deprecated)

public abstract double getMinDeadline()

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];

Returns
Type	Description
double	The minDeadline.

getOperationDeadline()

public abstract double getOperationDeadline()

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

double operation_deadline = 5;

Returns
Type	Description
double	The operationDeadline.

getOverridesByRequestProtocol() (deprecated)

public abstract Map<String,BackendRule> getOverridesByRequestProtocol()

Use #getOverridesByRequestProtocolMap() instead.

Returns
Type	Description
Map<String,BackendRule>

getOverridesByRequestProtocolCount()

public abstract int getOverridesByRequestProtocolCount()

The map between request protocol and the backend address.

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

Returns
Type	Description
int

getOverridesByRequestProtocolMap()

public abstract Map<String,BackendRule> getOverridesByRequestProtocolMap()

The map between request protocol and the backend address.

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

Returns
Type	Description
Map<String,BackendRule>

getOverridesByRequestProtocolOrDefault(String key, BackendRule defaultValue)

public abstract BackendRule getOverridesByRequestProtocolOrDefault(String key, BackendRule defaultValue)

The map between request protocol and the backend address.

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

Parameters
Name	Description
key	String
defaultValue	BackendRule

Returns
Type	Description
BackendRule

getOverridesByRequestProtocolOrThrow(String key)

public abstract BackendRule getOverridesByRequestProtocolOrThrow(String key)

The map between request protocol and the backend address.

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

Parameter
Name	Description
key	String

Returns
Type	Description
BackendRule

getPathTranslation()

public abstract BackendRule.PathTranslation getPathTranslation()

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

Returns
Type	Description
BackendRule.PathTranslation	The pathTranslation.

getPathTranslationValue()

public abstract int getPathTranslationValue()

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

Returns
Type	Description
int	The enum numeric value on the wire for pathTranslation.

getProtocol()

public abstract String getProtocol()

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;

Returns
Type	Description
String	The protocol.

getProtocolBytes()

public abstract ByteString getProtocolBytes()

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;

Returns
Type	Description
ByteString	The bytes for protocol.

getSelector()

public abstract String getSelector()

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
Type	Description
String	The selector.

getSelectorBytes()

public abstract ByteString getSelectorBytes()

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
Type	Description
ByteString	The bytes for selector.

hasDisableAuth()

public abstract boolean hasDisableAuth()

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;

Returns
Type	Description
boolean	Whether the disableAuth field is set.

hasJwtAudience()

public abstract boolean hasJwtAudience()

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;

Returns
Type	Description
boolean	Whether the jwtAudience field is set.