Class: Google::Apis::ServicenetworkingV1::BackendRule
- Inherits:
-
Object
- Object
- Google::Apis::ServicenetworkingV1::BackendRule
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/servicenetworking_v1/classes.rb,
generated/google/apis/servicenetworking_v1/representations.rb,
generated/google/apis/servicenetworking_v1/representations.rb
Overview
A backend rule provides configuration for an individual API element.
Instance Attribute Summary collapse
-
#address ⇒ String
The address of the API backend.
-
#deadline ⇒ Float
The number of seconds to wait for a response from a request.
-
#disable_auth ⇒ Boolean
(also: #disable_auth?)
When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved.
-
#jwt_audience ⇒ String
The JWT audience is used when generating a JWT ID token for the backend.
-
#min_deadline ⇒ Float
Minimum deadline in seconds needed for this method.
-
#operation_deadline ⇒ Float
The number of seconds to wait for the completion of a long running operation.
-
#path_translation ⇒ String
Corresponds to the JSON property
pathTranslation
. -
#protocol ⇒ String
The protocol used for sending a request to the backend.
-
#selector ⇒ String
Selects the methods to which this rule applies.
Instance Method Summary collapse
-
#initialize(**args) ⇒ BackendRule
constructor
A new instance of BackendRule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ BackendRule
Returns a new instance of BackendRule.
517 518 519 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 517 def initialize(**args) update!(**args) end |
Instance Attribute Details
#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.
Corresponds to the JSON property
address
449 450 451 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 449 def address @address end |
#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.
Corresponds to the JSON property deadline
455 456 457 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 455 def deadline @deadline end |
#disable_auth ⇒ Boolean Also known as: disable_auth?
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.
Corresponds to the JSON property disableAuth
463 464 465 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 463 def disable_auth @disable_auth end |
#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.
Corresponds to the JSON property jwtAudience
471 472 473 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 471 def jwt_audience @jwt_audience end |
#min_deadline ⇒ Float
Minimum deadline in seconds needed for this method. Calls having deadline
value lower than this will be rejected.
Corresponds to the JSON property minDeadline
477 478 479 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 477 def min_deadline @min_deadline end |
#operation_deadline ⇒ Float
The number of seconds to wait for the completion of a long running
operation. The default is no deadline.
Corresponds to the JSON property operationDeadline
483 484 485 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 483 def operation_deadline @operation_deadline end |
#path_translation ⇒ String
Corresponds to the JSON property pathTranslation
488 489 490 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 488 def path_translation @path_translation end |
#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.
Corresponds to the JSON property protocol
509 510 511 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 509 def protocol @protocol end |
#selector ⇒ String
Selects the methods to which this rule applies.
Refer to selector for syntax details.
Corresponds to the JSON property selector
515 516 517 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 515 def selector @selector end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
522 523 524 525 526 527 528 529 530 531 532 |
# File 'generated/google/apis/servicenetworking_v1/classes.rb', line 522 def update!(**args) @address = args[:address] if args.key?(:address) @deadline = args[:deadline] if args.key?(:deadline) @disable_auth = args[:disable_auth] if args.key?(:disable_auth) @jwt_audience = args[:jwt_audience] if args.key?(:jwt_audience) @min_deadline = args[:min_deadline] if args.key?(:min_deadline) @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @path_translation = args[:path_translation] if args.key?(:path_translation) @protocol = args[:protocol] if args.key?(:protocol) @selector = args[:selector] if args.key?(:selector) end |