class Google::Apis::ServicemanagementV1::BackendRule

A backend rule provides configuration for an individual API element.

Attributes

address[RW]

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` @return [String]

deadline[RW]

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` @return [Float]

disable_auth[RW]

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` @return [Boolean]

disable_auth?[RW]

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` @return [Boolean]

jwt_audience[RW]

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` @return [String]

operation_deadline[RW]

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` @return [Float]

path_translation[RW]

Corresponds to the JSON property `pathTranslation` @return [String]

protocol[RW]

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 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` @return [String]

selector[RW]

Selects the methods to which this rule applies. Refer to selector for syntax details. Corresponds to the JSON property `selector` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/servicemanagement_v1/classes.rb, line 478
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/servicemanagement_v1/classes.rb, line 483
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)
  @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