BackendRuleResponse class

A backend rule provides configuration for an individual API element.

Constructors

BackendRuleResponse({required Input<String> address, required Input<double> deadline, required Input<bool> disableAuth, required Input<String> jwtAudience, required Input<double> minDeadline, required Input<double> operationDeadline, required Input<Map<String, String>> overridesByRequestProtocol, required Input<String> pathTranslation, required Input<String> protocol, required Input<String> selector})
Creates a new BackendRuleResponse. 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 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. disableAuth 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. jwtAudience 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. 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. pathTranslation Required. 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 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 for syntax details.
const
BackendRuleResponse.fromMap(Map<String, dynamic> map)
factory

Properties

address → Input<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.
final
deadline → Input<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 → Input<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 → Input<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 → Input<double>
Deprecated, do not use.
final
operationDeadline → Input<double>
The number of seconds to wait for the completion of a long running operation. The default is no deadline.
final
overridesByRequestProtocol → Input<Map<String, String>>
The map between request protocol and the backend address.
final
pathTranslation → Input<String>
final
protocol → Input<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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selector → Input<String>
Selects the methods to which this rule applies. Refer to selector for syntax details.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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