Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Oracledatabase

import { Oracledatabase } from "https://googleapis.deno.dev/v1/oracledatabase:v1.ts";

The Oracle Database@Google Cloud API provides a set of APIs to manage Oracle database services, such as Exadata and Autonomous Databases.

class Oracledatabase {
constructor(client?: CredentialsClient, baseUrl?: string);
async projectsLocationsAutonomousDatabaseBackupsList(parent: string, opts?: ProjectsLocationsAutonomousDatabaseBackupsListOptions): Promise<ListAutonomousDatabaseBackupsResponse>;
async projectsLocationsAutonomousDatabaseCharacterSetsList(parent: string, opts?: ProjectsLocationsAutonomousDatabaseCharacterSetsListOptions): Promise<ListAutonomousDatabaseCharacterSetsResponse>;
async projectsLocationsAutonomousDatabasesCreate(
parent: string,
): Promise<Operation>;
async projectsLocationsAutonomousDatabasesDelete(name: string, opts?: ProjectsLocationsAutonomousDatabasesDeleteOptions): Promise<Operation>;
async projectsLocationsAutonomousDatabasesGenerateWallet(name: string, req: GenerateAutonomousDatabaseWalletRequest): Promise<GenerateAutonomousDatabaseWalletResponse>;
async projectsLocationsAutonomousDatabasesGet(name: string): Promise<AutonomousDatabase>;
async projectsLocationsAutonomousDatabasesList(parent: string, opts?: ProjectsLocationsAutonomousDatabasesListOptions): Promise<ListAutonomousDatabasesResponse>;
async projectsLocationsAutonomousDatabasesRestart(name: string, req: RestartAutonomousDatabaseRequest): Promise<Operation>;
async projectsLocationsAutonomousDatabasesRestore(name: string, req: RestoreAutonomousDatabaseRequest): Promise<Operation>;
async projectsLocationsAutonomousDatabasesStart(name: string, req: StartAutonomousDatabaseRequest): Promise<Operation>;
async projectsLocationsAutonomousDatabasesStop(name: string, req: StopAutonomousDatabaseRequest): Promise<Operation>;
async projectsLocationsAutonomousDatabasesSwitchover(name: string, req: SwitchoverAutonomousDatabaseRequest): Promise<Operation>;
async projectsLocationsAutonomousDbVersionsList(parent: string, opts?: ProjectsLocationsAutonomousDbVersionsListOptions): Promise<ListAutonomousDbVersionsResponse>;
async projectsLocationsCloudExadataInfrastructuresCreate(
parent: string,
): Promise<Operation>;
async projectsLocationsCloudExadataInfrastructuresDbServersList(parent: string, opts?: ProjectsLocationsCloudExadataInfrastructuresDbServersListOptions): Promise<ListDbServersResponse>;
async projectsLocationsCloudExadataInfrastructuresDelete(name: string, opts?: ProjectsLocationsCloudExadataInfrastructuresDeleteOptions): Promise<Operation>;
async projectsLocationsCloudExadataInfrastructuresGet(name: string): Promise<CloudExadataInfrastructure>;
async projectsLocationsCloudExadataInfrastructuresList(parent: string, opts?: ProjectsLocationsCloudExadataInfrastructuresListOptions): Promise<ListCloudExadataInfrastructuresResponse>;
async projectsLocationsCloudVmClustersCreate(
parent: string,
): Promise<Operation>;
async projectsLocationsCloudVmClustersDbNodesList(parent: string, opts?: ProjectsLocationsCloudVmClustersDbNodesListOptions): Promise<ListDbNodesResponse>;
async projectsLocationsCloudVmClustersDelete(name: string, opts?: ProjectsLocationsCloudVmClustersDeleteOptions): Promise<Operation>;
async projectsLocationsCloudVmClustersGet(name: string): Promise<CloudVmCluster>;
async projectsLocationsCloudVmClustersList(parent: string, opts?: ProjectsLocationsCloudVmClustersListOptions): Promise<ListCloudVmClustersResponse>;
async projectsLocationsDatabaseCharacterSetsList(parent: string, opts?: ProjectsLocationsDatabaseCharacterSetsListOptions): Promise<ListDatabaseCharacterSetsResponse>;
async projectsLocationsDatabasesGet(name: string): Promise<Database>;
async projectsLocationsDatabasesList(parent: string, opts?: ProjectsLocationsDatabasesListOptions): Promise<ListDatabasesResponse>;
async projectsLocationsDbSystemInitialStorageSizesList(parent: string, opts?: ProjectsLocationsDbSystemInitialStorageSizesListOptions): Promise<ListDbSystemInitialStorageSizesResponse>;
async projectsLocationsDbSystemsCreate(
parent: string,
req: DbSystem,
): Promise<Operation>;
async projectsLocationsDbSystemsDelete(name: string, opts?: ProjectsLocationsDbSystemsDeleteOptions): Promise<Operation>;
async projectsLocationsDbSystemsGet(name: string): Promise<DbSystem>;
async projectsLocationsDbSystemShapesList(parent: string, opts?: ProjectsLocationsDbSystemShapesListOptions): Promise<ListDbSystemShapesResponse>;
async projectsLocationsDbSystemsList(parent: string, opts?: ProjectsLocationsDbSystemsListOptions): Promise<ListDbSystemsResponse>;
async projectsLocationsDbVersionsList(parent: string, opts?: ProjectsLocationsDbVersionsListOptions): Promise<ListDbVersionsResponse>;
async projectsLocationsEntitlementsList(parent: string, opts?: ProjectsLocationsEntitlementsListOptions): Promise<ListEntitlementsResponse>;
async projectsLocationsGet(name: string): Promise<Location>;
async projectsLocationsGiVersionsList(parent: string, opts?: ProjectsLocationsGiVersionsListOptions): Promise<ListGiVersionsResponse>;
async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;
async projectsLocationsOdbNetworksCreate(
parent: string,
): Promise<Operation>;
async projectsLocationsOdbNetworksDelete(name: string, opts?: ProjectsLocationsOdbNetworksDeleteOptions): Promise<Operation>;
async projectsLocationsOdbNetworksGet(name: string): Promise<OdbNetwork>;
async projectsLocationsOdbNetworksList(parent: string, opts?: ProjectsLocationsOdbNetworksListOptions): Promise<ListOdbNetworksResponse>;
async projectsLocationsOdbNetworksOdbSubnetsCreate(
parent: string,
req: OdbSubnet,
): Promise<Operation>;
async projectsLocationsOdbNetworksOdbSubnetsDelete(name: string, opts?: ProjectsLocationsOdbNetworksOdbSubnetsDeleteOptions): Promise<Operation>;
async projectsLocationsOdbNetworksOdbSubnetsGet(name: string): Promise<OdbSubnet>;
async projectsLocationsOdbNetworksOdbSubnetsList(parent: string, opts?: ProjectsLocationsOdbNetworksOdbSubnetsListOptions): Promise<ListOdbSubnetsResponse>;
async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;
async projectsLocationsOperationsDelete(name: string): Promise<Empty>;
async projectsLocationsOperationsGet(name: string): Promise<Operation>;
async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;
async projectsLocationsPluggableDatabasesGet(name: string): Promise<PluggableDatabase>;
async projectsLocationsPluggableDatabasesList(parent: string, opts?: ProjectsLocationsPluggableDatabasesListOptions): Promise<ListPluggableDatabasesResponse>;
}

