Class: Google::Apis::ServiceusageV1::BackendRule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/serviceusage_v1/classes.rb,
lib/google/apis/serviceusage_v1/representations.rb,
lib/google/apis/serviceusage_v1/representations.rb

Overview

A backend rule provides configuration for an individual API element.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BackendRule

Returns a new instance of BackendRule.



457
458
459
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 457

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

Returns:

  • (String) 


398
399
400
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 398

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

Returns:

  • (Float) 


404
405
406
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 404

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

Returns:

  • (Boolean) 


412
413
414
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 412

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

Returns:

  • (String) 


420
421
422
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 420

def jwt_audience
  @jwt_audience
end

#min_deadline ⇒ Float

Deprecated, do not use. Corresponds to the JSON property minDeadline

Returns:

  • (Float) 


425
426
427
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 425

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

Returns:

  • (Float) 


431
432
433
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 431

def operation_deadline
  @operation_deadline
end

#path_translation ⇒ String

Corresponds to the JSON property pathTranslation

Returns:

  • (String) 


436
437
438
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 436

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

Returns:

  • (String) 


449
450
451
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 449

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

Returns:

  • (String) 


455
456
457
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 455

def selector
  @selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 462

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