BackendRule class final

A backend rule provides configuration for an individual API element.

Inheritance
  • Object
  • ProtoMessage
  • BackendRule

Constructors

BackendRule({String selector = '', String address = '', double deadline = 0, double minDeadline = 0, double operationDeadline = 0, BackendRule_PathTranslation pathTranslation = BackendRule_PathTranslation.$default, String? jwtAudience, bool? disableAuth, String protocol = '', Map<String, BackendRule> overridesByRequestProtocol = const {}})
BackendRule.fromJson(Object? j)
factory

Properties

address String
The address of the API backend.
final
deadline double
The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
final
disableAuth 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.
final
hashCode int
The hash code for this object.
no setterinherited
jwtAudience 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.
final
minDeadline double
Deprecated, do not use.
final
operationDeadline double
The number of seconds to wait for the completion of a long running operation. The default is no deadline.
final
overridesByRequestProtocol Map<String, BackendRule>
The map between request protocol and the backend address.
final
pathTranslation BackendRule_PathTranslation
final
protocol String
The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2".
final
qualifiedName String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selector String
Selects the methods to which this rule applies.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Object
override
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String