AlloyDB API - Module Google::Cloud::AlloyDB (v2.1.0)

Reference documentation and code samples for the AlloyDB API module Google::Cloud::AlloyDB.

  def 
  
 self 
 . 
 alloy_db_admin 
 ( 
 version 
 : 
  
 :v1 
 , 
  
 transport 
 : 
  
 :grpc 
 , 
  
& block 
 ) 
  
 - 
>  
 :: 
 Object 
 

Create a new client object for AlloyDBAdmin.

By default, this returns an instance of Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the AlloyDBAdmin service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the AlloyDBAdmin service. You can determine whether the method will succeed by calling AlloyDB.alloy_db_admin_available? .

About AlloyDBAdmin

Service describing handlers for resources

  def 
  
 self 
 . 
 alloy_db_admin_available? 
 ( 
 version 
 : 
  
 :v1 
 , 
  
 transport 
 : 
  
 :grpc 
 ) 
  
 - 
>  
 boolean 
 

Determines whether the AlloyDBAdmin service is supported by the current client. If true, you can retrieve a client object by calling AlloyDB.alloy_db_admin . If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the AlloyDBAdmin service, or if the versioned client gem needs an update to support the AlloyDBAdmin service.

  def 
  
 self 
 . 
 alloy_db_cloud_sql_admin 
 ( 
 version 
 : 
  
 :v1 
 , 
  
 transport 
 : 
  
 :grpc 
 , 
  
& block 
 ) 
  
 - 
>  
 :: 
 Object 
 

Create a new client object for AlloyDBCloudSQLAdmin.

By default, this returns an instance of Google::Cloud::AlloyDB::V1::AlloyDBCloudSQLAdmin::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the AlloyDBCloudSQLAdmin service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the AlloyDBCloudSQLAdmin service. You can determine whether the method will succeed by calling AlloyDB.alloy_db_cloud_sql_admin_available? .

About AlloyDBCloudSQLAdmin

Service for interactions with CloudSQL.

  def 
  
 self 
 . 
 alloy_db_cloud_sql_admin_available? 
 ( 
 version 
 : 
  
 :v1 
 , 
  
 transport 
 : 
  
 :grpc 
 ) 
  
 - 
>  
 boolean 
 

Determines whether the AlloyDBCloudSQLAdmin service is supported by the current client. If true, you can retrieve a client object by calling AlloyDB.alloy_db_cloud_sql_admin . If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the AlloyDBCloudSQLAdmin service, or if the versioned client gem needs an update to support the AlloyDBCloudSQLAdmin service.

  def 
  
 self 
 . 
 configure 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Cloud 
 :: 
 Config 
 

Configure the google-cloud-alloy_db library.

The following configuration parameters are supported:

• credentials ( type: String, Hash, Google::Auth::Credentials ) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
• lib_name ( type: String ) - The library name as recorded in instrumentation and logging.
• lib_version ( type: String ) - The library version as recorded in instrumentation and logging.
• interceptors ( type: Array<GRPC::ClientInterceptor> ) - An array of interceptors that are run before calls are executed.
• timeout ( type: Numeric ) - Default timeout in seconds.
• metadata ( type: Hash{Symbol=>String} ) - Additional headers to be sent with the call.
• retry_policy ( type: 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: "2.1.0"