Oracle Database@Google Cloud V1 API - Class Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client (v0.1.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

#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

#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

#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) -> ::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) -> ::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.
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_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_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) -> ::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) -> ::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.
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_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_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) -> ::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) -> ::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.
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

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

#operations_client

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

Get the associated client for long-running operations.

Returns

#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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)