Reference documentation and code samples for the Google API Common Protos Client class BackendRule.
A backend rule provides configuration for an individual API element.
Generated from protobuf message google.api.BackendRule
Namespace
Google \ ApiMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ selector
↳ address
string
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.
↳ deadline
float
The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
↳ min_deadline
float
Deprecated, do not use.
↳ operation_deadline
float
The number of seconds to wait for the completion of a long running operation. The default is no deadline.
↳ path_translation
int
↳ jwt_audience
string
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.
↳ disable_auth
bool
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.
↳ protocol
string
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.
↳ overrides_by_request_protocol
getSelector
Selects the methods to which this rule applies.
Refer to selector for syntax details.
string
setSelector
Selects the methods to which this rule applies.
Refer to selector for syntax details.
var
string
$this
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
setAddress
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.
var
string
$this
getDeadline
The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
float
setDeadline
The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
var
float
$this
getMinDeadline
Deprecated, do not use.
float
setMinDeadline
Deprecated, do not use.
var
float
$this
getOperationDeadline
The number of seconds to wait for the completion of a long running operation. The default is no deadline.
float
setOperationDeadline
The number of seconds to wait for the completion of a long running operation. The default is no deadline.
var
float
$this
getPathTranslation
Generated from protobuf field .google.api.BackendRule.PathTranslation path_translation = 6;
int
setPathTranslation
Generated from protobuf field .google.api.BackendRule.PathTranslation path_translation = 6;
var
int
$this
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
hasJwtAudience
setJwtAudience
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.
var
string
$this
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
hasDisableAuth
setDisableAuth
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.
var
bool
$this
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
setProtocol
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.
var
string
$this
getOverridesByRequestProtocol
The map between request protocol and the backend address.
setOverridesByRequestProtocol
The map between request protocol and the backend address.
$this
getAuthentication
string
