BackendRule

com.google.api.backend.BackendRule
See theBackendRule companion object
final case class BackendRule(selector: String, address: String, deadline: Double, minDeadline: Double, operationDeadline: Double, pathTranslation: PathTranslation, authentication: Authentication, protocol: String, overridesByRequestProtocol: Map[String, BackendRule], unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[BackendRule]

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 GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

Attributes

Source:
BackendRule.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source:
BackendRule.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source:
BackendRule.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source:
BackendRule.scala

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns:

human-readable representation of this message.

Source:
BackendRule.scala

Attributes

Source:
BackendRule.scala

Attributes

Source:
BackendRule.scala

Attributes

Source:
BackendRule.scala

Attributes

Source:
BackendRule.scala
def withUnknownFields(`__v`: UnknownFieldSet): BackendRule

Attributes

Source:
BackendRule.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source:
BackendRule.scala

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
def update(ms: Lens[BackendRule, BackendRule] => () => BackendRule*): A

Attributes

Inherited from:
Updatable
Source:
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala