Oracle Database@Google Cloud V1 API - Class Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client (v0.11.0)

Reference documentation and code samples for the Oracle Database@Google Cloud V1 API class Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.

REST client for the OracleDatabase service.

Service describing handlers for resources

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the OracleDatabase Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all OracleDatabase clients
::Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the OracleDatabase Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_autonomous_database

def create_autonomous_database(request, options = nil) -> ::Gapic::Operation
def create_autonomous_database(parent: nil, autonomous_database_id: nil, autonomous_database: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Autonomous Database in a given project and location.

Overloads 
def create_autonomous_database(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_autonomous_database via a request object, either of type CreateAutonomousDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::CreateAutonomousDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_autonomous_database(parent: nil, autonomous_database_id: nil, autonomous_database: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_autonomous_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent in the following format: projects/{project}/locations/{location}.
  • autonomous_database_id (::String) — Required. The ID of the Autonomous Database to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
  • autonomous_database (::Google::Cloud::OracleDatabase::V1::AutonomousDatabase, ::Hash) — Required. The Autonomous Database being created.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::CreateAutonomousDatabaseRequest.new

# Call the create_autonomous_database method.
result = client.create_autonomous_database request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_cloud_exadata_infrastructure

def create_cloud_exadata_infrastructure(request, options = nil) -> ::Gapic::Operation
def create_cloud_exadata_infrastructure(parent: nil, cloud_exadata_infrastructure_id: nil, cloud_exadata_infrastructure: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Exadata Infrastructure in a given project and location.

Overloads 
def create_cloud_exadata_infrastructure(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_cloud_exadata_infrastructure via a request object, either of type CreateCloudExadataInfrastructureRequest or an equivalent Hash.
Parameters 
def create_cloud_exadata_infrastructure(parent: nil, cloud_exadata_infrastructure_id: nil, cloud_exadata_infrastructure: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_cloud_exadata_infrastructure via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.
  • cloud_exadata_infrastructure_id (::String) — Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
  • cloud_exadata_infrastructure (::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure, ::Hash) — Required. Details of the Exadata Infrastructure instance to create.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::CreateCloudExadataInfrastructureRequest.new

# Call the create_cloud_exadata_infrastructure method.
result = client.create_cloud_exadata_infrastructure request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_cloud_vm_cluster

def create_cloud_vm_cluster(request, options = nil) -> ::Gapic::Operation
def create_cloud_vm_cluster(parent: nil, cloud_vm_cluster_id: nil, cloud_vm_cluster: nil, request_id: nil) -> ::Gapic::Operation

Creates a new VM Cluster in a given project and location.

Overloads 
def create_cloud_vm_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_cloud_vm_cluster via a request object, either of type CreateCloudVmClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::CreateCloudVmClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_cloud_vm_cluster(parent: nil, cloud_vm_cluster_id: nil, cloud_vm_cluster: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_cloud_vm_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent in the following format: projects/{project}/locations/{location}.
  • cloud_vm_cluster_id (::String) — Required. The ID of the VM Cluster to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
  • cloud_vm_cluster (::Google::Cloud::OracleDatabase::V1::CloudVmCluster, ::Hash) — Required. The resource being created
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::CreateCloudVmClusterRequest.new

# Call the create_cloud_vm_cluster method.
result = client.create_cloud_vm_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_db_system

def create_db_system(request, options = nil) -> ::Gapic::Operation
def create_db_system(parent: nil, db_system_id: nil, db_system: nil, request_id: nil) -> ::Gapic::Operation

Creates a new DbSystem in a given project and location.

Overloads 
def create_db_system(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_db_system via a request object, either of type CreateDbSystemRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::CreateDbSystemRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_db_system(parent: nil, db_system_id: nil, db_system: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_db_system via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The value for parent of the DbSystem in the following format: projects/{project}/locations/{location}.
  • db_system_id (::String) — Required. The ID of the DbSystem to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
  • db_system (::Google::Cloud::OracleDatabase::V1::DbSystem, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::CreateDbSystemRequest.new

# Call the create_db_system method.
result = client.create_db_system request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_exadb_vm_cluster

def create_exadb_vm_cluster(request, options = nil) -> ::Gapic::Operation
def create_exadb_vm_cluster(parent: nil, exadb_vm_cluster_id: nil, exadb_vm_cluster: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Exadb (Exascale) VM Cluster resource.

Overloads 
def create_exadb_vm_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_exadb_vm_cluster via a request object, either of type CreateExadbVmClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::CreateExadbVmClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_exadb_vm_cluster(parent: nil, exadb_vm_cluster_id: nil, exadb_vm_cluster: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_exadb_vm_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The value for parent of the ExadbVmCluster in the following format: projects/{project}/locations/{location}.
  • exadb_vm_cluster_id (::String) — Required. The ID of the ExadbVmCluster to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
  • exadb_vm_cluster (::Google::Cloud::OracleDatabase::V1::ExadbVmCluster, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::CreateExadbVmClusterRequest.new

# Call the create_exadb_vm_cluster method.
result = client.create_exadb_vm_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_exascale_db_storage_vault

def create_exascale_db_storage_vault(request, options = nil) -> ::Gapic::Operation
def create_exascale_db_storage_vault(parent: nil, exascale_db_storage_vault_id: nil, exascale_db_storage_vault: nil, request_id: nil) -> ::Gapic::Operation

Creates a new ExascaleDB Storage Vault resource.

Overloads 
def create_exascale_db_storage_vault(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_exascale_db_storage_vault via a request object, either of type CreateExascaleDbStorageVaultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::CreateExascaleDbStorageVaultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_exascale_db_storage_vault(parent: nil, exascale_db_storage_vault_id: nil, exascale_db_storage_vault: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_exascale_db_storage_vault via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.
  • exascale_db_storage_vault_id (::String) — Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
  • exascale_db_storage_vault (::Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::CreateExascaleDbStorageVaultRequest.new

# Call the create_exascale_db_storage_vault method.
result = client.create_exascale_db_storage_vault request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_odb_network

def create_odb_network(request, options = nil) -> ::Gapic::Operation
def create_odb_network(parent: nil, odb_network_id: nil, odb_network: nil, request_id: nil) -> ::Gapic::Operation

Creates a new ODB Network in a given project and location.

Overloads 
def create_odb_network(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_odb_network via a request object, either of type CreateOdbNetworkRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::CreateOdbNetworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_odb_network(parent: nil, odb_network_id: nil, odb_network: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_odb_network via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.
  • odb_network_id (::String) — Required. The ID of the OdbNetwork to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
  • odb_network (::Google::Cloud::OracleDatabase::V1::OdbNetwork, ::Hash) — Required. Details of the OdbNetwork instance to create.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::CreateOdbNetworkRequest.new

# Call the create_odb_network method.
result = client.create_odb_network request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_odb_subnet

def create_odb_subnet(request, options = nil) -> ::Gapic::Operation
def create_odb_subnet(parent: nil, odb_subnet_id: nil, odb_subnet: nil, request_id: nil) -> ::Gapic::Operation

Creates a new ODB Subnet in a given ODB Network.

Overloads 
def create_odb_subnet(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_odb_subnet via a request object, either of type CreateOdbSubnetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::CreateOdbSubnetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_odb_subnet(parent: nil, odb_subnet_id: nil, odb_subnet: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_odb_subnet via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.
  • odb_subnet_id (::String) — Required. The ID of the OdbSubnet to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
  • odb_subnet (::Google::Cloud::OracleDatabase::V1::OdbSubnet, ::Hash) — Required. Details of the OdbSubnet instance to create.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::CreateOdbSubnetRequest.new

# Call the create_odb_subnet method.
result = client.create_odb_subnet request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_autonomous_database

def delete_autonomous_database(request, options = nil) -> ::Gapic::Operation
def delete_autonomous_database(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single Autonomous Database.

Overloads 
def delete_autonomous_database(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_autonomous_database via a request object, either of type DeleteAutonomousDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::DeleteAutonomousDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_autonomous_database(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_autonomous_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the resource in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::DeleteAutonomousDatabaseRequest.new

# Call the delete_autonomous_database method.
result = client.delete_autonomous_database request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_cloud_exadata_infrastructure

def delete_cloud_exadata_infrastructure(request, options = nil) -> ::Gapic::Operation
def delete_cloud_exadata_infrastructure(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation

Deletes a single Exadata Infrastructure.

Overloads 
def delete_cloud_exadata_infrastructure(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_cloud_exadata_infrastructure via a request object, either of type DeleteCloudExadataInfrastructureRequest or an equivalent Hash.
Parameters 
def delete_cloud_exadata_infrastructure(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_cloud_exadata_infrastructure via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • force (::Boolean) — Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::DeleteCloudExadataInfrastructureRequest.new

# Call the delete_cloud_exadata_infrastructure method.
result = client.delete_cloud_exadata_infrastructure request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_cloud_vm_cluster

def delete_cloud_vm_cluster(request, options = nil) -> ::Gapic::Operation
def delete_cloud_vm_cluster(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation

Deletes a single VM Cluster.

Overloads 
def delete_cloud_vm_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_cloud_vm_cluster via a request object, either of type DeleteCloudVmClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::DeleteCloudVmClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_cloud_vm_cluster(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_cloud_vm_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • force (::Boolean) — Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::DeleteCloudVmClusterRequest.new

# Call the delete_cloud_vm_cluster method.
result = client.delete_cloud_vm_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_db_system

def delete_db_system(request, options = nil) -> ::Gapic::Operation
def delete_db_system(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single DbSystem.

Overloads 
def delete_db_system(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_db_system via a request object, either of type DeleteDbSystemRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::DeleteDbSystemRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_db_system(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_db_system via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::DeleteDbSystemRequest.new

# Call the delete_db_system method.
result = client.delete_db_system request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_exadb_vm_cluster

def delete_exadb_vm_cluster(request, options = nil) -> ::Gapic::Operation
def delete_exadb_vm_cluster(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single Exadb (Exascale) VM Cluster.

Overloads 
def delete_exadb_vm_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_exadb_vm_cluster via a request object, either of type DeleteExadbVmClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::DeleteExadbVmClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_exadb_vm_cluster(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_exadb_vm_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::DeleteExadbVmClusterRequest.new

# Call the delete_exadb_vm_cluster method.
result = client.delete_exadb_vm_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_exascale_db_storage_vault

def delete_exascale_db_storage_vault(request, options = nil) -> ::Gapic::Operation
def delete_exascale_db_storage_vault(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single ExascaleDB Storage Vault.

Overloads 
def delete_exascale_db_storage_vault(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_exascale_db_storage_vault via a request object, either of type DeleteExascaleDbStorageVaultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::DeleteExascaleDbStorageVaultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_exascale_db_storage_vault(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_exascale_db_storage_vault via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::DeleteExascaleDbStorageVaultRequest.new

# Call the delete_exascale_db_storage_vault method.
result = client.delete_exascale_db_storage_vault request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_odb_network

def delete_odb_network(request, options = nil) -> ::Gapic::Operation
def delete_odb_network(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single ODB Network.

Overloads 
def delete_odb_network(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_odb_network via a request object, either of type DeleteOdbNetworkRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::DeleteOdbNetworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_odb_network(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_odb_network via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::DeleteOdbNetworkRequest.new

# Call the delete_odb_network method.
result = client.delete_odb_network request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_odb_subnet

def delete_odb_subnet(request, options = nil) -> ::Gapic::Operation
def delete_odb_subnet(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single ODB Subnet.

Overloads 
def delete_odb_subnet(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_odb_subnet via a request object, either of type DeleteOdbSubnetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::DeleteOdbSubnetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_odb_subnet(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_odb_subnet via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::DeleteOdbSubnetRequest.new

# Call the delete_odb_subnet method.
result = client.delete_odb_subnet request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#failover_autonomous_database

def failover_autonomous_database(request, options = nil) -> ::Gapic::Operation
def failover_autonomous_database(name: nil, peer_autonomous_database: nil) -> ::Gapic::Operation

Initiates a failover to target autonomous database from the associated primary database.

Overloads 
def failover_autonomous_database(request, options = nil) -> ::Gapic::Operation
Pass arguments to failover_autonomous_database via a request object, either of type FailoverAutonomousDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::FailoverAutonomousDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def failover_autonomous_database(name: nil, peer_autonomous_database: nil) -> ::Gapic::Operation
Pass arguments to failover_autonomous_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
  • peer_autonomous_database (::String) — Required. The peer database name to fail over to.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::FailoverAutonomousDatabaseRequest.new

# Call the failover_autonomous_database method.
result = client.failover_autonomous_database request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#generate_autonomous_database_wallet

def generate_autonomous_database_wallet(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponse
def generate_autonomous_database_wallet(name: nil, type: nil, is_regional: nil, password: nil) -> ::Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponse

Generates a wallet for an Autonomous Database.

Overloads 
def generate_autonomous_database_wallet(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponse
Pass arguments to generate_autonomous_database_wallet via a request object, either of type GenerateAutonomousDatabaseWalletRequest or an equivalent Hash.
Parameters 
def generate_autonomous_database_wallet(name: nil, type: nil, is_regional: nil, password: nil) -> ::Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponse
Pass arguments to generate_autonomous_database_wallet via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
  • type (::Google::Cloud::OracleDatabase::V1::GenerateType) — Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE.
  • is_regional (::Boolean) — Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only.
  • password (::String) — Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletRequest.new

# Call the generate_autonomous_database_wallet method.
result = client.generate_autonomous_database_wallet request

# The returned object is of type Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponse.
p result

#get_autonomous_database

def get_autonomous_database(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::AutonomousDatabase
def get_autonomous_database(name: nil) -> ::Google::Cloud::OracleDatabase::V1::AutonomousDatabase

Gets the details of a single Autonomous Database.

Overloads 
def get_autonomous_database(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::AutonomousDatabase
Pass arguments to get_autonomous_database via a request object, either of type GetAutonomousDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::GetAutonomousDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_autonomous_database(name: nil) -> ::Google::Cloud::OracleDatabase::V1::AutonomousDatabase
Pass arguments to get_autonomous_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GetAutonomousDatabaseRequest.new

# Call the get_autonomous_database method.
result = client.get_autonomous_database request

# The returned object is of type Google::Cloud::OracleDatabase::V1::AutonomousDatabase.
p result

#get_cloud_exadata_infrastructure

def get_cloud_exadata_infrastructure(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure
def get_cloud_exadata_infrastructure(name: nil) -> ::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure

Gets details of a single Exadata Infrastructure.

Overloads 
def get_cloud_exadata_infrastructure(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure
Pass arguments to get_cloud_exadata_infrastructure via a request object, either of type GetCloudExadataInfrastructureRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::GetCloudExadataInfrastructureRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_cloud_exadata_infrastructure(name: nil) -> ::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure
Pass arguments to get_cloud_exadata_infrastructure via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GetCloudExadataInfrastructureRequest.new

# Call the get_cloud_exadata_infrastructure method.
result = client.get_cloud_exadata_infrastructure request

# The returned object is of type Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure.
p result

#get_cloud_vm_cluster

def get_cloud_vm_cluster(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::CloudVmCluster
def get_cloud_vm_cluster(name: nil) -> ::Google::Cloud::OracleDatabase::V1::CloudVmCluster

Gets details of a single VM Cluster.

Overloads 
def get_cloud_vm_cluster(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::CloudVmCluster
Pass arguments to get_cloud_vm_cluster via a request object, either of type GetCloudVmClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::GetCloudVmClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_cloud_vm_cluster(name: nil) -> ::Google::Cloud::OracleDatabase::V1::CloudVmCluster
Pass arguments to get_cloud_vm_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GetCloudVmClusterRequest.new

# Call the get_cloud_vm_cluster method.
result = client.get_cloud_vm_cluster request

# The returned object is of type Google::Cloud::OracleDatabase::V1::CloudVmCluster.
p result

#get_database

def get_database(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::Database
def get_database(name: nil) -> ::Google::Cloud::OracleDatabase::V1::Database

Gets details of a single Database.

Overloads 
def get_database(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::Database
Pass arguments to get_database via a request object, either of type GetDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::GetDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_database(name: nil) -> ::Google::Cloud::OracleDatabase::V1::Database
Pass arguments to get_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GetDatabaseRequest.new

# Call the get_database method.
result = client.get_database request

# The returned object is of type Google::Cloud::OracleDatabase::V1::Database.
p result

#get_db_system

def get_db_system(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::DbSystem
def get_db_system(name: nil) -> ::Google::Cloud::OracleDatabase::V1::DbSystem

Gets details of a single DbSystem.

Overloads 
def get_db_system(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::DbSystem
Pass arguments to get_db_system via a request object, either of type GetDbSystemRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::GetDbSystemRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_db_system(name: nil) -> ::Google::Cloud::OracleDatabase::V1::DbSystem
Pass arguments to get_db_system via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GetDbSystemRequest.new

# Call the get_db_system method.
result = client.get_db_system request

# The returned object is of type Google::Cloud::OracleDatabase::V1::DbSystem.
p result

#get_exadb_vm_cluster

def get_exadb_vm_cluster(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::ExadbVmCluster
def get_exadb_vm_cluster(name: nil) -> ::Google::Cloud::OracleDatabase::V1::ExadbVmCluster

Gets details of a single Exadb (Exascale) VM Cluster.

Overloads 
def get_exadb_vm_cluster(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::ExadbVmCluster
Pass arguments to get_exadb_vm_cluster via a request object, either of type GetExadbVmClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::GetExadbVmClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_exadb_vm_cluster(name: nil) -> ::Google::Cloud::OracleDatabase::V1::ExadbVmCluster
Pass arguments to get_exadb_vm_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GetExadbVmClusterRequest.new

# Call the get_exadb_vm_cluster method.
result = client.get_exadb_vm_cluster request

# The returned object is of type Google::Cloud::OracleDatabase::V1::ExadbVmCluster.
p result

#get_exascale_db_storage_vault

def get_exascale_db_storage_vault(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault
def get_exascale_db_storage_vault(name: nil) -> ::Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault

Gets details of a single ExascaleDB Storage Vault.

Overloads 
def get_exascale_db_storage_vault(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault
Pass arguments to get_exascale_db_storage_vault via a request object, either of type GetExascaleDbStorageVaultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::GetExascaleDbStorageVaultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_exascale_db_storage_vault(name: nil) -> ::Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault
Pass arguments to get_exascale_db_storage_vault via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GetExascaleDbStorageVaultRequest.new

# Call the get_exascale_db_storage_vault method.
result = client.get_exascale_db_storage_vault request

# The returned object is of type Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault.
p result

#get_odb_network

def get_odb_network(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::OdbNetwork
def get_odb_network(name: nil) -> ::Google::Cloud::OracleDatabase::V1::OdbNetwork

Gets details of a single ODB Network.

Overloads 
def get_odb_network(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::OdbNetwork
Pass arguments to get_odb_network via a request object, either of type GetOdbNetworkRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::GetOdbNetworkRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_odb_network(name: nil) -> ::Google::Cloud::OracleDatabase::V1::OdbNetwork
Pass arguments to get_odb_network via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GetOdbNetworkRequest.new

# Call the get_odb_network method.
result = client.get_odb_network request

# The returned object is of type Google::Cloud::OracleDatabase::V1::OdbNetwork.
p result

#get_odb_subnet

def get_odb_subnet(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::OdbSubnet
def get_odb_subnet(name: nil) -> ::Google::Cloud::OracleDatabase::V1::OdbSubnet

Gets details of a single ODB Subnet.

Overloads 
def get_odb_subnet(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::OdbSubnet
Pass arguments to get_odb_subnet via a request object, either of type GetOdbSubnetRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::GetOdbSubnetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_odb_subnet(name: nil) -> ::Google::Cloud::OracleDatabase::V1::OdbSubnet
Pass arguments to get_odb_subnet via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GetOdbSubnetRequest.new

# Call the get_odb_subnet method.
result = client.get_odb_subnet request

# The returned object is of type Google::Cloud::OracleDatabase::V1::OdbSubnet.
p result

#get_pluggable_database

def get_pluggable_database(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::PluggableDatabase
def get_pluggable_database(name: nil) -> ::Google::Cloud::OracleDatabase::V1::PluggableDatabase

Gets details of a single PluggableDatabase.

Overloads 
def get_pluggable_database(request, options = nil) -> ::Google::Cloud::OracleDatabase::V1::PluggableDatabase
Pass arguments to get_pluggable_database via a request object, either of type GetPluggableDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::GetPluggableDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_pluggable_database(name: nil) -> ::Google::Cloud::OracleDatabase::V1::PluggableDatabase
Pass arguments to get_pluggable_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::GetPluggableDatabaseRequest.new

# Call the get_pluggable_database method.
result = client.get_pluggable_database request

# The returned object is of type Google::Cloud::OracleDatabase::V1::PluggableDatabase.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new OracleDatabase REST client object.

Yields
  • (config) — Configure the OracleDatabase client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_autonomous_database_backups

def list_autonomous_database_backups(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup>
def list_autonomous_database_backups(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup>

Lists the long-term and automatic backups of an Autonomous Database.

Overloads 
def list_autonomous_database_backups(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup>
Pass arguments to list_autonomous_database_backups via a request object, either of type ListAutonomousDatabaseBackupsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListAutonomousDatabaseBackupsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_autonomous_database_backups(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup>
Pass arguments to list_autonomous_database_backups via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project}/locations/{location}.
  • filter (::String) — Optional. An expression for filtering the results of the request. Only the autonomous_database_id field is supported in the following format: autonomous_database_id="{autonomous_database_id}". The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^a-z?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListAutonomousDatabaseBackupsRequest.new

# Call the list_autonomous_database_backups method.
result = client.list_autonomous_database_backups request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup.
  p item
end

#list_autonomous_database_character_sets

def list_autonomous_database_character_sets(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet>
def list_autonomous_database_character_sets(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet>

Lists Autonomous Database Character Sets in a given project and location.

Overloads 
def list_autonomous_database_character_sets(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet>
Pass arguments to list_autonomous_database_character_sets via a request object, either of type ListAutonomousDatabaseCharacterSetsRequest or an equivalent Hash.
Parameters 
def list_autonomous_database_character_sets(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet>
Pass arguments to list_autonomous_database_character_sets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. An expression for filtering the results of the request. Only the character_set_type field is supported in the following format: character_set_type="{characterSetType}". Accepted values include DATABASE and NATIONAL.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListAutonomousDatabaseCharacterSetsRequest.new

# Call the list_autonomous_database_character_sets method.
result = client.list_autonomous_database_character_sets request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet.
  p item
end

#list_autonomous_databases

def list_autonomous_databases(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabase>
def list_autonomous_databases(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabase>

Lists the Autonomous Databases in a given project and location.

Overloads 
def list_autonomous_databases(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabase>
Pass arguments to list_autonomous_databases via a request object, either of type ListAutonomousDatabasesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListAutonomousDatabasesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_autonomous_databases(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabase>
Pass arguments to list_autonomous_databases via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. An expression for filtering the results of the request.
  • order_by (::String) — Optional. An expression for ordering the results of the request.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListAutonomousDatabasesRequest.new

# Call the list_autonomous_databases method.
result = client.list_autonomous_databases request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::AutonomousDatabase.
  p item
end

#list_autonomous_db_versions

def list_autonomous_db_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion>
def list_autonomous_db_versions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion>

Lists all the available Autonomous Database versions for a project and location.

Overloads 
def list_autonomous_db_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion>
Pass arguments to list_autonomous_db_versions via a request object, either of type ListAutonomousDbVersionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListAutonomousDbVersionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_autonomous_db_versions(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion>
Pass arguments to list_autonomous_db_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListAutonomousDbVersionsRequest.new

# Call the list_autonomous_db_versions method.
result = client.list_autonomous_db_versions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion.
  p item
end

#list_cloud_exadata_infrastructures

def list_cloud_exadata_infrastructures(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure>
def list_cloud_exadata_infrastructures(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure>

Lists Exadata Infrastructures in a given project and location.

Overloads 
def list_cloud_exadata_infrastructures(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure>
Pass arguments to list_cloud_exadata_infrastructures via a request object, either of type ListCloudExadataInfrastructuresRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListCloudExadataInfrastructuresRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_cloud_exadata_infrastructures(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure>
Pass arguments to list_cloud_exadata_infrastructures via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. An expression for filtering the results of the request.
  • order_by (::String) — Optional. An expression for ordering the results of the request.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListCloudExadataInfrastructuresRequest.new

# Call the list_cloud_exadata_infrastructures method.
result = client.list_cloud_exadata_infrastructures request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure.
  p item
end

#list_cloud_vm_clusters

def list_cloud_vm_clusters(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudVmCluster>
def list_cloud_vm_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudVmCluster>

Lists the VM Clusters in a given project and location.

Overloads 
def list_cloud_vm_clusters(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudVmCluster>
Pass arguments to list_cloud_vm_clusters via a request object, either of type ListCloudVmClustersRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListCloudVmClustersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_cloud_vm_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudVmCluster>
Pass arguments to list_cloud_vm_clusters via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The name of the parent in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000.
  • page_token (::String) — Optional. A token identifying the page of results the server returns.
  • filter (::String) — Optional. An expression for filtering the results of the request.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListCloudVmClustersRequest.new

# Call the list_cloud_vm_clusters method.
result = client.list_cloud_vm_clusters request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::CloudVmCluster.
  p item
end

#list_database_character_sets

def list_database_character_sets(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DatabaseCharacterSet>
def list_database_character_sets(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DatabaseCharacterSet>

List DatabaseCharacterSets for the given project and location.

Overloads 
def list_database_character_sets(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DatabaseCharacterSet>
Pass arguments to list_database_character_sets via a request object, either of type ListDatabaseCharacterSetsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListDatabaseCharacterSetsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_database_character_sets(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DatabaseCharacterSet>
Pass arguments to list_database_character_sets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for DatabaseCharacterSets in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of DatabaseCharacterSets to return. The service may return fewer than this value. If unspecified, at most 50 DatabaseCharacterSets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A page token, received from a previous ListDatabaseCharacterSets call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListDatabaseCharacterSets must match the call that provided the page token.

  • filter (::String) — Optional. An expression for filtering the results of the request. Only the character_set_type field is supported in the following format: character_set_type="{characterSetType}". Accepted values include DATABASE and NATIONAL.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListDatabaseCharacterSetsRequest.new

# Call the list_database_character_sets method.
result = client.list_database_character_sets request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::DatabaseCharacterSet.
  p item
end

#list_databases

def list_databases(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Database>
def list_databases(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Database>

Lists all the Databases for the given project, location and DbSystem.

Overloads 
def list_databases(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Database>
Pass arguments to list_databases via a request object, either of type ListDatabasesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListDatabasesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_databases(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Database>
Pass arguments to list_databases via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource name in the following format: projects/{project}/locations/{region}
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.
  • page_token (::String) — Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.
  • filter (::String) — Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: dbSystem="projects/{project}/locations/{location}/dbSystems/{dbSystemId}"
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListDatabasesRequest.new

# Call the list_databases method.
result = client.list_databases request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::Database.
  p item
end

#list_db_nodes

def list_db_nodes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbNode>
def list_db_nodes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbNode>

Lists the database nodes of a VM Cluster.

Overloads 
def list_db_nodes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbNode>
Pass arguments to list_db_nodes via a request object, either of type ListDbNodesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListDbNodesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_db_nodes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbNode>
Pass arguments to list_db_nodes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}. .
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the node should return.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListDbNodesRequest.new

# Call the list_db_nodes method.
result = client.list_db_nodes request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::DbNode.
  p item
end

#list_db_servers

def list_db_servers(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbServer>
def list_db_servers(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbServer>

Lists the database servers of an Exadata Infrastructure instance.

Overloads 
def list_db_servers(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbServer>
Pass arguments to list_db_servers via a request object, either of type ListDbServersRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListDbServersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_db_servers(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbServer>
Pass arguments to list_db_servers via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for database server in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloudExadataInfrastructure}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListDbServersRequest.new

# Call the list_db_servers method.
result = client.list_db_servers request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::DbServer.
  p item
end

#list_db_system_initial_storage_sizes

def list_db_system_initial_storage_sizes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemInitialStorageSize>
def list_db_system_initial_storage_sizes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemInitialStorageSize>

Lists all the DbSystemInitialStorageSizes for the given project and location.

Overloads 
def list_db_system_initial_storage_sizes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemInitialStorageSize>
Pass arguments to list_db_system_initial_storage_sizes via a request object, either of type ListDbSystemInitialStorageSizesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListDbSystemInitialStorageSizesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_db_system_initial_storage_sizes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemInitialStorageSize>
Pass arguments to list_db_system_initial_storage_sizes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project}/locations/{location}
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbSystemInitialStorageSizes will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.
  • page_token (::String) — Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListDbSystemInitialStorageSizesRequest.new

# Call the list_db_system_initial_storage_sizes method.
result = client.list_db_system_initial_storage_sizes request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::DbSystemInitialStorageSize.
  p item
end

#list_db_system_shapes

def list_db_system_shapes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemShape>
def list_db_system_shapes(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemShape>

Lists the database system shapes available for the project and location.

Overloads 
def list_db_system_shapes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemShape>
Pass arguments to list_db_system_shapes via a request object, either of type ListDbSystemShapesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListDbSystemShapesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_db_system_shapes(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemShape>
Pass arguments to list_db_system_shapes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for Database System Shapes in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: gcp_oracle_zone_id="{gcp_oracle_zone_id}".
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListDbSystemShapesRequest.new

# Call the list_db_system_shapes method.
result = client.list_db_system_shapes request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::DbSystemShape.
  p item
end

#list_db_systems

def list_db_systems(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystem>
def list_db_systems(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystem>

Lists all the DbSystems for the given project and location.

Overloads 
def list_db_systems(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystem>
Pass arguments to list_db_systems via a request object, either of type ListDbSystemsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListDbSystemsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_db_systems(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystem>
Pass arguments to list_db_systems via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for DbSystems in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. An expression for filtering the results of the request.
  • order_by (::String) — Optional. An expression for ordering the results of the request.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListDbSystemsRequest.new

# Call the list_db_systems method.
result = client.list_db_systems request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::DbSystem.
  p item
end

#list_db_versions

def list_db_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbVersion>
def list_db_versions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbVersion>

List DbVersions for the given project and location.

Overloads 
def list_db_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbVersion>
Pass arguments to list_db_versions via a request object, either of type ListDbVersionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListDbVersionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_db_versions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbVersion>
Pass arguments to list_db_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the DbVersion resource with the format: projects/{project}/locations/{location}
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbVersions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.
  • page_token (::String) — Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.
  • filter (::String) — Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is db_system_shape = \\{db_system_shape} AND storage_management = \\{storage_management}. If no filter is provided, all DbVersions will be returned.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListDbVersionsRequest.new

# Call the list_db_versions method.
result = client.list_db_versions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::DbVersion.
  p item
end

#list_entitlements

def list_entitlements(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Entitlement>
def list_entitlements(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Entitlement>

Lists the entitlements in a given project.

Overloads 
def list_entitlements(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Entitlement>
Pass arguments to list_entitlements via a request object, either of type ListEntitlementsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListEntitlementsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_entitlements(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Entitlement>
Pass arguments to list_entitlements via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the entitlement in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListEntitlementsRequest.new

# Call the list_entitlements method.
result = client.list_entitlements request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::Entitlement.
  p item
end

#list_exadb_vm_clusters

def list_exadb_vm_clusters(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::ExadbVmCluster>
def list_exadb_vm_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::ExadbVmCluster>

Lists all the Exadb (Exascale) VM Clusters for the given project and location.

Overloads 
def list_exadb_vm_clusters(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::ExadbVmCluster>
Pass arguments to list_exadb_vm_clusters via a request object, either of type ListExadbVmClustersRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListExadbVmClustersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_exadb_vm_clusters(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::ExadbVmCluster>
Pass arguments to list_exadb_vm_clusters via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for ExadbVmClusters in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. An expression for filtering the results of the request.
  • order_by (::String) — Optional. An expression for ordering the results of the request.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListExadbVmClustersRequest.new

# Call the list_exadb_vm_clusters method.
result = client.list_exadb_vm_clusters request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::ExadbVmCluster.
  p item
end

#list_exascale_db_storage_vaults

def list_exascale_db_storage_vaults(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault>
def list_exascale_db_storage_vaults(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault>

Lists all the ExascaleDB Storage Vaults for the given project and location.

Overloads 
def list_exascale_db_storage_vaults(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault>
Pass arguments to list_exascale_db_storage_vaults via a request object, either of type ListExascaleDbStorageVaultsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListExascaleDbStorageVaultsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_exascale_db_storage_vaults(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault>
Pass arguments to list_exascale_db_storage_vaults via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160.
  • order_by (::String) — Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListExascaleDbStorageVaultsRequest.new

# Call the list_exascale_db_storage_vaults method.
result = client.list_exascale_db_storage_vaults request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::ExascaleDbStorageVault.
  p item
end

#list_gi_versions

def list_gi_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::GiVersion>
def list_gi_versions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::GiVersion>

Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location.

Overloads 
def list_gi_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::GiVersion>
Pass arguments to list_gi_versions via a request object, either of type ListGiVersionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListGiVersionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_gi_versions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::GiVersion>
Pass arguments to list_gi_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: shape="{shape}".
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListGiVersionsRequest.new

# Call the list_gi_versions method.
result = client.list_gi_versions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::GiVersion.
  p item
end

#list_minor_versions

def list_minor_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::MinorVersion>
def list_minor_versions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::MinorVersion>

Lists all the valid minor versions for the given project, location, gi version and shape family.

Overloads 
def list_minor_versions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::MinorVersion>
Pass arguments to list_minor_versions via a request object, either of type ListMinorVersionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListMinorVersionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_minor_versions(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::MinorVersion>
Pass arguments to list_minor_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the MinorVersion resource with the format: projects/{project}/locations/{location}/giVersions/{gi_version}
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.
  • page_token (::String) — Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.
  • filter (::String) — Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: shape_family="{shapeFamily}" AND gcp_oracle_zone_id="\\{gcp_oracle_zone_id}".
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListMinorVersionsRequest.new

# Call the list_minor_versions method.
result = client.list_minor_versions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::MinorVersion.
  p item
end

#list_odb_networks

def list_odb_networks(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::OdbNetwork>
def list_odb_networks(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::OdbNetwork>

Lists the ODB Networks in a given project and location.

Overloads 
def list_odb_networks(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::OdbNetwork>
Pass arguments to list_odb_networks via a request object, either of type ListOdbNetworksRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListOdbNetworksRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_odb_networks(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::OdbNetwork>
Pass arguments to list_odb_networks via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. An expression for filtering the results of the request.
  • order_by (::String) — Optional. An expression for ordering the results of the request.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListOdbNetworksRequest.new

# Call the list_odb_networks method.
result = client.list_odb_networks request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::OdbNetwork.
  p item
end

#list_odb_subnets

def list_odb_subnets(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::OdbSubnet>
def list_odb_subnets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::OdbSubnet>

Lists all the ODB Subnets in a given ODB Network.

Overloads 
def list_odb_subnets(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::OdbSubnet>
Pass arguments to list_odb_subnets via a request object, either of type ListOdbSubnetsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListOdbSubnetsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_odb_subnets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::OdbSubnet>
Pass arguments to list_odb_subnets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.
  • page_size (::Integer) — Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  • page_token (::String) — Optional. A token identifying a page of results the server should return.
  • filter (::String) — Optional. An expression for filtering the results of the request.
  • order_by (::String) — Optional. An expression for ordering the results of the request.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListOdbSubnetsRequest.new

# Call the list_odb_subnets method.
result = client.list_odb_subnets request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::OdbSubnet.
  p item
end

#list_pluggable_databases

def list_pluggable_databases(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::PluggableDatabase>
def list_pluggable_databases(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::PluggableDatabase>

Lists all the PluggableDatabases for the given project, location and Container Database.

Overloads 
def list_pluggable_databases(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::PluggableDatabase>
Pass arguments to list_pluggable_databases via a request object, either of type ListPluggableDatabasesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::ListPluggableDatabasesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_pluggable_databases(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::PluggableDatabase>
Pass arguments to list_pluggable_databases via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}
  • page_size (::Integer) — Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.
  • page_token (::String) — Optional. A page token, received from a previous ListPluggableDatabases call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListPluggableDatabases must match the call that provided the page token.

  • filter (::String) — Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: database="projects/{project}/locations/{location}/databases/{database}"
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::ListPluggableDatabasesRequest.new

# Call the list_pluggable_databases method.
result = client.list_pluggable_databases request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OracleDatabase::V1::PluggableDatabase.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Operations

Get the associated client for long-running operations.

Returns

#remove_virtual_machine_exadb_vm_cluster

def remove_virtual_machine_exadb_vm_cluster(request, options = nil) -> ::Gapic::Operation
def remove_virtual_machine_exadb_vm_cluster(name: nil, request_id: nil, hostnames: nil) -> ::Gapic::Operation

Removes virtual machines from an existing exadb vm cluster.

Overloads 
def remove_virtual_machine_exadb_vm_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to remove_virtual_machine_exadb_vm_cluster via a request object, either of type RemoveVirtualMachineExadbVmClusterRequest or an equivalent Hash.
Parameters 
def remove_virtual_machine_exadb_vm_cluster(name: nil, request_id: nil, hostnames: nil) -> ::Gapic::Operation
Pass arguments to remove_virtual_machine_exadb_vm_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

  • hostnames (::Array<::String>) — Required. The list of host names of db nodes to be removed from the ExadbVmCluster.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::RemoveVirtualMachineExadbVmClusterRequest.new

# Call the remove_virtual_machine_exadb_vm_cluster method.
result = client.remove_virtual_machine_exadb_vm_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#restart_autonomous_database

def restart_autonomous_database(request, options = nil) -> ::Gapic::Operation
def restart_autonomous_database(name: nil) -> ::Gapic::Operation

Restarts an Autonomous Database.

Overloads 
def restart_autonomous_database(request, options = nil) -> ::Gapic::Operation
Pass arguments to restart_autonomous_database via a request object, either of type RestartAutonomousDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::RestartAutonomousDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def restart_autonomous_database(name: nil) -> ::Gapic::Operation
Pass arguments to restart_autonomous_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::RestartAutonomousDatabaseRequest.new

# Call the restart_autonomous_database method.
result = client.restart_autonomous_database request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#restore_autonomous_database

def restore_autonomous_database(request, options = nil) -> ::Gapic::Operation
def restore_autonomous_database(name: nil, restore_time: nil) -> ::Gapic::Operation

Restores a single Autonomous Database.

Overloads 
def restore_autonomous_database(request, options = nil) -> ::Gapic::Operation
Pass arguments to restore_autonomous_database via a request object, either of type RestoreAutonomousDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::RestoreAutonomousDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def restore_autonomous_database(name: nil, restore_time: nil) -> ::Gapic::Operation
Pass arguments to restore_autonomous_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
  • restore_time (::Google::Protobuf::Timestamp, ::Hash) — Required. The time and date to restore the database to.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::RestoreAutonomousDatabaseRequest.new

# Call the restore_autonomous_database method.
result = client.restore_autonomous_database request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#start_autonomous_database

def start_autonomous_database(request, options = nil) -> ::Gapic::Operation
def start_autonomous_database(name: nil) -> ::Gapic::Operation

Starts an Autonomous Database.

Overloads 
def start_autonomous_database(request, options = nil) -> ::Gapic::Operation
Pass arguments to start_autonomous_database via a request object, either of type StartAutonomousDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::StartAutonomousDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def start_autonomous_database(name: nil) -> ::Gapic::Operation
Pass arguments to start_autonomous_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::StartAutonomousDatabaseRequest.new

# Call the start_autonomous_database method.
result = client.start_autonomous_database request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#stop_autonomous_database

def stop_autonomous_database(request, options = nil) -> ::Gapic::Operation
def stop_autonomous_database(name: nil) -> ::Gapic::Operation

Stops an Autonomous Database.

Overloads 
def stop_autonomous_database(request, options = nil) -> ::Gapic::Operation
Pass arguments to stop_autonomous_database via a request object, either of type StopAutonomousDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::StopAutonomousDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def stop_autonomous_database(name: nil) -> ::Gapic::Operation
Pass arguments to stop_autonomous_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::StopAutonomousDatabaseRequest.new

# Call the stop_autonomous_database method.
result = client.stop_autonomous_database request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#switchover_autonomous_database

def switchover_autonomous_database(request, options = nil) -> ::Gapic::Operation
def switchover_autonomous_database(name: nil, peer_autonomous_database: nil) -> ::Gapic::Operation

Initiates a switchover of specified autonomous database to the associated peer database.

Overloads 
def switchover_autonomous_database(request, options = nil) -> ::Gapic::Operation
Pass arguments to switchover_autonomous_database via a request object, either of type SwitchoverAutonomousDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::SwitchoverAutonomousDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def switchover_autonomous_database(name: nil, peer_autonomous_database: nil) -> ::Gapic::Operation
Pass arguments to switchover_autonomous_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
  • peer_autonomous_database (::String) — Required. The peer database name to switch over to.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::SwitchoverAutonomousDatabaseRequest.new

# Call the switchover_autonomous_database method.
result = client.switchover_autonomous_database request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_autonomous_database

def update_autonomous_database(request, options = nil) -> ::Gapic::Operation
def update_autonomous_database(update_mask: nil, autonomous_database: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Autonomous Database.

Overloads 
def update_autonomous_database(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_autonomous_database via a request object, either of type UpdateAutonomousDatabaseRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::UpdateAutonomousDatabaseRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_autonomous_database(update_mask: nil, autonomous_database: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_autonomous_database via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  • autonomous_database (::Google::Cloud::OracleDatabase::V1::AutonomousDatabase, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::UpdateAutonomousDatabaseRequest.new

# Call the update_autonomous_database method.
result = client.update_autonomous_database request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_exadb_vm_cluster

def update_exadb_vm_cluster(request, options = nil) -> ::Gapic::Operation
def update_exadb_vm_cluster(update_mask: nil, exadb_vm_cluster: nil, request_id: nil) -> ::Gapic::Operation

Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count.

Overloads 
def update_exadb_vm_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_exadb_vm_cluster via a request object, either of type UpdateExadbVmClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::OracleDatabase::V1::UpdateExadbVmClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_exadb_vm_cluster(update_mask: nil, exadb_vm_cluster: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_exadb_vm_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten.
  • exadb_vm_cluster (::Google::Cloud::OracleDatabase::V1::ExadbVmCluster, ::Hash) — Required. The resource being updated.
  • request_id (::String) — Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/oracle_database/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OracleDatabase::V1::UpdateExadbVmClusterRequest.new

# Call the update_exadb_vm_cluster method.
result = client.update_exadb_vm_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end