Class: Google::Api::MethodSettings::LongRunning

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/client.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 Attribute Details

#initial_poll_delay ⇒ ::Google::Protobuf::Duration

Returns Initial delay after which the first poll request will be made. Default value: 5 seconds.

Returns:



381
382
383
384
 
# File 'proto_docs/google/api/client.rb', line 381

class LongRunning
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#max_poll_delay ⇒ ::Google::Protobuf::Duration

Returns Maximum time between two subsequent poll requests. Default value: 45 seconds.

Returns:



381
382
383
384
 
# File 'proto_docs/google/api/client.rb', line 381

class LongRunning
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#poll_delay_multiplier ⇒ ::Float

Returns Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.

Returns:

  • (::Float) —

    Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.



381
382
383
384
 
# File 'proto_docs/google/api/client.rb', line 381

class LongRunning
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#total_poll_timeout ⇒ ::Google::Protobuf::Duration

Returns Total polling timeout. Default value: 5 minutes.

Returns:



381
382
383
384
 
# File 'proto_docs/google/api/client.rb', line 381

class LongRunning
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end