Oracle Database@Google Cloud V1 API - Class Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client (v0.3.0)
Stay organized with collections
Save and categorize content based on your preferences.
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
Methods
.configure
defself.configure(){|config|...}->Client::ConfigurationConfigure the OracleDatabase Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all OracleDatabase clients ::Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::Client.configuredo|config| config.timeout=10.0 end
#configure
defconfigure(){|config|...}->Client::ConfigurationConfigure 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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_autonomous_database
defcreate_autonomous_database(request,options=nil)->::Gapic::Operation
defcreate_autonomous_database(parent:nil,autonomous_database_id:nil,autonomous_database:nil,request_id:nil)->::Gapic::OperationCreates a new Autonomous Database in a given project and location.
defcreate_autonomous_database(request,options=nil)->::Gapic::Operationcreate_autonomous_database via a request object, either of type
CreateAutonomousDatabaseRequest or an equivalent Hash.
- 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.
defcreate_autonomous_database(parent:nil,autonomous_database_id:nil,autonomous_database:nil,request_id:nil)->::Gapic::Operationcreate_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).
- 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).
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_databaserequest # 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 ifresult.response? presult.response else puts"No response received." end
#create_cloud_exadata_infrastructure
defcreate_cloud_exadata_infrastructure(request,options=nil)->::Gapic::Operation
defcreate_cloud_exadata_infrastructure(parent:nil,cloud_exadata_infrastructure_id:nil,cloud_exadata_infrastructure:nil,request_id:nil)->::Gapic::OperationCreates a new Exadata Infrastructure in a given project and location.
defcreate_cloud_exadata_infrastructure(request,options=nil)->::Gapic::Operationcreate_cloud_exadata_infrastructure via a request object, either of type
CreateCloudExadataInfrastructureRequest or an equivalent Hash.
- request (::Google::Cloud::OracleDatabase::V1::CreateCloudExadataInfrastructureRequest, ::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.
defcreate_cloud_exadata_infrastructure(parent:nil,cloud_exadata_infrastructure_id:nil,cloud_exadata_infrastructure:nil,request_id:nil)->::Gapic::Operationcreate_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).
- 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).
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_infrastructurerequest # 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 ifresult.response? presult.response else puts"No response received." end
#create_cloud_vm_cluster
defcreate_cloud_vm_cluster(request,options=nil)->::Gapic::Operation
defcreate_cloud_vm_cluster(parent:nil,cloud_vm_cluster_id:nil,cloud_vm_cluster:nil,request_id:nil)->::Gapic::OperationCreates a new VM Cluster in a given project and location.
defcreate_cloud_vm_cluster(request,options=nil)->::Gapic::Operationcreate_cloud_vm_cluster via a request object, either of type
CreateCloudVmClusterRequest or an equivalent Hash.
- 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.
defcreate_cloud_vm_cluster(parent:nil,cloud_vm_cluster_id:nil,cloud_vm_cluster:nil,request_id:nil)->::Gapic::Operationcreate_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).
- 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).
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_clusterrequest # 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 ifresult.response? presult.response else puts"No response received." end
#delete_autonomous_database
defdelete_autonomous_database(request,options=nil)->::Gapic::Operation
defdelete_autonomous_database(name:nil,request_id:nil)->::Gapic::OperationDeletes a single Autonomous Database.
defdelete_autonomous_database(request,options=nil)->::Gapic::Operationdelete_autonomous_database via a request object, either of type
DeleteAutonomousDatabaseRequest or an equivalent Hash.
- 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.
defdelete_autonomous_database(name:nil,request_id:nil)->::Gapic::Operationdelete_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).
- 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).
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_databaserequest # 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 ifresult.response? presult.response else puts"No response received." end
#delete_cloud_exadata_infrastructure
defdelete_cloud_exadata_infrastructure(request,options=nil)->::Gapic::Operation
defdelete_cloud_exadata_infrastructure(name:nil,request_id:nil,force:nil)->::Gapic::OperationDeletes a single Exadata Infrastructure.
defdelete_cloud_exadata_infrastructure(request,options=nil)->::Gapic::Operationdelete_cloud_exadata_infrastructure via a request object, either of type
DeleteCloudExadataInfrastructureRequest or an equivalent Hash.
- request (::Google::Cloud::OracleDatabase::V1::DeleteCloudExadataInfrastructureRequest, ::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.
defdelete_cloud_exadata_infrastructure(name:nil,request_id:nil,force:nil)->::Gapic::Operationdelete_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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_infrastructurerequest # 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 ifresult.response? presult.response else puts"No response received." end
#delete_cloud_vm_cluster
defdelete_cloud_vm_cluster(request,options=nil)->::Gapic::Operation
defdelete_cloud_vm_cluster(name:nil,request_id:nil,force:nil)->::Gapic::OperationDeletes a single VM Cluster.
defdelete_cloud_vm_cluster(request,options=nil)->::Gapic::Operationdelete_cloud_vm_cluster via a request object, either of type
DeleteCloudVmClusterRequest or an equivalent Hash.
- 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.
defdelete_cloud_vm_cluster(name:nil,request_id:nil,force:nil)->::Gapic::Operationdelete_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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_clusterrequest # 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 ifresult.response? presult.response else puts"No response received." end
#generate_autonomous_database_wallet
defgenerate_autonomous_database_wallet(request,options=nil)->::Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponse
defgenerate_autonomous_database_wallet(name:nil,type:nil,is_regional:nil,password:nil)->::Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponseGenerates a wallet for an Autonomous Database.
defgenerate_autonomous_database_wallet(request,options=nil)->::Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponsegenerate_autonomous_database_wallet via a request object, either of type
GenerateAutonomousDatabaseWalletRequest or an equivalent Hash.
- request (::Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletRequest, ::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.
defgenerate_autonomous_database_wallet(name:nil,type:nil,is_regional:nil,password:nil)->::Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponsegenerate_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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_walletrequest # The returned object is of type Google::Cloud::OracleDatabase::V1::GenerateAutonomousDatabaseWalletResponse. presult
#get_autonomous_database
defget_autonomous_database(request,options=nil)->::Google::Cloud::OracleDatabase::V1::AutonomousDatabase
defget_autonomous_database(name:nil)->::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseGets the details of a single Autonomous Database.
defget_autonomous_database(request,options=nil)->::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseget_autonomous_database via a request object, either of type
GetAutonomousDatabaseRequest or an equivalent Hash.
- 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.
defget_autonomous_database(name:nil)->::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseget_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).
- name (::String) — Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::OracleDatabase::V1::AutonomousDatabase)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_databaserequest # The returned object is of type Google::Cloud::OracleDatabase::V1::AutonomousDatabase. presult
#get_cloud_exadata_infrastructure
defget_cloud_exadata_infrastructure(request,options=nil)->::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure
defget_cloud_exadata_infrastructure(name:nil)->::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructureGets details of a single Exadata Infrastructure.
defget_cloud_exadata_infrastructure(request,options=nil)->::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructureget_cloud_exadata_infrastructure via a request object, either of type
GetCloudExadataInfrastructureRequest or an equivalent Hash.
- 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.
defget_cloud_exadata_infrastructure(name:nil)->::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructureget_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).
- name (::String) — Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_infrastructurerequest # The returned object is of type Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure. presult
#get_cloud_vm_cluster
defget_cloud_vm_cluster(request,options=nil)->::Google::Cloud::OracleDatabase::V1::CloudVmCluster
defget_cloud_vm_cluster(name:nil)->::Google::Cloud::OracleDatabase::V1::CloudVmClusterGets details of a single VM Cluster.
defget_cloud_vm_cluster(request,options=nil)->::Google::Cloud::OracleDatabase::V1::CloudVmClusterget_cloud_vm_cluster via a request object, either of type
GetCloudVmClusterRequest or an equivalent Hash.
- 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.
defget_cloud_vm_cluster(name:nil)->::Google::Cloud::OracleDatabase::V1::CloudVmClusterget_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).
- name (::String) — Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::OracleDatabase::V1::CloudVmCluster)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_clusterrequest # The returned object is of type Google::Cloud::OracleDatabase::V1::CloudVmCluster. presult
#initialize
definitialize(){|config|...}->ClientCreate a new OracleDatabase REST client object.
- (config) — Configure the OracleDatabase client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# 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.newdo|config| config.timeout=10.0 end
#list_autonomous_database_backups
deflist_autonomous_database_backups(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup>
deflist_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.
deflist_autonomous_database_backups(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup>list_autonomous_database_backups via a request object, either of type
ListAutonomousDatabaseBackupsRequest or an equivalent Hash.
- 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.
deflist_autonomous_database_backups(parent:nil,filter:nil,page_size:nil,page_token:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup>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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_backupsrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseBackup. pitem end
#list_autonomous_database_character_sets
deflist_autonomous_database_character_sets(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet>
deflist_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.
deflist_autonomous_database_character_sets(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet>list_autonomous_database_character_sets via a request object, either of type
ListAutonomousDatabaseCharacterSetsRequest or an equivalent Hash.
- request (::Google::Cloud::OracleDatabase::V1::ListAutonomousDatabaseCharacterSetsRequest, ::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.
deflist_autonomous_database_character_sets(parent:nil,page_size:nil,page_token:nil,filter:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet>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).
- 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 includeDATABASEandNATIONAL.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_setsrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::AutonomousDatabaseCharacterSet. pitem end
#list_autonomous_databases
deflist_autonomous_databases(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabase>
deflist_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.
deflist_autonomous_databases(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabase>list_autonomous_databases via a request object, either of type
ListAutonomousDatabasesRequest or an equivalent Hash.
- 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.
deflist_autonomous_databases(parent:nil,page_size:nil,page_token:nil,filter:nil,order_by:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabase>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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabase>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDatabase>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_databasesrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::AutonomousDatabase. pitem end
#list_autonomous_db_versions
deflist_autonomous_db_versions(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion>
deflist_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.
deflist_autonomous_db_versions(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion>list_autonomous_db_versions via a request object, either of type
ListAutonomousDbVersionsRequest or an equivalent Hash.
- 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.
deflist_autonomous_db_versions(parent:nil,page_size:nil,page_token:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion>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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_versionsrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::AutonomousDbVersion. pitem end
#list_cloud_exadata_infrastructures
deflist_cloud_exadata_infrastructures(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure>
deflist_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.
deflist_cloud_exadata_infrastructures(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure>list_cloud_exadata_infrastructures via a request object, either of type
ListCloudExadataInfrastructuresRequest or an equivalent Hash.
- 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.
deflist_cloud_exadata_infrastructures(parent:nil,page_size:nil,page_token:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure>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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_infrastructuresrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::CloudExadataInfrastructure. pitem end
#list_cloud_vm_clusters
deflist_cloud_vm_clusters(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudVmCluster>
deflist_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.
deflist_cloud_vm_clusters(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudVmCluster>list_cloud_vm_clusters via a request object, either of type
ListCloudVmClustersRequest or an equivalent Hash.
- 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.
deflist_cloud_vm_clusters(parent:nil,page_size:nil,page_token:nil,filter:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudVmCluster>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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudVmCluster>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::CloudVmCluster>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_clustersrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::CloudVmCluster. pitem end
#list_db_nodes
deflist_db_nodes(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbNode>
deflist_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.
deflist_db_nodes(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbNode>list_db_nodes via a request object, either of type
ListDbNodesRequest or an equivalent Hash.
- 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.
deflist_db_nodes(parent:nil,page_size:nil,page_token:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbNode>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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbNode>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbNode>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_nodesrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::DbNode. pitem end
#list_db_servers
deflist_db_servers(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbServer>
deflist_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.
deflist_db_servers(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbServer>list_db_servers via a request object, either of type
ListDbServersRequest or an equivalent Hash.
- 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.
deflist_db_servers(parent:nil,page_size:nil,page_token:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbServer>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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbServer>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbServer>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_serversrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::DbServer. pitem end
#list_db_system_shapes
deflist_db_system_shapes(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemShape>
deflist_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.
deflist_db_system_shapes(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemShape>list_db_system_shapes via a request object, either of type
ListDbSystemShapesRequest or an equivalent Hash.
- 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.
deflist_db_system_shapes(parent:nil,page_size:nil,page_token:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemShape>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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemShape>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::DbSystemShape>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_shapesrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::DbSystemShape. pitem end
#list_entitlements
deflist_entitlements(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Entitlement>
deflist_entitlements(parent:nil,page_size:nil,page_token:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Entitlement>Lists the entitlements in a given project.
deflist_entitlements(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Entitlement>list_entitlements via a request object, either of type
ListEntitlementsRequest or an equivalent Hash.
- 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.
deflist_entitlements(parent:nil,page_size:nil,page_token:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Entitlement>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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Entitlement>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::Entitlement>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_entitlementsrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::Entitlement. pitem end
#list_gi_versions
deflist_gi_versions(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::GiVersion>
deflist_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.
deflist_gi_versions(request,options=nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::GiVersion>list_gi_versions via a request object, either of type
ListGiVersionsRequest or an equivalent Hash.
- 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.
deflist_gi_versions(parent:nil,page_size:nil,page_token:nil)->::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::GiVersion>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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::GiVersion>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::OracleDatabase::V1::GiVersion>)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_versionsrequest # 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.eachdo|item| # Each element is of type ::Google::Cloud::OracleDatabase::V1::GiVersion. pitem end
#location_client
deflocation_client()->Google::Cloud::Location::Locations::Rest::ClientGet the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Rest::Client)
#logger
deflogger()->LoggerThe logger used for request/response debug logging.
- (Logger)
#operations_client
defoperations_client()->::Google::Cloud::OracleDatabase::V1::OracleDatabase::Rest::OperationsGet the associated client for long-running operations.
#restore_autonomous_database
defrestore_autonomous_database(request,options=nil)->::Gapic::Operation
defrestore_autonomous_database(name:nil,restore_time:nil)->::Gapic::OperationRestores a single Autonomous Database.
defrestore_autonomous_database(request,options=nil)->::Gapic::Operationrestore_autonomous_database via a request object, either of type
RestoreAutonomousDatabaseRequest or an equivalent Hash.
- 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.
defrestore_autonomous_database(name:nil,restore_time:nil)->::Gapic::Operationrestore_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).
- 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.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
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_databaserequest # 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 ifresult.response? presult.response else puts"No response received." end
#universe_domain
defuniverse_domain()->StringThe effective universe domain
- (String)