Vertex AI V1 API - Class Google::Api::MethodSettings::LongRunning (v0.47.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Api::MethodSettings::LongRunning.

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).

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#initial_poll_delay

def initial_poll_delay() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::Duration) — Initial delay after which the first poll request will be made. Default value: 5 seconds.

#initial_poll_delay=

def initial_poll_delay=(value) -> ::Google::Protobuf::Duration

Parameter

value (::Google::Protobuf::Duration) — Initial delay after which the first poll request will be made. Default value: 5 seconds.

Returns

(::Google::Protobuf::Duration) — Initial delay after which the first poll request will be made. Default value: 5 seconds.

#max_poll_delay

def max_poll_delay() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::Duration) — Maximum time between two subsequent poll requests. Default value: 45 seconds.

#max_poll_delay=

def max_poll_delay=(value) -> ::Google::Protobuf::Duration

Parameter

value (::Google::Protobuf::Duration) — Maximum time between two subsequent poll requests. Default value: 45 seconds.

Returns

(::Google::Protobuf::Duration) — Maximum time between two subsequent poll requests. Default value: 45 seconds.

#poll_delay_multiplier

def poll_delay_multiplier() -> ::Float

Returns

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

#poll_delay_multiplier=

def poll_delay_multiplier=(value) -> ::Float

Parameter

value (::Float) — 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.

#total_poll_timeout

def total_poll_timeout() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::Duration) — Total polling timeout. Default value: 5 minutes.

#total_poll_timeout=

def total_poll_timeout=(value) -> ::Google::Protobuf::Duration

Parameter

value (::Google::Protobuf::Duration) — Total polling timeout. Default value: 5 minutes.

Returns

(::Google::Protobuf::Duration) — Total polling timeout. Default value: 5 minutes.