Class: Google::Apis::ServicemanagementV1::LongRunning
- Inherits:
 - 
      Object
      
        
- Object
 - Google::Apis::ServicemanagementV1::LongRunning
 
 
- Includes:
 - Core::Hashable, Core::JsonObjectSupport
 
- Defined in:
 - lib/google/apis/servicemanagement_v1/classes.rb,
lib/google/apis/servicemanagement_v1/representations.rb,
lib/google/apis/servicemanagement_v1/representations.rb 
Overview
Describes settings to use when generating API methods that use the long- running operation pattern. All default values below are from those used in the client library generators (e.g. Java).
Instance Attribute Summary collapse
- 
  
    
      #initial_poll_delay  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Initial delay after which the first poll request will be made.
 - 
  
    
      #max_poll_delay  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Maximum time between two subsequent poll requests.
 - 
  
    
      #poll_delay_multiplier  ⇒ Float 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.
 - 
  
    
      #total_poll_timeout  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Total polling timeout.
 
Instance Method Summary collapse
- 
  
    
      #initialize(**args)  ⇒ LongRunning 
    
    
  
  
  
    constructor
  
  
  
  
  
  
  
    
A new instance of LongRunning.
 - 
  
    
      #update!(**args)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Update properties of this object.
 
Constructor Details
#initialize(**args) ⇒ LongRunning
Returns a new instance of LongRunning.
      2483 2484 2485  | 
    
      # File 'lib/google/apis/servicemanagement_v1/classes.rb', line 2483 def initialize(**args) update!(**args) end  | 
  
Instance Attribute Details
#initial_poll_delay ⇒ String
Initial delay after which the first poll request will be made. Default value:
5 seconds.
Corresponds to the JSON property initialPollDelay
      2465 2466 2467  | 
    
      # File 'lib/google/apis/servicemanagement_v1/classes.rb', line 2465 def initial_poll_delay @initial_poll_delay end  | 
  
#max_poll_delay ⇒ String
Maximum time between two subsequent poll requests. Default value: 45 seconds.
Corresponds to the JSON property maxPollDelay
      2470 2471 2472  | 
    
      # File 'lib/google/apis/servicemanagement_v1/classes.rb', line 2470 def max_poll_delay @max_poll_delay end  | 
  
#poll_delay_multiplier ⇒ Float
Multiplier to gradually increase delay between subsequent polls until it
reaches max_poll_delay. Default value: 1.5.
Corresponds to the JSON property pollDelayMultiplier
      2476 2477 2478  | 
    
      # File 'lib/google/apis/servicemanagement_v1/classes.rb', line 2476 def poll_delay_multiplier @poll_delay_multiplier end  | 
  
#total_poll_timeout ⇒ String
Total polling timeout. Default value: 5 minutes.
Corresponds to the JSON property totalPollTimeout
      2481 2482 2483  | 
    
      # File 'lib/google/apis/servicemanagement_v1/classes.rb', line 2481 def total_poll_timeout @total_poll_timeout end  | 
  
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
      2488 2489 2490 2491 2492 2493  | 
    
      # File 'lib/google/apis/servicemanagement_v1/classes.rb', line 2488 def update!(**args) @initial_poll_delay = args[:initial_poll_delay] if args.key?(:initial_poll_delay) @max_poll_delay = args[:max_poll_delay] if args.key?(:max_poll_delay) @poll_delay_multiplier = args[:poll_delay_multiplier] if args.key?(:poll_delay_multiplier) @total_poll_timeout = args[:total_poll_timeout] if args.key?(:total_poll_timeout) end  |