Class: Google::Apis::ServiceusageV1::LongRunning

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

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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LongRunning

Returns a new instance of LongRunning.



2972
2973
2974
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 2972

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

Instance Attribute Details

#initial_poll_delayString

Initial delay after which the first poll request will be made. Default value: 5 seconds. Corresponds to the JSON property initialPollDelay

Returns:

  • (String)


2954
2955
2956
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 2954

def initial_poll_delay
  @initial_poll_delay
end

#max_poll_delayString

Maximum time between two subsequent poll requests. Default value: 45 seconds. Corresponds to the JSON property maxPollDelay

Returns:

  • (String)


2959
2960
2961
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 2959

def max_poll_delay
  @max_poll_delay
end

#poll_delay_multiplierFloat

Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5. Corresponds to the JSON property pollDelayMultiplier

Returns:

  • (Float)


2965
2966
2967
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 2965

def poll_delay_multiplier
  @poll_delay_multiplier
end

#total_poll_timeoutString

Total polling timeout. Default value: 5 minutes. Corresponds to the JSON property totalPollTimeout

Returns:

  • (String)


2970
2971
2972
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 2970

def total_poll_timeout
  @total_poll_timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2977
2978
2979
2980
2981
2982
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 2977

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