§Constructors

§
new Oracledatabase(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
projectsLocationsAutonomousDatabaseBackupsList(parent: string, opts?: ProjectsLocationsAutonomousDatabaseBackupsListOptions): Promise<ListAutonomousDatabaseBackupsResponse>
[src]

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

@param parent

Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project}/locations/{location}.

§
projectsLocationsAutonomousDatabaseCharacterSetsList(parent: string, opts?: ProjectsLocationsAutonomousDatabaseCharacterSetsListOptions): Promise<ListAutonomousDatabaseCharacterSetsResponse>
[src]

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

@param parent

Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.

§
projectsLocationsAutonomousDatabasesCreate(parent: string, req: AutonomousDatabase, opts?: ProjectsLocationsAutonomousDatabasesCreateOptions): Promise<Operation>
[src]

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

@param parent

Required. The name of the parent in the following format: projects/{project}/locations/{location}.

§
projectsLocationsAutonomousDatabasesDelete(name: string, opts?: ProjectsLocationsAutonomousDatabasesDeleteOptions): Promise<Operation>
[src]

Deletes a single Autonomous Database.

@param name

Required. The name of the resource in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

§
projectsLocationsAutonomousDatabasesGenerateWallet(name: string, req: GenerateAutonomousDatabaseWalletRequest): Promise<GenerateAutonomousDatabaseWalletResponse>
[src]

Generates a wallet for an Autonomous Database.

@param name

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

§
projectsLocationsAutonomousDatabasesGet(name: string): Promise<AutonomousDatabase>
[src]

Gets the details of a single Autonomous Database.

@param name

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

§
projectsLocationsAutonomousDatabasesList(parent: string, opts?: ProjectsLocationsAutonomousDatabasesListOptions): Promise<ListAutonomousDatabasesResponse>
[src]

Lists the Autonomous Databases in a given project and location.

@param parent

Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.

§
projectsLocationsAutonomousDatabasesRestart(name: string, req: RestartAutonomousDatabaseRequest): Promise<Operation>
[src]

Restarts an Autonomous Database.

@param name

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

