Class: Google::Apis::ServiceusageV1::LongRunning
- Inherits:
-
Object
- Object
- Google::Apis::ServiceusageV1::LongRunning
- 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
-
#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.
3497 3498 3499 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3497 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
3479 3480 3481 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3479 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
3484 3485 3486 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3484 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
3490 3491 3492 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3490 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
3495 3496 3497 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3495 def total_poll_timeout @total_poll_timeout end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3502 3503 3504 3505 3506 3507 |
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 3502 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 |