com.google.api.backend
Members list
Type members
Classlikes
Backend
defines the backend configuration for a service.
Backend
defines the backend configuration for a service.
Attributes
- rules
A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Companion:
- object
- Source:
- Backend.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- Backend.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[Backend]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- Backend.type
Attributes
- Source:
- BackendProto.scala
- Graph
- Supertypes
- class GeneratedFileObjectclass Objecttrait Matchableclass Any
- Self type
- BackendProto.type
A backend rule provides configuration for an individual API element.
A backend rule provides configuration for an individual API element.
Attributes
- address
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.
- deadline
The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- minDeadline
Deprecated, do not use.
- operationDeadline
The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overridesByRequestProtocol
The map between request protocol and the backend address.
- protocol
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.
- selector
Selects the methods to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
- Companion:
- object
- Source:
- BackendRule.scala
- Graph
- Supertypes
- trait Updatable[BackendRule]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- BackendRule.scala
- Graph
- Supertypes
- trait Producttrait Mirrortrait GeneratedMessageCompanion[BackendRule]trait Serializableclass Objecttrait Matchableclass Any
- Self type
- BackendRule.type