§
projectsLocationsAutonomousDatabasesRestore(name: string, req: RestoreAutonomousDatabaseRequest): Promise<Operation>
[src]

Restores a single Autonomous Database.

@param name

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

§
projectsLocationsAutonomousDatabasesStart(name: string, req: StartAutonomousDatabaseRequest): Promise<Operation>
[src]

Starts an Autonomous Database.

@param name

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

§
projectsLocationsAutonomousDatabasesStop(name: string, req: StopAutonomousDatabaseRequest): Promise<Operation>
[src]

Stops an Autonomous Database.

@param name

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

§
projectsLocationsAutonomousDatabasesSwitchover(name: string, req: SwitchoverAutonomousDatabaseRequest): Promise<Operation>
[src]

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

@param name

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

§
projectsLocationsAutonomousDbVersionsList(parent: string, opts?: ProjectsLocationsAutonomousDbVersionsListOptions): Promise<ListAutonomousDbVersionsResponse>
[src]

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

@param parent

Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.

§
projectsLocationsCloudExadataInfrastructuresCreate(parent: string, req: CloudExadataInfrastructure, opts?: ProjectsLocationsCloudExadataInfrastructuresCreateOptions): Promise<Operation>
[src]

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

@param parent

Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.

§
projectsLocationsCloudExadataInfrastructuresDbServersList(parent: string, opts?: ProjectsLocationsCloudExadataInfrastructuresDbServersListOptions): Promise<ListDbServersResponse>
[src]

Lists the database servers of an Exadata Infrastructure instance.

@param parent

Required. The parent value for database server in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloudExadataInfrastructure}.

§
projectsLocationsCloudExadataInfrastructuresDelete(name: string, opts?: ProjectsLocationsCloudExadataInfrastructuresDeleteOptions): Promise<Operation>
[src]

Deletes a single Exadata Infrastructure.

@param name

Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.

§
projectsLocationsCloudExadataInfrastructuresGet(name: string): Promise<CloudExadataInfrastructure>
[src]

Gets details of a single Exadata Infrastructure.

@param name

Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.

§
projectsLocationsCloudExadataInfrastructuresList(parent: string, opts?: ProjectsLocationsCloudExadataInfrastructuresListOptions): Promise<ListCloudExadataInfrastructuresResponse>
[src]

Lists Exadata Infrastructures in a given project and location.

@param parent

Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.

§
projectsLocationsCloudVmClustersCreate(parent: string, req: CloudVmCluster, opts?: ProjectsLocationsCloudVmClustersCreateOptions): Promise<Operation>
[src]

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

@param parent

Required. The name of the parent in the following format: projects/{project}/locations/{location}.

§
projectsLocationsCloudVmClustersDbNodesList(parent: string, opts?: ProjectsLocationsCloudVmClustersDbNodesListOptions): Promise<ListDbNodesResponse>
[src]

Lists the database nodes of a VM Cluster.

@param parent

Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}. .

§
projectsLocationsCloudVmClustersDelete(name: string, opts?: ProjectsLocationsCloudVmClustersDeleteOptions): Promise<Operation>
[src]

Deletes a single VM Cluster.

@param name

Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.

§
projectsLocationsCloudVmClustersGet(name: string): Promise<CloudVmCluster>
[src]

Gets details of a single VM Cluster.

@param name

Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.

§
projectsLocationsCloudVmClustersList(parent: string, opts?: ProjectsLocationsCloudVmClustersListOptions): Promise<ListCloudVmClustersResponse>
[src]

Lists the VM Clusters in a given project and location.

@param parent

Required. The name of the parent in the following format: projects/{project}/locations/{location}.

§
projectsLocationsDatabaseCharacterSetsList(parent: string, opts?: ProjectsLocationsDatabaseCharacterSetsListOptions): Promise<ListDatabaseCharacterSetsResponse>
[src]

List DatabaseCharacterSets for the given project and location.

@param parent

Required. The parent value for DatabaseCharacterSets in the following format: projects/{project}/locations/{location}.

§
projectsLocationsDatabasesGet(name: string): Promise<Database>
[src]

Gets details of a single Database.

@param name

Required. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}

§
projectsLocationsDatabasesList(parent: string, opts?: ProjectsLocationsDatabasesListOptions): Promise<ListDatabasesResponse>
[src]

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

@param parent

Required. The parent resource name in the following format: projects/{project}/locations/{region}

§
projectsLocationsDbSystemInitialStorageSizesList(parent: string, opts?: ProjectsLocationsDbSystemInitialStorageSizesListOptions): Promise<ListDbSystemInitialStorageSizesResponse>
[src]

Lists all the DbSystemInitialStorageSizes for the given project and location.

@param parent

Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project}/locations/{location}

