- 0.48.0 (latest)
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::EndpointService::Operations::Configuration.
Configuration class for the Operations API.
This class represents the configuration for Operations, providing control over timeouts, retry behavior, logging, transport parameters, and other low-level controls. Certain parameters can also be applied individually to specific RPCs. See Longrunning::Operations::Client::Configuration::Rpcs for a list of RPCs that can be configured independently.
Configuration can be applied globally to all clients, or to a single client on construction.
Inherits
- Object
Extended By
- Gapic::Config
Example
# Modify the global config, setting the timeout for # list_operations to 20 seconds, # and all remaining timeouts to 10 seconds. ::Google::Longrunning::Operations::Client.configure do |config| config.timeout = 10.0 config.rpcs.list_operations.timeout = 20.0 end # Apply the above configuration only to a new client. client = ::Google::Longrunning::Operations::Client.new do |config| config.timeout = 10.0 config.rpcs.list_operations.timeout = 20.0 end
Methods
#channel_args
def channel_args() -> ::Hash
Extra parameters passed to the gRPC channel. Note: this is ignored if a
GRPC::Core::Channel
object is provided as the credential.
- (::Hash)
#channel_args=
def channel_args=(value) -> ::Hash
Extra parameters passed to the gRPC channel. Note: this is ignored if a
GRPC::Core::Channel
object is provided as the credential.
- value (::Hash)
- (::Hash)
#credentials
def credentials() -> ::Object
Credentials to send with calls. You may provide any of the following types:
- (
String
) The path to a service account key file in JSON format - (
Hash
) A service account key as a Hash - (
Google::Auth::Credentials
) A googleauth credentials object (see the googleauth docs) - (
Signet::OAuth2::Client
) A signet oauth2 client object (see the signet docs) - (
GRPC::Core::Channel
) a gRPC channel with included credentials - (
GRPC::Core::ChannelCredentials
) a gRPC credentails object - (
nil
) indicating no credentials
- (::Object)
#credentials=
def credentials=(value) -> ::Object
Credentials to send with calls. You may provide any of the following types:
- (
String
) The path to a service account key file in JSON format - (
Hash
) A service account key as a Hash - (
Google::Auth::Credentials
) A googleauth credentials object (see the googleauth docs) - (
Signet::OAuth2::Client
) A signet oauth2 client object (see the signet docs) - (
GRPC::Core::Channel
) a gRPC channel with included credentials - (
GRPC::Core::ChannelCredentials
) a gRPC credentails object - (
nil
) indicating no credentials
- value (::Object)
- (::Object)
#endpoint
def endpoint() -> ::String
The hostname or hostname:port of the service endpoint.
Defaults to "aiplatform.googleapis.com"
.
- (::String)
#endpoint=
def endpoint=(value) -> ::String
The hostname or hostname:port of the service endpoint.
Defaults to "aiplatform.googleapis.com"
.
- value (::String)
- (::String)
#interceptors
def interceptors() -> ::Array<::GRPC::ClientInterceptor>
An array of interceptors that are run before calls are executed.
- (::Array<::GRPC::ClientInterceptor>)
#interceptors=
def interceptors=(value) -> ::Array<::GRPC::ClientInterceptor>
An array of interceptors that are run before calls are executed.
- value (::Array<::GRPC::ClientInterceptor>)
- (::Array<::GRPC::ClientInterceptor>)
#lib_name
def lib_name() -> ::String
The library name as recorded in instrumentation and logging
- (::String)
#lib_name=
def lib_name=(value) -> ::String
The library name as recorded in instrumentation and logging
- value (::String)
- (::String)
#lib_version
def lib_version() -> ::String
The library version as recorded in instrumentation and logging
- (::String)
#lib_version=
def lib_version=(value) -> ::String
The library version as recorded in instrumentation and logging
- value (::String)
- (::String)
#metadata
def metadata() -> ::Hash{::Symbol=>::String}
Additional gRPC headers to be sent with the call.
- (::Hash{::Symbol=>::String})
#metadata=
def metadata=(value) -> ::Hash{::Symbol=>::String}
Additional gRPC headers to be sent with the call.
- value (::Hash{::Symbol=>::String})
- (::Hash{::Symbol=>::String})
#quota_project
def quota_project() -> ::String
A separate project against which to charge quota.
- (::String)
#quota_project=
def quota_project=(value) -> ::String
A separate project against which to charge quota.
- value (::String)
- (::String)
#retry_policy
def retry_policy() -> ::Hash
The retry policy. The value is a hash with the following keys:
-
:initial_delay
(type:Numeric
) - The initial delay in seconds. -
:max_delay
(type:Numeric
) - The max delay in seconds. -
:multiplier
(type:Numeric
) - The incremental backoff multiplier. -
:retry_codes
(type:Array<String>
) - The error codes that should trigger a retry.
- (::Hash)
#retry_policy=
def retry_policy=(value) -> ::Hash
The retry policy. The value is a hash with the following keys:
-
:initial_delay
(type:Numeric
) - The initial delay in seconds. -
:max_delay
(type:Numeric
) - The max delay in seconds. -
:multiplier
(type:Numeric
) - The incremental backoff multiplier. -
:retry_codes
(type:Array<String>
) - The error codes that should trigger a retry.
- value (::Hash)
- (::Hash)
#rpcs
def rpcs() -> Rpcs
Configurations for individual RPCs
- (Rpcs)
#scope
def scope() -> ::Array<::String>
The OAuth scopes
- (::Array<::String>)
#scope=
def scope=(value) -> ::Array<::String>
The OAuth scopes
- value (::Array<::String>)
- (::Array<::String>)
#timeout
def timeout() -> ::Numeric
The call timeout in seconds.
- (::Numeric)
#timeout=
def timeout=(value) -> ::Numeric
The call timeout in seconds.
- value (::Numeric)
- (::Numeric)
Constants
DEFAULT_ENDPOINT
value: "aiplatform.googleapis.com"