Class v1.OracleDatabaseClient (0.1.0)

Version 0.1.0

• 0.2.0 (latest)
• 0.1.0

Service describing handlers for resources v1

Package

@google-cloud/oracledatabase

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of OracleDatabaseClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new OracleDatabaseClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

oracleDatabaseStub

oracleDatabaseStub?: Promise<{
        [name: string]: Function;
    }>;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

autonomousDatabaseBackupPath(project, location, autonomousDatabaseBackup)

autonomousDatabaseBackupPath(project: string, location: string, autonomousDatabaseBackup: string): string;

Return a fully-qualified autonomousDatabaseBackup resource name string.

Parameters
Name	Description
project	string
location	string
autonomousDatabaseBackup	string

Returns
Type	Description
string	{string} Resource name string.

autonomousDatabaseCharacterSetPath(project, location, autonomousDatabaseCharacterSet)

autonomousDatabaseCharacterSetPath(project: string, location: string, autonomousDatabaseCharacterSet: string): string;

Return a fully-qualified autonomousDatabaseCharacterSet resource name string.

Parameters
Name	Description
project	string
location	string
autonomousDatabaseCharacterSet	string

Returns
Type	Description
string	{string} Resource name string.

autonomousDatabasePath(project, location, autonomousDatabase)

autonomousDatabasePath(project: string, location: string, autonomousDatabase: string): string;

Return a fully-qualified autonomousDatabase resource name string.

Parameters
Name	Description
project	string
location	string
autonomousDatabase	string

Returns
Type	Description
string	{string} Resource name string.

autonomousDbVersionPath(project, location, autonomousDbVersion)

autonomousDbVersionPath(project: string, location: string, autonomousDbVersion: string): string;

Return a fully-qualified autonomousDbVersion resource name string.

Parameters
Name	Description
project	string
location	string
autonomousDbVersion	string

Returns
Type	Description
string	{string} Resource name string.

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name	Description
request	CancelOperationRequest The request object that will be sent.
options	CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateAutonomousDatabaseProgress(name)

checkCreateAutonomousDatabaseProgress(name: string): Promise<LROperation<protos.google.cloud.oracledatabase.v1.AutonomousDatabase, protos.google.cloud.oracledatabase.v1.OperationMetadata>>;

Check the status of the long running operation returned by createAutonomousDatabase().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.oracledatabase.v1.AutonomousDatabase, protos.google.cloud.oracledatabase.v1.OperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent in the following format:
   *  projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the Autonomous Database to create. This value is
   *  restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) 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.
   */
  // const autonomousDatabaseId = 'abc123'
  /**
   *  Required. The Autonomous Database being created.
   */
  // const autonomousDatabase = {}
  /**
   *  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).
   */
  // const requestId = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callCreateAutonomousDatabase() {
    // Construct request
    const request = {
      parent,
      autonomousDatabaseId,
      autonomousDatabase,
    };

    // Run request
    const [operation] = await oracledatabaseClient.createAutonomousDatabase(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateAutonomousDatabase();

checkCreateCloudExadataInfrastructureProgress(name)

checkCreateCloudExadataInfrastructureProgress(name: string): Promise<LROperation<protos.google.cloud.oracledatabase.v1.CloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.OperationMetadata>>;

Check the status of the long running operation returned by createCloudExadataInfrastructure().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.oracledatabase.v1.CloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.OperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for CloudExadataInfrastructure in the following
   *  format: projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the Exadata Infrastructure to create. This value is
   *  restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) 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.
   */
  // const cloudExadataInfrastructureId = 'abc123'
  /**
   *  Required. Details of the Exadata Infrastructure instance to create.
   */
  // const cloudExadataInfrastructure = {}
  /**
   *  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).
   */
  // const requestId = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callCreateCloudExadataInfrastructure() {
    // Construct request
    const request = {
      parent,
      cloudExadataInfrastructureId,
      cloudExadataInfrastructure,
    };

    // Run request
    const [operation] = await oracledatabaseClient.createCloudExadataInfrastructure(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateCloudExadataInfrastructure();

checkCreateCloudVmClusterProgress(name)

checkCreateCloudVmClusterProgress(name: string): Promise<LROperation<protos.google.cloud.oracledatabase.v1.CloudVmCluster, protos.google.cloud.oracledatabase.v1.OperationMetadata>>;

Check the status of the long running operation returned by createCloudVmCluster().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.oracledatabase.v1.CloudVmCluster, protos.google.cloud.oracledatabase.v1.OperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent in the following format:
   *  projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the VM Cluster to create. This value is restricted
   *  to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) 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.
   */
  // const cloudVmClusterId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const cloudVmCluster = {}
  /**
   *  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).
   */
  // const requestId = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callCreateCloudVmCluster() {
    // Construct request
    const request = {
      parent,
      cloudVmClusterId,
      cloudVmCluster,
    };

    // Run request
    const [operation] = await oracledatabaseClient.createCloudVmCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateCloudVmCluster();

checkDeleteAutonomousDatabaseProgress(name)

checkDeleteAutonomousDatabaseProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.oracledatabase.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteAutonomousDatabase().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.oracledatabase.v1.OperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the resource in the following format:
   *  projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
   */
  // const name = 'abc123'
  /**
   *  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).
   */
  // const requestId = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callDeleteAutonomousDatabase() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await oracledatabaseClient.deleteAutonomousDatabase(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteAutonomousDatabase();

checkDeleteCloudExadataInfrastructureProgress(name)

checkDeleteCloudExadataInfrastructureProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.oracledatabase.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteCloudExadataInfrastructure().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.oracledatabase.v1.OperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Cloud Exadata Infrastructure in the following
   *  format:
   *  projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.
   */
  // const name = 'abc123'
  /**
   *  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).
   */
  // const requestId = 'abc123'
  /**
   *  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.
   */
  // const force = true

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callDeleteCloudExadataInfrastructure() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await oracledatabaseClient.deleteCloudExadataInfrastructure(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCloudExadataInfrastructure();

checkDeleteCloudVmClusterProgress(name)

checkDeleteCloudVmClusterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.oracledatabase.v1.OperationMetadata>>;

Check the status of the long running operation returned by deleteCloudVmCluster().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.oracledatabase.v1.OperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Cloud VM Cluster in the following format:
   *  projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.
   */
  // const name = 'abc123'
  /**
   *  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).
   */
  // const requestId = 'abc123'
  /**
   *  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.
   */
  // const force = true

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callDeleteCloudVmCluster() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await oracledatabaseClient.deleteCloudVmCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCloudVmCluster();

checkRestoreAutonomousDatabaseProgress(name)

checkRestoreAutonomousDatabaseProgress(name: string): Promise<LROperation<protos.google.cloud.oracledatabase.v1.AutonomousDatabase, protos.google.cloud.oracledatabase.v1.OperationMetadata>>;

Check the status of the long running operation returned by restoreAutonomousDatabase().

Parameter
Name	Description
name	string The operation name that will be passed.

Returns
Type	Description
Promise<LROperation<protos.google.cloud.oracledatabase.v1.AutonomousDatabase, protos.google.cloud.oracledatabase.v1.OperationMetadata>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Autonomous Database in the following format:
   *  projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
   */
  // const name = 'abc123'
  /**
   *  Required. The time and date to restore the database to.
   */
  // const restoreTime = {}

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callRestoreAutonomousDatabase() {
    // Construct request
    const request = {
      name,
      restoreTime,
    };

    // Run request
    const [operation] = await oracledatabaseClient.restoreAutonomousDatabase(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRestoreAutonomousDatabase();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

cloudExadataInfrastructurePath(project, location, cloudExadataInfrastructure)

cloudExadataInfrastructurePath(project: string, location: string, cloudExadataInfrastructure: string): string;

Return a fully-qualified cloudExadataInfrastructure resource name string.

Parameters
Name	Description
project	string
location	string
cloudExadataInfrastructure	string

Returns
Type	Description
string	{string} Resource name string.

cloudVmClusterPath(project, location, cloudVmCluster)

cloudVmClusterPath(project: string, location: string, cloudVmCluster: string): string;

Return a fully-qualified cloudVmCluster resource name string.

Parameters
Name	Description
project	string
location	string
cloudVmCluster	string

Returns
Type	Description
string	{string} Resource name string.

createAutonomousDatabase(request, options)

createAutonomousDatabase(request?: protos.google.cloud.oracledatabase.v1.ICreateAutonomousDatabaseRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

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

Parameters
Name	Description
request	ICreateAutonomousDatabaseRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent in the following format:
   *  projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the Autonomous Database to create. This value is
   *  restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) 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.
   */
  // const autonomousDatabaseId = 'abc123'
  /**
   *  Required. The Autonomous Database being created.
   */
  // const autonomousDatabase = {}
  /**
   *  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).
   */
  // const requestId = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callCreateAutonomousDatabase() {
    // Construct request
    const request = {
      parent,
      autonomousDatabaseId,
      autonomousDatabase,
    };

    // Run request
    const [operation] = await oracledatabaseClient.createAutonomousDatabase(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateAutonomousDatabase();

createAutonomousDatabase(request, options, callback)

createAutonomousDatabase(request: protos.google.cloud.oracledatabase.v1.ICreateAutonomousDatabaseRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateAutonomousDatabaseRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createAutonomousDatabase(request, callback)

createAutonomousDatabase(request: protos.google.cloud.oracledatabase.v1.ICreateAutonomousDatabaseRequest, callback: Callback<LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateAutonomousDatabaseRequest
callback	Callback<LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createCloudExadataInfrastructure(request, options)

createCloudExadataInfrastructure(request?: protos.google.cloud.oracledatabase.v1.ICreateCloudExadataInfrastructureRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

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

Parameters
Name	Description
request	ICreateCloudExadataInfrastructureRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for CloudExadataInfrastructure in the following
   *  format: projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the Exadata Infrastructure to create. This value is
   *  restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) 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.
   */
  // const cloudExadataInfrastructureId = 'abc123'
  /**
   *  Required. Details of the Exadata Infrastructure instance to create.
   */
  // const cloudExadataInfrastructure = {}
  /**
   *  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).
   */
  // const requestId = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callCreateCloudExadataInfrastructure() {
    // Construct request
    const request = {
      parent,
      cloudExadataInfrastructureId,
      cloudExadataInfrastructure,
    };

    // Run request
    const [operation] = await oracledatabaseClient.createCloudExadataInfrastructure(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateCloudExadataInfrastructure();

createCloudExadataInfrastructure(request, options, callback)

createCloudExadataInfrastructure(request: protos.google.cloud.oracledatabase.v1.ICreateCloudExadataInfrastructureRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateCloudExadataInfrastructureRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createCloudExadataInfrastructure(request, callback)

createCloudExadataInfrastructure(request: protos.google.cloud.oracledatabase.v1.ICreateCloudExadataInfrastructureRequest, callback: Callback<LROperation<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateCloudExadataInfrastructureRequest
callback	Callback<LROperation<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createCloudVmCluster(request, options)

createCloudVmCluster(request?: protos.google.cloud.oracledatabase.v1.ICreateCloudVmClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.oracledatabase.v1.ICloudVmCluster, protos.google.cloud.oracledatabase.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

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

Parameters
Name	Description
request	ICreateCloudVmClusterRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.oracledatabase.v1.ICloudVmCluster, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent in the following format:
   *  projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ID of the VM Cluster to create. This value is restricted
   *  to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) 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.
   */
  // const cloudVmClusterId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const cloudVmCluster = {}
  /**
   *  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).
   */
  // const requestId = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callCreateCloudVmCluster() {
    // Construct request
    const request = {
      parent,
      cloudVmClusterId,
      cloudVmCluster,
    };

    // Run request
    const [operation] = await oracledatabaseClient.createCloudVmCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateCloudVmCluster();

createCloudVmCluster(request, options, callback)

createCloudVmCluster(request: protos.google.cloud.oracledatabase.v1.ICreateCloudVmClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.oracledatabase.v1.ICloudVmCluster, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateCloudVmClusterRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.oracledatabase.v1.ICloudVmCluster, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createCloudVmCluster(request, callback)

createCloudVmCluster(request: protos.google.cloud.oracledatabase.v1.ICreateCloudVmClusterRequest, callback: Callback<LROperation<protos.google.cloud.oracledatabase.v1.ICloudVmCluster, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateCloudVmClusterRequest
callback	Callback<LROperation<protos.google.cloud.oracledatabase.v1.ICloudVmCluster, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

dbNodePath(project, location, cloudVmCluster, dbNode)

dbNodePath(project: string, location: string, cloudVmCluster: string, dbNode: string): string;

Return a fully-qualified dbNode resource name string.

Parameters
Name	Description
project	string
location	string
cloudVmCluster	string
dbNode	string

Returns
Type	Description
string	{string} Resource name string.

dbServerPath(project, location, cloudExadataInfrastructure, dbServer)

dbServerPath(project: string, location: string, cloudExadataInfrastructure: string, dbServer: string): string;

Return a fully-qualified dbServer resource name string.

Parameters
Name	Description
project	string
location	string
cloudExadataInfrastructure	string
dbServer	string

Returns
Type	Description
string	{string} Resource name string.

dbSystemShapePath(project, location, dbSystemShape)

dbSystemShapePath(project: string, location: string, dbSystemShape: string): string;

Return a fully-qualified dbSystemShape resource name string.

Parameters
Name	Description
project	string
location	string
dbSystemShape	string

Returns
Type	Description
string	{string} Resource name string.

deleteAutonomousDatabase(request, options)

deleteAutonomousDatabase(request?: protos.google.cloud.oracledatabase.v1.IDeleteAutonomousDatabaseRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single Autonomous Database.

Parameters
Name	Description
request	IDeleteAutonomousDatabaseRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the resource in the following format:
   *  projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
   */
  // const name = 'abc123'
  /**
   *  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).
   */
  // const requestId = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callDeleteAutonomousDatabase() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await oracledatabaseClient.deleteAutonomousDatabase(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteAutonomousDatabase();

deleteAutonomousDatabase(request, options, callback)

deleteAutonomousDatabase(request: protos.google.cloud.oracledatabase.v1.IDeleteAutonomousDatabaseRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteAutonomousDatabaseRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteAutonomousDatabase(request, callback)

deleteAutonomousDatabase(request: protos.google.cloud.oracledatabase.v1.IDeleteAutonomousDatabaseRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteAutonomousDatabaseRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteCloudExadataInfrastructure(request, options)

deleteCloudExadataInfrastructure(request?: protos.google.cloud.oracledatabase.v1.IDeleteCloudExadataInfrastructureRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single Exadata Infrastructure.

Parameters
Name	Description
request	IDeleteCloudExadataInfrastructureRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Cloud Exadata Infrastructure in the following
   *  format:
   *  projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.
   */
  // const name = 'abc123'
  /**
   *  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).
   */
  // const requestId = 'abc123'
  /**
   *  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.
   */
  // const force = true

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callDeleteCloudExadataInfrastructure() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await oracledatabaseClient.deleteCloudExadataInfrastructure(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCloudExadataInfrastructure();

deleteCloudExadataInfrastructure(request, options, callback)

deleteCloudExadataInfrastructure(request: protos.google.cloud.oracledatabase.v1.IDeleteCloudExadataInfrastructureRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteCloudExadataInfrastructureRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteCloudExadataInfrastructure(request, callback)

deleteCloudExadataInfrastructure(request: protos.google.cloud.oracledatabase.v1.IDeleteCloudExadataInfrastructureRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteCloudExadataInfrastructureRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteCloudVmCluster(request, options)

deleteCloudVmCluster(request?: protos.google.cloud.oracledatabase.v1.IDeleteCloudVmClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single VM Cluster.

Parameters
Name	Description
request	IDeleteCloudVmClusterRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Cloud VM Cluster in the following format:
   *  projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.
   */
  // const name = 'abc123'
  /**
   *  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).
   */
  // const requestId = 'abc123'
  /**
   *  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.
   */
  // const force = true

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callDeleteCloudVmCluster() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await oracledatabaseClient.deleteCloudVmCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCloudVmCluster();

deleteCloudVmCluster(request, options, callback)

deleteCloudVmCluster(request: protos.google.cloud.oracledatabase.v1.IDeleteCloudVmClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteCloudVmClusterRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteCloudVmCluster(request, callback)

deleteCloudVmCluster(request: protos.google.cloud.oracledatabase.v1.IDeleteCloudVmClusterRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IDeleteCloudVmClusterRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	DeleteOperationRequest The request object that will be sent.
options	CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<protos.google.protobuf.Empty>

Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

entitlementPath(project, location, entitlement)

entitlementPath(project: string, location: string, entitlement: string): string;

Return a fully-qualified entitlement resource name string.

Parameters
Name	Description
project	string
location	string
entitlement	string

Returns
Type	Description
string	{string} Resource name string.

generateAutonomousDatabaseWallet(request, options)

generateAutonomousDatabaseWallet(request?: protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletResponse,
        (protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletRequest | undefined),
        {} | undefined
    ]>;

Generates a wallet for an Autonomous Database.

Parameters
Name	Description
request	IGenerateAutonomousDatabaseWalletRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletResponse, (protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerateAutonomousDatabaseWalletResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Autonomous Database in the following format:
   *  projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
   */
  // const name = 'abc123'
  /**
   *  Optional. The type of wallet generation for the Autonomous Database. The
   *  default value is SINGLE.
   */
  // const type = {}
  /**
   *  Optional. True when requesting regional connection strings in PDB connect
   *  info, applicable to cross-region Data Guard only.
   */
  // const isRegional = true
  /**
   *  Required. The password used to encrypt the keys inside the wallet. The
   *  password must be a minimum of 8 characters.
   */
  // const password = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callGenerateAutonomousDatabaseWallet() {
    // Construct request
    const request = {
      name,
      password,
    };

    // Run request
    const response = await oracledatabaseClient.generateAutonomousDatabaseWallet(request);
    console.log(response);
  }

  callGenerateAutonomousDatabaseWallet();

generateAutonomousDatabaseWallet(request, options, callback)

generateAutonomousDatabaseWallet(request: protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletRequest, options: CallOptions, callback: Callback<protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletResponse, protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGenerateAutonomousDatabaseWalletRequest
options	CallOptions
callback	Callback<protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletResponse, protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

generateAutonomousDatabaseWallet(request, callback)

generateAutonomousDatabaseWallet(request: protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletRequest, callback: Callback<protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletResponse, protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGenerateAutonomousDatabaseWalletRequest
callback	Callback<protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletResponse, protos.google.cloud.oracledatabase.v1.IGenerateAutonomousDatabaseWalletRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getAutonomousDatabase(request, options)

getAutonomousDatabase(request?: protos.google.cloud.oracledatabase.v1.IGetAutonomousDatabaseRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IAutonomousDatabase,
        (protos.google.cloud.oracledatabase.v1.IGetAutonomousDatabaseRequest | undefined),
        {} | undefined
    ]>;

Gets the details of a single Autonomous Database.

Parameters
Name	Description
request	IGetAutonomousDatabaseRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, (protos.google.cloud.oracledatabase.v1.IGetAutonomousDatabaseRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing AutonomousDatabase. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Autonomous Database in the following format:
   *  projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
   */
  // const name = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callGetAutonomousDatabase() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await oracledatabaseClient.getAutonomousDatabase(request);
    console.log(response);
  }

  callGetAutonomousDatabase();

getAutonomousDatabase(request, options, callback)

getAutonomousDatabase(request: protos.google.cloud.oracledatabase.v1.IGetAutonomousDatabaseRequest, options: CallOptions, callback: Callback<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IGetAutonomousDatabaseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetAutonomousDatabaseRequest
options	CallOptions
callback	Callback<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IGetAutonomousDatabaseRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getAutonomousDatabase(request, callback)

getAutonomousDatabase(request: protos.google.cloud.oracledatabase.v1.IGetAutonomousDatabaseRequest, callback: Callback<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IGetAutonomousDatabaseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetAutonomousDatabaseRequest
callback	Callback<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IGetAutonomousDatabaseRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getCloudExadataInfrastructure(request, options)

getCloudExadataInfrastructure(request?: protos.google.cloud.oracledatabase.v1.IGetCloudExadataInfrastructureRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure,
        (protos.google.cloud.oracledatabase.v1.IGetCloudExadataInfrastructureRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single Exadata Infrastructure.

Parameters
Name	Description
request	IGetCloudExadataInfrastructureRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, (protos.google.cloud.oracledatabase.v1.IGetCloudExadataInfrastructureRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing CloudExadataInfrastructure. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Cloud Exadata Infrastructure in the following
   *  format:
   *  projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.
   */
  // const name = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callGetCloudExadataInfrastructure() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await oracledatabaseClient.getCloudExadataInfrastructure(request);
    console.log(response);
  }

  callGetCloudExadataInfrastructure();

getCloudExadataInfrastructure(request, options, callback)

getCloudExadataInfrastructure(request: protos.google.cloud.oracledatabase.v1.IGetCloudExadataInfrastructureRequest, options: CallOptions, callback: Callback<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.IGetCloudExadataInfrastructureRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetCloudExadataInfrastructureRequest
options	CallOptions
callback	Callback<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.IGetCloudExadataInfrastructureRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getCloudExadataInfrastructure(request, callback)

getCloudExadataInfrastructure(request: protos.google.cloud.oracledatabase.v1.IGetCloudExadataInfrastructureRequest, callback: Callback<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.IGetCloudExadataInfrastructureRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetCloudExadataInfrastructureRequest
callback	Callback<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure, protos.google.cloud.oracledatabase.v1.IGetCloudExadataInfrastructureRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getCloudVmCluster(request, options)

getCloudVmCluster(request?: protos.google.cloud.oracledatabase.v1.IGetCloudVmClusterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.ICloudVmCluster,
        (protos.google.cloud.oracledatabase.v1.IGetCloudVmClusterRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single VM Cluster.

Parameters
Name	Description
request	IGetCloudVmClusterRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.ICloudVmCluster, (protos.google.cloud.oracledatabase.v1.IGetCloudVmClusterRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing CloudVmCluster. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Cloud VM Cluster in the following format:
   *  projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.
   */
  // const name = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callGetCloudVmCluster() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await oracledatabaseClient.getCloudVmCluster(request);
    console.log(response);
  }

  callGetCloudVmCluster();

getCloudVmCluster(request, options, callback)

getCloudVmCluster(request: protos.google.cloud.oracledatabase.v1.IGetCloudVmClusterRequest, options: CallOptions, callback: Callback<protos.google.cloud.oracledatabase.v1.ICloudVmCluster, protos.google.cloud.oracledatabase.v1.IGetCloudVmClusterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetCloudVmClusterRequest
options	CallOptions
callback	Callback<protos.google.cloud.oracledatabase.v1.ICloudVmCluster, protos.google.cloud.oracledatabase.v1.IGetCloudVmClusterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getCloudVmCluster(request, callback)

getCloudVmCluster(request: protos.google.cloud.oracledatabase.v1.IGetCloudVmClusterRequest, callback: Callback<protos.google.cloud.oracledatabase.v1.ICloudVmCluster, protos.google.cloud.oracledatabase.v1.IGetCloudVmClusterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetCloudVmClusterRequest
callback	Callback<protos.google.cloud.oracledatabase.v1.ICloudVmCluster, protos.google.cloud.oracledatabase.v1.IGetCloudVmClusterRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IGetLocationRequest The request object that will be sent.
options	CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined> Call options. See CallOptions for more details.
callback	Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
Promise<google.cloud.location.ILocation>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

const [response] = await client.getLocation(request);

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
request	GetOperationRequest The request object that will be sent.
options	CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined> Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined> The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type	Description
Promise<[protos.google.longrunning.Operation]>

Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
callback	Callback<string, undefined, undefined>

Returns
Type	Description
void

giVersionPath(project, location, giVersion)

giVersionPath(project: string, location: string, giVersion: string): string;

Return a fully-qualified giVersion resource name string.

Parameters
Name	Description
project	string
location	string
giVersion	string

Returns
Type	Description
string	{string} Resource name string.

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listAutonomousDatabaseBackups(request, options)

listAutonomousDatabaseBackups(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseBackup[],
        protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest | null,
        protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsResponse
    ]>;

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

Parameters
Name	Description
request	IListAutonomousDatabaseBackupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseBackup[], protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest | null, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of AutonomousDatabaseBackup. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAutonomousDatabaseBackupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAutonomousDatabaseBackups(request, options, callback)

listAutonomousDatabaseBackups(request: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseBackup>): void;

Parameters
Name	Description
request	IListAutonomousDatabaseBackupsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseBackup>

Returns
Type	Description
void

listAutonomousDatabaseBackups(request, callback)

listAutonomousDatabaseBackups(request: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseBackup>): void;

Parameters
Name	Description
request	IListAutonomousDatabaseBackupsRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseBackup>

Returns
Type	Description
void

listAutonomousDatabaseBackupsAsync(request, options)

listAutonomousDatabaseBackupsAsync(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseBackup>;

Equivalent to listAutonomousDatabaseBackups, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListAutonomousDatabaseBackupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseBackup>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AutonomousDatabaseBackup. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for ListAutonomousDatabaseBackups in the
   *  following format: projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  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]([a-z0-9-]{0,61}[a-z0-9])?$).
   *  The ID must start with a letter, end with a letter or a number, and be
   *  a maximum of 63 characters.
   */
  // const filter = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListAutonomousDatabaseBackups() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listAutonomousDatabaseBackupsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListAutonomousDatabaseBackups();

listAutonomousDatabaseBackupsStream(request, options)

listAutonomousDatabaseBackupsStream(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseBackupsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListAutonomousDatabaseBackupsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing AutonomousDatabaseBackup on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAutonomousDatabaseBackupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAutonomousDatabaseCharacterSets(request, options)

listAutonomousDatabaseCharacterSets(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseCharacterSet[],
        protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest | null,
        protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsResponse
    ]>;

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

Parameters
Name	Description
request	IListAutonomousDatabaseCharacterSetsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseCharacterSet[], protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest | null, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAutonomousDatabaseCharacterSetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAutonomousDatabaseCharacterSets(request, options, callback)

listAutonomousDatabaseCharacterSets(request: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseCharacterSet>): void;

Parameters
Name	Description
request	IListAutonomousDatabaseCharacterSetsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseCharacterSet>

Returns
Type	Description
void

listAutonomousDatabaseCharacterSets(request, callback)

listAutonomousDatabaseCharacterSets(request: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseCharacterSet>): void;

Parameters
Name	Description
request	IListAutonomousDatabaseCharacterSetsRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseCharacterSet>

Returns
Type	Description
void

listAutonomousDatabaseCharacterSetsAsync(request, options)

listAutonomousDatabaseCharacterSetsAsync(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseCharacterSet>;

Equivalent to listAutonomousDatabaseCharacterSets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListAutonomousDatabaseCharacterSetsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.IAutonomousDatabaseCharacterSet>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for the Autonomous Database in the following
   *  format: projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  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`.
   */
  // const filter = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListAutonomousDatabaseCharacterSets() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listAutonomousDatabaseCharacterSetsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListAutonomousDatabaseCharacterSets();

listAutonomousDatabaseCharacterSetsStream(request, options)

listAutonomousDatabaseCharacterSetsStream(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabaseCharacterSetsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListAutonomousDatabaseCharacterSetsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAutonomousDatabaseCharacterSetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAutonomousDatabases(request, options)

listAutonomousDatabases(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IAutonomousDatabase[],
        protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest | null,
        protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesResponse
    ]>;

Lists the Autonomous Databases in a given project and location.

Parameters
Name	Description
request	IListAutonomousDatabasesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IAutonomousDatabase[], protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest | null, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of AutonomousDatabase. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAutonomousDatabasesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAutonomousDatabases(request, options, callback)

listAutonomousDatabases(request: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabase>): void;

Parameters
Name	Description
request	IListAutonomousDatabasesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabase>

Returns
Type	Description
void

listAutonomousDatabases(request, callback)

listAutonomousDatabases(request: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabase>): void;

Parameters
Name	Description
request	IListAutonomousDatabasesRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDatabase>

Returns
Type	Description
void

listAutonomousDatabasesAsync(request, options)

listAutonomousDatabasesAsync(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase>;

Equivalent to listAutonomousDatabases, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListAutonomousDatabasesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AutonomousDatabase. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for the Autonomous Database in the following
   *  format: projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. An expression for filtering the results of the request.
   */
  // const filter = 'abc123'
  /**
   *  Optional. An expression for ordering the results of the request.
   */
  // const orderBy = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListAutonomousDatabases() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listAutonomousDatabasesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListAutonomousDatabases();

listAutonomousDatabasesStream(request, options)

listAutonomousDatabasesStream(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDatabasesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListAutonomousDatabasesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing AutonomousDatabase on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAutonomousDatabasesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAutonomousDbVersions(request, options)

listAutonomousDbVersions(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IAutonomousDbVersion[],
        protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest | null,
        protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsResponse
    ]>;

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

Parameters
Name	Description
request	IListAutonomousDbVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IAutonomousDbVersion[], protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest | null, protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of AutonomousDbVersion. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAutonomousDbVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAutonomousDbVersions(request, options, callback)

listAutonomousDbVersions(request: protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDbVersion>): void;

Parameters
Name	Description
request	IListAutonomousDbVersionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDbVersion>

Returns
Type	Description
void

listAutonomousDbVersions(request, callback)

listAutonomousDbVersions(request: protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDbVersion>): void;

Parameters
Name	Description
request	IListAutonomousDbVersionsRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest, protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IAutonomousDbVersion>

Returns
Type	Description
void

listAutonomousDbVersionsAsync(request, options)

listAutonomousDbVersionsAsync(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.IAutonomousDbVersion>;

Equivalent to listAutonomousDbVersions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListAutonomousDbVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.IAutonomousDbVersion>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AutonomousDbVersion. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for the Autonomous Database in the following
   *  format: projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListAutonomousDbVersions() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listAutonomousDbVersionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListAutonomousDbVersions();

listAutonomousDbVersionsStream(request, options)

listAutonomousDbVersionsStream(request?: protos.google.cloud.oracledatabase.v1.IListAutonomousDbVersionsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListAutonomousDbVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing AutonomousDbVersion on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAutonomousDbVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCloudExadataInfrastructures(request, options)

listCloudExadataInfrastructures(request?: protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure[],
        protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest | null,
        protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresResponse
    ]>;

Lists Exadata Infrastructures in a given project and location.

Parameters
Name	Description
request	IListCloudExadataInfrastructuresRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure[], protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest | null, protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of CloudExadataInfrastructure. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCloudExadataInfrastructuresAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCloudExadataInfrastructures(request, options, callback)

listCloudExadataInfrastructures(request: protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest, protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresResponse | null | undefined, protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure>): void;

Parameters
Name	Description
request	IListCloudExadataInfrastructuresRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest, protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresResponse | null | undefined, protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure>

Returns
Type	Description
void

listCloudExadataInfrastructures(request, callback)

listCloudExadataInfrastructures(request: protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest, protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresResponse | null | undefined, protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure>): void;

Parameters
Name	Description
request	IListCloudExadataInfrastructuresRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest, protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresResponse | null | undefined, protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure>

Returns
Type	Description
void

listCloudExadataInfrastructuresAsync(request, options)

listCloudExadataInfrastructuresAsync(request?: protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure>;

Equivalent to listCloudExadataInfrastructures, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListCloudExadataInfrastructuresRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.ICloudExadataInfrastructure>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CloudExadataInfrastructure. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for CloudExadataInfrastructure in the following
   *  format: projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListCloudExadataInfrastructures() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listCloudExadataInfrastructuresAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListCloudExadataInfrastructures();

listCloudExadataInfrastructuresStream(request, options)

listCloudExadataInfrastructuresStream(request?: protos.google.cloud.oracledatabase.v1.IListCloudExadataInfrastructuresRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListCloudExadataInfrastructuresRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing CloudExadataInfrastructure on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCloudExadataInfrastructuresAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCloudVmClusters(request, options)

listCloudVmClusters(request?: protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.ICloudVmCluster[],
        protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest | null,
        protos.google.cloud.oracledatabase.v1.IListCloudVmClustersResponse
    ]>;

Lists the VM Clusters in a given project and location.

Parameters
Name	Description
request	IListCloudVmClustersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.ICloudVmCluster[], protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest | null, protos.google.cloud.oracledatabase.v1.IListCloudVmClustersResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of CloudVmCluster. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCloudVmClustersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCloudVmClusters(request, options, callback)

listCloudVmClusters(request: protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest, protos.google.cloud.oracledatabase.v1.IListCloudVmClustersResponse | null | undefined, protos.google.cloud.oracledatabase.v1.ICloudVmCluster>): void;

Parameters
Name	Description
request	IListCloudVmClustersRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest, protos.google.cloud.oracledatabase.v1.IListCloudVmClustersResponse | null | undefined, protos.google.cloud.oracledatabase.v1.ICloudVmCluster>

Returns
Type	Description
void

listCloudVmClusters(request, callback)

listCloudVmClusters(request: protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest, protos.google.cloud.oracledatabase.v1.IListCloudVmClustersResponse | null | undefined, protos.google.cloud.oracledatabase.v1.ICloudVmCluster>): void;

Parameters
Name	Description
request	IListCloudVmClustersRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest, protos.google.cloud.oracledatabase.v1.IListCloudVmClustersResponse | null | undefined, protos.google.cloud.oracledatabase.v1.ICloudVmCluster>

Returns
Type	Description
void

listCloudVmClustersAsync(request, options)

listCloudVmClustersAsync(request?: protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.ICloudVmCluster>;

Equivalent to listCloudVmClusters, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListCloudVmClustersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.ICloudVmCluster>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CloudVmCluster. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the parent in the following format:
   *  projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The number of VM clusters to return.
   *  If unspecified, at most 50 VM clusters will be returned.
   *  The maximum value is 1,000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying the page of results the server returns.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. An expression for filtering the results of the request.
   */
  // const filter = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListCloudVmClusters() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listCloudVmClustersAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListCloudVmClusters();

listCloudVmClustersStream(request, options)

listCloudVmClustersStream(request?: protos.google.cloud.oracledatabase.v1.IListCloudVmClustersRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListCloudVmClustersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing CloudVmCluster on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCloudVmClustersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDbNodes(request, options)

listDbNodes(request?: protos.google.cloud.oracledatabase.v1.IListDbNodesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IDbNode[],
        protos.google.cloud.oracledatabase.v1.IListDbNodesRequest | null,
        protos.google.cloud.oracledatabase.v1.IListDbNodesResponse
    ]>;

Lists the database nodes of a VM Cluster.

Parameters
Name	Description
request	IListDbNodesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IDbNode[], protos.google.cloud.oracledatabase.v1.IListDbNodesRequest | null, protos.google.cloud.oracledatabase.v1.IListDbNodesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of DbNode. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDbNodesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDbNodes(request, options, callback)

listDbNodes(request: protos.google.cloud.oracledatabase.v1.IListDbNodesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbNodesRequest, protos.google.cloud.oracledatabase.v1.IListDbNodesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbNode>): void;

Parameters
Name	Description
request	IListDbNodesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbNodesRequest, protos.google.cloud.oracledatabase.v1.IListDbNodesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbNode>

Returns
Type	Description
void

listDbNodes(request, callback)

listDbNodes(request: protos.google.cloud.oracledatabase.v1.IListDbNodesRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbNodesRequest, protos.google.cloud.oracledatabase.v1.IListDbNodesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbNode>): void;

Parameters
Name	Description
request	IListDbNodesRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbNodesRequest, protos.google.cloud.oracledatabase.v1.IListDbNodesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbNode>

Returns
Type	Description
void

listDbNodesAsync(request, options)

listDbNodesAsync(request?: protos.google.cloud.oracledatabase.v1.IListDbNodesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.IDbNode>;

Equivalent to listDbNodes, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListDbNodesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.IDbNode>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DbNode. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for database node in the following format:
   *  projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}.
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the node should return.
   */
  // const pageToken = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListDbNodes() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listDbNodesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDbNodes();

listDbNodesStream(request, options)

listDbNodesStream(request?: protos.google.cloud.oracledatabase.v1.IListDbNodesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListDbNodesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing DbNode on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDbNodesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDbServers(request, options)

listDbServers(request?: protos.google.cloud.oracledatabase.v1.IListDbServersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IDbServer[],
        protos.google.cloud.oracledatabase.v1.IListDbServersRequest | null,
        protos.google.cloud.oracledatabase.v1.IListDbServersResponse
    ]>;

Lists the database servers of an Exadata Infrastructure instance.

Parameters
Name	Description
request	IListDbServersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IDbServer[], protos.google.cloud.oracledatabase.v1.IListDbServersRequest | null, protos.google.cloud.oracledatabase.v1.IListDbServersResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of DbServer. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDbServersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDbServers(request, options, callback)

listDbServers(request: protos.google.cloud.oracledatabase.v1.IListDbServersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbServersRequest, protos.google.cloud.oracledatabase.v1.IListDbServersResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbServer>): void;

Parameters
Name	Description
request	IListDbServersRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbServersRequest, protos.google.cloud.oracledatabase.v1.IListDbServersResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbServer>

Returns
Type	Description
void

listDbServers(request, callback)

listDbServers(request: protos.google.cloud.oracledatabase.v1.IListDbServersRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbServersRequest, protos.google.cloud.oracledatabase.v1.IListDbServersResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbServer>): void;

Parameters
Name	Description
request	IListDbServersRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbServersRequest, protos.google.cloud.oracledatabase.v1.IListDbServersResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbServer>

Returns
Type	Description
void

listDbServersAsync(request, options)

listDbServersAsync(request?: protos.google.cloud.oracledatabase.v1.IListDbServersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.IDbServer>;

Equivalent to listDbServers, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListDbServersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.IDbServer>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DbServer. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for database server in the following format:
   *  projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloudExadataInfrastructure}.
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListDbServers() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listDbServersAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDbServers();

listDbServersStream(request, options)

listDbServersStream(request?: protos.google.cloud.oracledatabase.v1.IListDbServersRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListDbServersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing DbServer on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDbServersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDbSystemShapes(request, options)

listDbSystemShapes(request?: protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IDbSystemShape[],
        protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest | null,
        protos.google.cloud.oracledatabase.v1.IListDbSystemShapesResponse
    ]>;

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

Parameters
Name	Description
request	IListDbSystemShapesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IDbSystemShape[], protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest | null, protos.google.cloud.oracledatabase.v1.IListDbSystemShapesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of DbSystemShape. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDbSystemShapesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDbSystemShapes(request, options, callback)

listDbSystemShapes(request: protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest, protos.google.cloud.oracledatabase.v1.IListDbSystemShapesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbSystemShape>): void;

Parameters
Name	Description
request	IListDbSystemShapesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest, protos.google.cloud.oracledatabase.v1.IListDbSystemShapesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbSystemShape>

Returns
Type	Description
void

listDbSystemShapes(request, callback)

listDbSystemShapes(request: protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest, protos.google.cloud.oracledatabase.v1.IListDbSystemShapesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbSystemShape>): void;

Parameters
Name	Description
request	IListDbSystemShapesRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest, protos.google.cloud.oracledatabase.v1.IListDbSystemShapesResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IDbSystemShape>

Returns
Type	Description
void

listDbSystemShapesAsync(request, options)

listDbSystemShapesAsync(request?: protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.IDbSystemShape>;

Equivalent to listDbSystemShapes, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListDbSystemShapesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.IDbSystemShape>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DbSystemShape. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for Database System Shapes in the following
   *  format: projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListDbSystemShapes() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listDbSystemShapesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDbSystemShapes();

listDbSystemShapesStream(request, options)

listDbSystemShapesStream(request?: protos.google.cloud.oracledatabase.v1.IListDbSystemShapesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListDbSystemShapesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing DbSystemShape on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDbSystemShapesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEntitlements(request, options)

listEntitlements(request?: protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IEntitlement[],
        protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest | null,
        protos.google.cloud.oracledatabase.v1.IListEntitlementsResponse
    ]>;

Lists the entitlements in a given project.

Parameters
Name	Description
request	IListEntitlementsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IEntitlement[], protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest | null, protos.google.cloud.oracledatabase.v1.IListEntitlementsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listEntitlementsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEntitlements(request, options, callback)

listEntitlements(request: protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest, protos.google.cloud.oracledatabase.v1.IListEntitlementsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IEntitlement>): void;

Parameters
Name	Description
request	IListEntitlementsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest, protos.google.cloud.oracledatabase.v1.IListEntitlementsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IEntitlement>

Returns
Type	Description
void

listEntitlements(request, callback)

listEntitlements(request: protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest, protos.google.cloud.oracledatabase.v1.IListEntitlementsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IEntitlement>): void;

Parameters
Name	Description
request	IListEntitlementsRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest, protos.google.cloud.oracledatabase.v1.IListEntitlementsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IEntitlement>

Returns
Type	Description
void

listEntitlementsAsync(request, options)

listEntitlementsAsync(request?: protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.IEntitlement>;

Equivalent to listEntitlements, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListEntitlementsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.IEntitlement>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for the entitlement in the following format:
   *  projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of items to return.
   *  If unspecified, a maximum of 50 entitlements will be returned.
   *  The maximum value is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListEntitlements() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listEntitlementsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListEntitlements();

listEntitlementsStream(request, options)

listEntitlementsStream(request?: protos.google.cloud.oracledatabase.v1.IListEntitlementsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListEntitlementsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listEntitlementsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listGiVersions(request, options)

listGiVersions(request?: protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.oracledatabase.v1.IGiVersion[],
        protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest | null,
        protos.google.cloud.oracledatabase.v1.IListGiVersionsResponse
    ]>;

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

Parameters
Name	Description
request	IListGiVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.oracledatabase.v1.IGiVersion[], protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest | null, protos.google.cloud.oracledatabase.v1.IListGiVersionsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of GiVersion. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listGiVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listGiVersions(request, options, callback)

listGiVersions(request: protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest, protos.google.cloud.oracledatabase.v1.IListGiVersionsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IGiVersion>): void;

Parameters
Name	Description
request	IListGiVersionsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest, protos.google.cloud.oracledatabase.v1.IListGiVersionsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IGiVersion>

Returns
Type	Description
void

listGiVersions(request, callback)

listGiVersions(request: protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest, callback: PaginationCallback<protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest, protos.google.cloud.oracledatabase.v1.IListGiVersionsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IGiVersion>): void;

Parameters
Name	Description
request	IListGiVersionsRequest
callback	PaginationCallback<protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest, protos.google.cloud.oracledatabase.v1.IListGiVersionsResponse | null | undefined, protos.google.cloud.oracledatabase.v1.IGiVersion>

Returns
Type	Description
void

listGiVersionsAsync(request, options)

listGiVersionsAsync(request?: protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.oracledatabase.v1.IGiVersion>;

Equivalent to listGiVersions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListGiVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.oracledatabase.v1.IGiVersion>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing GiVersion. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent value for Grid Infrastructure Version in the following
   *  format: Format: projects/{project}/locations/{location}.
   */
  // const parent = 'abc123'
  /**
   *  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.
   */
  // const pageSize = 1234
  /**
   *  Optional. A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callListGiVersions() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = oracledatabaseClient.listGiVersionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListGiVersions();

listGiVersionsStream(request, options)

listGiVersionsStream(request?: protos.google.cloud.oracledatabase.v1.IListGiVersionsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListGiVersionsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing GiVersion on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listGiVersionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	LocationProtos.google.cloud.location.IListLocationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<google.cloud.location.ILocation>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name	Description
request	ListOperationsRequest The request object that will be sent.
options	CallOptions Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type	Description
AsyncIterable<protos.google.longrunning.ListOperationsResponse>	{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name	Description
project	string
location	string

Returns
Type	Description
string	{string} Resource name string.

matchAutonomousDatabaseBackupFromAutonomousDatabaseBackupName(autonomousDatabaseBackupName)

matchAutonomousDatabaseBackupFromAutonomousDatabaseBackupName(autonomousDatabaseBackupName: string): string | number;

Parse the autonomous_database_backup from AutonomousDatabaseBackup resource.

Parameter
Name	Description
autonomousDatabaseBackupName	string A fully-qualified path representing AutonomousDatabaseBackup resource.

Returns
Type	Description
string | number	{string} A string representing the autonomous_database_backup.

matchAutonomousDatabaseCharacterSetFromAutonomousDatabaseCharacterSetName(autonomousDatabaseCharacterSetName)

matchAutonomousDatabaseCharacterSetFromAutonomousDatabaseCharacterSetName(autonomousDatabaseCharacterSetName: string): string | number;

Parse the autonomous_database_character_set from AutonomousDatabaseCharacterSet resource.

Parameter
Name	Description
autonomousDatabaseCharacterSetName	string A fully-qualified path representing AutonomousDatabaseCharacterSet resource.

Returns
Type	Description
string | number	{string} A string representing the autonomous_database_character_set.

matchAutonomousDatabaseFromAutonomousDatabaseName(autonomousDatabaseName)

matchAutonomousDatabaseFromAutonomousDatabaseName(autonomousDatabaseName: string): string | number;

Parse the autonomous_database from AutonomousDatabase resource.

Parameter
Name	Description
autonomousDatabaseName	string A fully-qualified path representing AutonomousDatabase resource.

Returns
Type	Description
string | number	{string} A string representing the autonomous_database.

matchAutonomousDbVersionFromAutonomousDbVersionName(autonomousDbVersionName)

matchAutonomousDbVersionFromAutonomousDbVersionName(autonomousDbVersionName: string): string | number;

Parse the autonomous_db_version from AutonomousDbVersion resource.

Parameter
Name	Description
autonomousDbVersionName	string A fully-qualified path representing AutonomousDbVersion resource.

Returns
Type	Description
string | number	{string} A string representing the autonomous_db_version.

matchCloudExadataInfrastructureFromCloudExadataInfrastructureName(cloudExadataInfrastructureName)

matchCloudExadataInfrastructureFromCloudExadataInfrastructureName(cloudExadataInfrastructureName: string): string | number;

Parse the cloud_exadata_infrastructure from CloudExadataInfrastructure resource.

Parameter
Name	Description
cloudExadataInfrastructureName	string A fully-qualified path representing CloudExadataInfrastructure resource.

Returns
Type	Description
string | number	{string} A string representing the cloud_exadata_infrastructure.

matchCloudExadataInfrastructureFromDbServerName(dbServerName)

matchCloudExadataInfrastructureFromDbServerName(dbServerName: string): string | number;

Parse the cloud_exadata_infrastructure from DbServer resource.

Parameter
Name	Description
dbServerName	string A fully-qualified path representing DbServer resource.

Returns
Type	Description
string | number	{string} A string representing the cloud_exadata_infrastructure.

matchCloudVmClusterFromCloudVmClusterName(cloudVmClusterName)

matchCloudVmClusterFromCloudVmClusterName(cloudVmClusterName: string): string | number;

Parse the cloud_vm_cluster from CloudVmCluster resource.

Parameter
Name	Description
cloudVmClusterName	string A fully-qualified path representing CloudVmCluster resource.

Returns
Type	Description
string | number	{string} A string representing the cloud_vm_cluster.

matchCloudVmClusterFromDbNodeName(dbNodeName)

matchCloudVmClusterFromDbNodeName(dbNodeName: string): string | number;

Parse the cloud_vm_cluster from DbNode resource.

Parameter
Name	Description
dbNodeName	string A fully-qualified path representing DbNode resource.

Returns
Type	Description
string | number	{string} A string representing the cloud_vm_cluster.

matchDbNodeFromDbNodeName(dbNodeName)

matchDbNodeFromDbNodeName(dbNodeName: string): string | number;

Parse the db_node from DbNode resource.

Parameter
Name	Description
dbNodeName	string A fully-qualified path representing DbNode resource.

Returns
Type	Description
string | number	{string} A string representing the db_node.

matchDbServerFromDbServerName(dbServerName)

matchDbServerFromDbServerName(dbServerName: string): string | number;

Parse the db_server from DbServer resource.

Parameter
Name	Description
dbServerName	string A fully-qualified path representing DbServer resource.

Returns
Type	Description
string | number	{string} A string representing the db_server.

matchDbSystemShapeFromDbSystemShapeName(dbSystemShapeName)

matchDbSystemShapeFromDbSystemShapeName(dbSystemShapeName: string): string | number;

Parse the db_system_shape from DbSystemShape resource.

Parameter
Name	Description
dbSystemShapeName	string A fully-qualified path representing DbSystemShape resource.

Returns
Type	Description
string | number	{string} A string representing the db_system_shape.

matchEntitlementFromEntitlementName(entitlementName)

matchEntitlementFromEntitlementName(entitlementName: string): string | number;

Parse the entitlement from Entitlement resource.

Parameter
Name	Description
entitlementName	string A fully-qualified path representing Entitlement resource.

Returns
Type	Description
string | number	{string} A string representing the entitlement.

matchGiVersionFromGiVersionName(giVersionName)

matchGiVersionFromGiVersionName(giVersionName: string): string | number;

Parse the gi_version from GiVersion resource.

Parameter
Name	Description
giVersionName	string A fully-qualified path representing GiVersion resource.

Returns
Type	Description
string | number	{string} A string representing the gi_version.

matchLocationFromAutonomousDatabaseBackupName(autonomousDatabaseBackupName)

matchLocationFromAutonomousDatabaseBackupName(autonomousDatabaseBackupName: string): string | number;

Parse the location from AutonomousDatabaseBackup resource.

Parameter
Name	Description
autonomousDatabaseBackupName	string A fully-qualified path representing AutonomousDatabaseBackup resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromAutonomousDatabaseCharacterSetName(autonomousDatabaseCharacterSetName)

matchLocationFromAutonomousDatabaseCharacterSetName(autonomousDatabaseCharacterSetName: string): string | number;

Parse the location from AutonomousDatabaseCharacterSet resource.

Parameter
Name	Description
autonomousDatabaseCharacterSetName	string A fully-qualified path representing AutonomousDatabaseCharacterSet resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromAutonomousDatabaseName(autonomousDatabaseName)

matchLocationFromAutonomousDatabaseName(autonomousDatabaseName: string): string | number;

Parse the location from AutonomousDatabase resource.

Parameter
Name	Description
autonomousDatabaseName	string A fully-qualified path representing AutonomousDatabase resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromAutonomousDbVersionName(autonomousDbVersionName)

matchLocationFromAutonomousDbVersionName(autonomousDbVersionName: string): string | number;

Parse the location from AutonomousDbVersion resource.

Parameter
Name	Description
autonomousDbVersionName	string A fully-qualified path representing AutonomousDbVersion resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromCloudExadataInfrastructureName(cloudExadataInfrastructureName)

matchLocationFromCloudExadataInfrastructureName(cloudExadataInfrastructureName: string): string | number;

Parse the location from CloudExadataInfrastructure resource.

Parameter
Name	Description
cloudExadataInfrastructureName	string A fully-qualified path representing CloudExadataInfrastructure resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromCloudVmClusterName(cloudVmClusterName)

matchLocationFromCloudVmClusterName(cloudVmClusterName: string): string | number;

Parse the location from CloudVmCluster resource.

Parameter
Name	Description
cloudVmClusterName	string A fully-qualified path representing CloudVmCluster resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromDbNodeName(dbNodeName)

matchLocationFromDbNodeName(dbNodeName: string): string | number;

Parse the location from DbNode resource.

Parameter
Name	Description
dbNodeName	string A fully-qualified path representing DbNode resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromDbServerName(dbServerName)

matchLocationFromDbServerName(dbServerName: string): string | number;

Parse the location from DbServer resource.

Parameter
Name	Description
dbServerName	string A fully-qualified path representing DbServer resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromDbSystemShapeName(dbSystemShapeName)

matchLocationFromDbSystemShapeName(dbSystemShapeName: string): string | number;

Parse the location from DbSystemShape resource.

Parameter
Name	Description
dbSystemShapeName	string A fully-qualified path representing DbSystemShape resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromEntitlementName(entitlementName)

matchLocationFromEntitlementName(entitlementName: string): string | number;

Parse the location from Entitlement resource.

Parameter
Name	Description
entitlementName	string A fully-qualified path representing Entitlement resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromGiVersionName(giVersionName)

matchLocationFromGiVersionName(giVersionName: string): string | number;

Parse the location from GiVersion resource.

Parameter
Name	Description
giVersionName	string A fully-qualified path representing GiVersion resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name	Description
locationName	string A fully-qualified path representing Location resource.

Returns
Type	Description
string | number	{string} A string representing the location.

matchProjectFromAutonomousDatabaseBackupName(autonomousDatabaseBackupName)

matchProjectFromAutonomousDatabaseBackupName(autonomousDatabaseBackupName: string): string | number;

Parse the project from AutonomousDatabaseBackup resource.

Parameter
Name	Description
autonomousDatabaseBackupName	string A fully-qualified path representing AutonomousDatabaseBackup resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromAutonomousDatabaseCharacterSetName(autonomousDatabaseCharacterSetName)

matchProjectFromAutonomousDatabaseCharacterSetName(autonomousDatabaseCharacterSetName: string): string | number;

Parse the project from AutonomousDatabaseCharacterSet resource.

Parameter
Name	Description
autonomousDatabaseCharacterSetName	string A fully-qualified path representing AutonomousDatabaseCharacterSet resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromAutonomousDatabaseName(autonomousDatabaseName)

matchProjectFromAutonomousDatabaseName(autonomousDatabaseName: string): string | number;

Parse the project from AutonomousDatabase resource.

Parameter
Name	Description
autonomousDatabaseName	string A fully-qualified path representing AutonomousDatabase resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromAutonomousDbVersionName(autonomousDbVersionName)

matchProjectFromAutonomousDbVersionName(autonomousDbVersionName: string): string | number;

Parse the project from AutonomousDbVersion resource.

Parameter
Name	Description
autonomousDbVersionName	string A fully-qualified path representing AutonomousDbVersion resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromCloudExadataInfrastructureName(cloudExadataInfrastructureName)

matchProjectFromCloudExadataInfrastructureName(cloudExadataInfrastructureName: string): string | number;

Parse the project from CloudExadataInfrastructure resource.

Parameter
Name	Description
cloudExadataInfrastructureName	string A fully-qualified path representing CloudExadataInfrastructure resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromCloudVmClusterName(cloudVmClusterName)

matchProjectFromCloudVmClusterName(cloudVmClusterName: string): string | number;

Parse the project from CloudVmCluster resource.

Parameter
Name	Description
cloudVmClusterName	string A fully-qualified path representing CloudVmCluster resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromDbNodeName(dbNodeName)

matchProjectFromDbNodeName(dbNodeName: string): string | number;

Parse the project from DbNode resource.

Parameter
Name	Description
dbNodeName	string A fully-qualified path representing DbNode resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromDbServerName(dbServerName)

matchProjectFromDbServerName(dbServerName: string): string | number;

Parse the project from DbServer resource.

Parameter
Name	Description
dbServerName	string A fully-qualified path representing DbServer resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromDbSystemShapeName(dbSystemShapeName)

matchProjectFromDbSystemShapeName(dbSystemShapeName: string): string | number;

Parse the project from DbSystemShape resource.

Parameter
Name	Description
dbSystemShapeName	string A fully-qualified path representing DbSystemShape resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromEntitlementName(entitlementName)

matchProjectFromEntitlementName(entitlementName: string): string | number;

Parse the project from Entitlement resource.

Parameter
Name	Description
entitlementName	string A fully-qualified path representing Entitlement resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromGiVersionName(giVersionName)

matchProjectFromGiVersionName(giVersionName: string): string | number;

Parse the project from GiVersion resource.

Parameter
Name	Description
giVersionName	string A fully-qualified path representing GiVersion resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name	Description
locationName	string A fully-qualified path representing Location resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name	Description
projectName	string A fully-qualified path representing Project resource.

Returns
Type	Description
string | number	{string} A string representing the project.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
project	string

Returns
Type	Description
string	{string} Resource name string.

restoreAutonomousDatabase(request, options)

restoreAutonomousDatabase(request?: protos.google.cloud.oracledatabase.v1.IRestoreAutonomousDatabaseRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Restores a single Autonomous Database.

Parameters
Name	Description
request	IRestoreAutonomousDatabaseRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the Autonomous Database in the following format:
   *  projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.
   */
  // const name = 'abc123'
  /**
   *  Required. The time and date to restore the database to.
   */
  // const restoreTime = {}

  // Imports the Oracledatabase library
  const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

  // Instantiates a client
  const oracledatabaseClient = new OracleDatabaseClient();

  async function callRestoreAutonomousDatabase() {
    // Construct request
    const request = {
      name,
      restoreTime,
    };

    // Run request
    const [operation] = await oracledatabaseClient.restoreAutonomousDatabase(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRestoreAutonomousDatabase();

restoreAutonomousDatabase(request, options, callback)

restoreAutonomousDatabase(request: protos.google.cloud.oracledatabase.v1.IRestoreAutonomousDatabaseRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IRestoreAutonomousDatabaseRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

restoreAutonomousDatabase(request, callback)

restoreAutonomousDatabase(request: protos.google.cloud.oracledatabase.v1.IRestoreAutonomousDatabaseRequest, callback: Callback<LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IRestoreAutonomousDatabaseRequest
callback	Callback<LROperation<protos.google.cloud.oracledatabase.v1.IAutonomousDatabase, protos.google.cloud.oracledatabase.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void