§
projectsLocationsDbSystemsCreate(parent: string, req: DbSystem, opts?: ProjectsLocationsDbSystemsCreateOptions): Promise<Operation>
[src]

Creates a new DbSystem in a given project and location.

@param parent

Required. The value for parent of the DbSystem in the following format: projects/{project}/locations/{location}.

§
projectsLocationsDbSystemsDelete(name: string, opts?: ProjectsLocationsDbSystemsDeleteOptions): Promise<Operation>
[src]

Deletes a single DbSystem.

@param name

Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.

§
projectsLocationsDbSystemsGet(name: string): Promise<DbSystem>
[src]

Gets details of a single DbSystem.

@param name

Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.

§
projectsLocationsDbSystemShapesList(parent: string, opts?: ProjectsLocationsDbSystemShapesListOptions): Promise<ListDbSystemShapesResponse>
[src]

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

@param parent

Required. The parent value for Database System Shapes in the following format: projects/{project}/locations/{location}.

§
projectsLocationsDbSystemsList(parent: string, opts?: ProjectsLocationsDbSystemsListOptions): Promise<ListDbSystemsResponse>
[src]

Lists all the DbSystems for the given project and location.

@param parent

Required. The parent value for DbSystems in the following format: projects/{project}/locations/{location}.

§
projectsLocationsDbVersionsList(parent: string, opts?: ProjectsLocationsDbVersionsListOptions): Promise<ListDbVersionsResponse>
[src]

List DbVersions for the given project and location.

@param parent

Required. The parent value for the DbVersion resource with the format: projects/{project}/locations/{location}

§
projectsLocationsEntitlementsList(parent: string, opts?: ProjectsLocationsEntitlementsListOptions): Promise<ListEntitlementsResponse>
[src]

Lists the entitlements in a given project.

@param parent

Required. The parent value for the entitlement in the following format: projects/{project}/locations/{location}.

§
projectsLocationsGet(name: string): Promise<Location>
[src]

Gets information about a location.

@param name

Resource name for the location.

§
projectsLocationsGiVersionsList(parent: string, opts?: ProjectsLocationsGiVersionsListOptions): Promise<ListGiVersionsResponse>
[src]

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

@param parent

Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}.

§
projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>
[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

§
projectsLocationsOdbNetworksCreate(parent: string, req: OdbNetwork, opts?: ProjectsLocationsOdbNetworksCreateOptions): Promise<Operation>
[src]

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

@param parent

Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.

§
projectsLocationsOdbNetworksDelete(name: string, opts?: ProjectsLocationsOdbNetworksDeleteOptions): Promise<Operation>
[src]

Deletes a single ODB Network.

@param name

Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.

§
projectsLocationsOdbNetworksGet(name: string): Promise<OdbNetwork>
[src]

Gets details of a single ODB Network.

@param name

Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.

§
projectsLocationsOdbNetworksList(parent: string, opts?: ProjectsLocationsOdbNetworksListOptions): Promise<ListOdbNetworksResponse>
[src]

Lists the ODB Networks in a given project and location.

@param parent

Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.

§
projectsLocationsOdbNetworksOdbSubnetsCreate(parent: string, req: OdbSubnet, opts?: ProjectsLocationsOdbNetworksOdbSubnetsCreateOptions): Promise<Operation>
[src]

Creates a new ODB Subnet in a given ODB Network.

@param parent

Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.

§
projectsLocationsOdbNetworksOdbSubnetsDelete(name: string, opts?: ProjectsLocationsOdbNetworksOdbSubnetsDeleteOptions): Promise<Operation>
[src]

Deletes a single ODB Subnet.

@param name

Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.

§
projectsLocationsOdbNetworksOdbSubnetsGet(name: string): Promise<OdbSubnet>
[src]

Gets details of a single ODB Subnet.

@param name

Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.

§
projectsLocationsOdbNetworksOdbSubnetsList(parent: string, opts?: ProjectsLocationsOdbNetworksOdbSubnetsListOptions): Promise<ListOdbSubnetsResponse>
[src]

Lists all the ODB Subnets in a given ODB Network.

@param parent

Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.

§
projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>
[src]

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 Operations.GetOperation 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 Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsOperationsDelete(name: string): Promise<Empty>
[src]

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.

@param name

The name of the operation resource to be deleted.

§
projectsLocationsOperationsGet(name: string): Promise<Operation>
[src]

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.

@param name

The name of the operation resource.

§
projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>
[src]

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

@param name

The name of the operation's parent resource.

§
projectsLocationsPluggableDatabasesGet(name: string): Promise<PluggableDatabase>
[src]

Gets details of a single PluggableDatabase.

@param name

Required. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}

§
projectsLocationsPluggableDatabasesList(parent: string, opts?: ProjectsLocationsPluggableDatabasesListOptions): Promise<ListPluggableDatabasesResponse>
[src]

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

@param parent

Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}