Class: Google::Apis::ServicemanagementV1::BackendRule

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

Overview

A backend rule provides configuration for an individual API element.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BackendRule

Returns a new instance of BackendRule.



529
530
531
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 529

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#address ⇒ String

The address of the API backend. Corresponds to the JSON property address

Returns:

  • (String) 


482
483
484
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 482

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) 


488
489
490
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 488

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) 


496
497
498
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 496

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) 


504
505
506
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 504

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

Returns:

  • (Float) 


510
511
512
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 510

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) 


516
517
518
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 516

def operation_deadline
  @operation_deadline
end

#path_translation ⇒ String

Corresponds to the JSON property pathTranslation

Returns:

  • (String) 


521
522
523
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 521

def path_translation
  @path_translation
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) 


527
528
529
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 527

def selector
  @selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



534
535
536
537
538
539
540
541
542
543
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 534

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)
  @selector = args[:selector] if args.key?(:selector)
end