googleapis
Version:
Google APIs Client Library for Node.js
1,260 lines • 424 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace oracledatabase_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Oracle Database@Google Cloud API
*
* The Oracle Database@Google Cloud API provides a set of APIs to manage Oracle database services, such as Exadata and Autonomous Databases.
*
* @example
* ```js
* const {google} = require('googleapis');
* const oracledatabase = google.oracledatabase('v1');
* ```
*/
export class Oracledatabase {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A list of all connection strings that can be used to connect to the Autonomous Database.
*/
export interface Schema$AllConnectionStrings {
/**
* Output only. The database service provides the highest level of resources to each SQL statement.
*/
high?: string | null;
/**
* Output only. The database service provides the least level of resources to each SQL statement.
*/
low?: string | null;
/**
* Output only. The database service provides a lower level of resources to each SQL statement.
*/
medium?: string | null;
}
/**
* Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/
*/
export interface Schema$AutonomousDatabase {
/**
* Optional. Immutable. The password for the default ADMIN user.
*/
adminPassword?: string | null;
/**
* Optional. Immutable. The subnet CIDR range for the Autonomous Database.
*/
cidr?: string | null;
/**
* Output only. The date and time that the Autonomous Database was created.
*/
createTime?: string | null;
/**
* Optional. Immutable. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.
*/
database?: string | null;
/**
* Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project\}/locations/{location\}`.
*/
disasterRecoverySupportedLocations?: string[] | null;
/**
* Optional. Immutable. The display name for the Autonomous Database. The name does not have to be unique within your project.
*/
displayName?: string | null;
/**
* Output only. The ID of the subscription entitlement associated with the Autonomous Database.
*/
entitlementId?: string | null;
/**
* Optional. The labels or tags associated with the Autonomous Database.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Identifier. The name of the Autonomous Database resource in the following format: projects/{project\}/locations/{region\}/autonomousDatabases/{autonomous_database\}
*/
name?: string | null;
/**
* Optional. Immutable. The name of the VPC network used by the Autonomous Database in the following format: projects/{project\}/global/networks/{network\}
*/
network?: string | null;
/**
* Optional. Immutable. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
*/
odbNetwork?: string | null;
/**
* Optional. Immutable. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}
*/
odbSubnet?: string | null;
/**
* Output only. The peer Autonomous Database names of the given Autonomous Database.
*/
peerAutonomousDatabases?: string[] | null;
/**
* Optional. The properties of the Autonomous Database.
*/
properties?: Schema$AutonomousDatabaseProperties;
/**
* Optional. Immutable. The source Autonomous Database configuration for the standby Autonomous Database. The source Autonomous Database is configured while creating the Peer Autonomous Database and can't be updated after creation.
*/
sourceConfig?: Schema$SourceConfig;
}
/**
* Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex
*/
export interface Schema$AutonomousDatabaseApex {
/**
* Output only. The Oracle APEX Application Development version.
*/
apexVersion?: string | null;
/**
* Output only. The Oracle REST Data Services (ORDS) version.
*/
ordsVersion?: string | null;
}
/**
* Details of the Autonomous Database Backup resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/
*/
export interface Schema$AutonomousDatabaseBackup {
/**
* Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project\}/locations/{region\}/autonomousDatabases/{autonomous_database\}
*/
autonomousDatabase?: string | null;
/**
* Optional. User friendly name for the Backup. The name does not have to be unique.
*/
displayName?: string | null;
/**
* Optional. labels or tags associated with the resource.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project\}/locations/{region\}/autonomousDatabaseBackups/{autonomous_database_backup\}
*/
name?: string | null;
/**
* Optional. Various properties of the backup.
*/
properties?: Schema$AutonomousDatabaseBackupProperties;
}
/**
* Properties of the Autonomous Database Backup resource.
*/
export interface Schema$AutonomousDatabaseBackupProperties {
/**
* Output only. Timestamp until when the backup will be available.
*/
availableTillTime?: string | null;
/**
* Output only. The OCID of the compartment.
*/
compartmentId?: string | null;
/**
* Output only. The quantity of data in the database, in terabytes.
*/
databaseSizeTb?: number | null;
/**
* Output only. A valid Oracle Database version for Autonomous Database.
*/
dbVersion?: string | null;
/**
* Output only. The date and time the backup completed.
*/
endTime?: string | null;
/**
* Output only. Indicates if the backup is automatic or user initiated.
*/
isAutomaticBackup?: boolean | null;
/**
* Output only. Indicates if the backup is long term backup.
*/
isLongTermBackup?: boolean | null;
/**
* Output only. Indicates if the backup can be used to restore the Autonomous Database.
*/
isRestorable?: boolean | null;
/**
* Optional. The OCID of the key store of Oracle Vault.
*/
keyStoreId?: string | null;
/**
* Optional. The wallet name for Oracle Key Vault.
*/
keyStoreWallet?: string | null;
/**
* Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
*/
kmsKeyId?: string | null;
/**
* Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
*/
kmsKeyVersionId?: string | null;
/**
* Output only. Additional information about the current lifecycle state.
*/
lifecycleDetails?: string | null;
/**
* Output only. The lifecycle state of the backup.
*/
lifecycleState?: string | null;
/**
* Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
*/
ocid?: string | null;
/**
* Optional. Retention period in days for the backup.
*/
retentionPeriodDays?: number | null;
/**
* Output only. The backup size in terabytes.
*/
sizeTb?: number | null;
/**
* Output only. The date and time the backup started.
*/
startTime?: string | null;
/**
* Output only. The type of the backup.
*/
type?: string | null;
/**
* Optional. The OCID of the vault.
*/
vaultId?: string | null;
}
/**
* Details of the Autonomous Database character set resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/
*/
export interface Schema$AutonomousDatabaseCharacterSet {
/**
* Output only. The character set name for the Autonomous Database which is the ID in the resource name.
*/
characterSet?: string | null;
/**
* Output only. The character set type for the Autonomous Database.
*/
characterSetType?: string | null;
/**
* Identifier. The name of the Autonomous Database Character Set resource in the following format: projects/{project\}/locations/{region\}/autonomousDatabaseCharacterSets/{autonomous_database_character_set\}
*/
name?: string | null;
}
/**
* The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings
*/
export interface Schema$AutonomousDatabaseConnectionStrings {
/**
* Output only. Returns all connection strings that can be used to connect to the Autonomous Database.
*/
allConnectionStrings?: Schema$AllConnectionStrings;
/**
* Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.
*/
dedicated?: string | null;
/**
* Output only. The database service provides the highest level of resources to each SQL statement.
*/
high?: string | null;
/**
* Output only. The database service provides the least level of resources to each SQL statement.
*/
low?: string | null;
/**
* Output only. The database service provides a lower level of resources to each SQL statement.
*/
medium?: string | null;
/**
* Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.
*/
profiles?: Schema$DatabaseConnectionStringProfile[];
}
/**
* The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls
*/
export interface Schema$AutonomousDatabaseConnectionUrls {
/**
* Output only. Oracle Application Express (APEX) URL.
*/
apexUri?: string | null;
/**
* Output only. The URL of the Database Transforms for the Autonomous Database.
*/
databaseTransformsUri?: string | null;
/**
* Output only. The URL of the Graph Studio for the Autonomous Database.
*/
graphStudioUri?: string | null;
/**
* Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.
*/
machineLearningNotebookUri?: string | null;
/**
* Output only. The URL of Machine Learning user management the Autonomous Database.
*/
machineLearningUserManagementUri?: string | null;
/**
* Output only. The URL of the MongoDB API for the Autonomous Database.
*/
mongoDbUri?: string | null;
/**
* Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.
*/
ordsUri?: string | null;
/**
* Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.
*/
sqlDevWebUri?: string | null;
}
/**
* The properties of an Autonomous Database.
*/
export interface Schema$AutonomousDatabaseProperties {
/**
* Output only. The amount of storage currently being used for user and system data, in terabytes.
*/
actualUsedDataStorageSizeTb?: number | null;
/**
* Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.
*/
allocatedStorageSizeTb?: number | null;
/**
* Optional. Immutable. The list of allowlisted IP addresses for the Autonomous Database.
*/
allowlistedIps?: string[] | null;
/**
* Output only. The details for the Oracle APEX Application Development.
*/
apexDetails?: Schema$AutonomousDatabaseApex;
/**
* Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.
*/
arePrimaryAllowlistedIpsUsed?: boolean | null;
/**
* Output only. The Autonomous Container Database OCID.
*/
autonomousContainerDatabaseId?: string | null;
/**
* Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.
*/
availableUpgradeVersions?: string[] | null;
/**
* Optional. Immutable. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.
*/
backupRetentionPeriodDays?: number | null;
/**
* Optional. Immutable. The character set for the Autonomous Database. The default is AL32UTF8.
*/
characterSet?: string | null;
/**
* Optional. Immutable. The number of compute servers for the Autonomous Database.
*/
computeCount?: number | null;
/**
* Output only. The connection strings used to connect to an Autonomous Database.
*/
connectionStrings?: Schema$AutonomousDatabaseConnectionStrings;
/**
* Output only. The Oracle Connection URLs for an Autonomous Database.
*/
connectionUrls?: Schema$AutonomousDatabaseConnectionUrls;
/**
* Optional. Immutable. The number of CPU cores to be made available to the database.
*/
cpuCoreCount?: number | null;
/**
* Optional. Immutable. The list of customer contacts.
*/
customerContacts?: Schema$CustomerContact[];
/**
* Output only. The current state of database management for the Autonomous Database.
*/
databaseManagementState?: string | null;
/**
* Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database.
*/
dataGuardRoleChangedTime?: string | null;
/**
* Output only. The current state of the Data Safe registration for the Autonomous Database.
*/
dataSafeState?: string | null;
/**
* Optional. Immutable. The size of the data stored in the database, in gigabytes.
*/
dataStorageSizeGb?: number | null;
/**
* Optional. Immutable. The size of the data stored in the database, in terabytes.
*/
dataStorageSizeTb?: number | null;
/**
* Optional. Immutable. The edition of the Autonomous Databases.
*/
dbEdition?: string | null;
/**
* Optional. Immutable. The Oracle Database version for the Autonomous Database.
*/
dbVersion?: string | null;
/**
* Required. Immutable. The workload type of the Autonomous Database.
*/
dbWorkload?: string | null;
/**
* Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database.
*/
disasterRecoveryRoleChangedTime?: string | null;
/**
* Optional. The encryption key used to encrypt the Autonomous Database. Updating this field will add a new entry in the `encryption_key_history_entries` field with the former version.
*/
encryptionKey?: Schema$EncryptionKey;
/**
* Output only. The history of the encryption keys used to encrypt the Autonomous Database.
*/
encryptionKeyHistoryEntries?: Schema$EncryptionKeyHistoryEntry[];
/**
* Output only. This field indicates the number of seconds of data loss during a Data Guard failover.
*/
failedDataRecoveryDuration?: string | null;
/**
* Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.
*/
isAutoScalingEnabled?: boolean | null;
/**
* Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.
*/
isLocalDataGuardEnabled?: boolean | null;
/**
* Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database storage.
*/
isStorageAutoScalingEnabled?: boolean | null;
/**
* Required. Immutable. The license type used for the Autonomous Database.
*/
licenseType?: string | null;
/**
* Output only. The details of the current lifestyle state of the Autonomous Database.
*/
lifecycleDetails?: string | null;
/**
* Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.
*/
localAdgAutoFailoverMaxDataLossLimit?: number | null;
/**
* Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.
*/
localDisasterRecoveryType?: string | null;
/**
* Output only. The details of the Autonomous Data Guard standby database.
*/
localStandbyDb?: Schema$AutonomousDatabaseStandbySummary;
/**
* Output only. The date and time when maintenance will begin.
*/
maintenanceBeginTime?: string | null;
/**
* Output only. The date and time when maintenance will end.
*/
maintenanceEndTime?: string | null;
/**
* Optional. Immutable. The maintenance schedule of the Autonomous Database.
*/
maintenanceScheduleType?: string | null;
/**
* Output only. The amount of memory enabled per ECPU, in gigabytes.
*/
memoryPerOracleComputeUnitGbs?: number | null;
/**
* Output only. The memory assigned to in-memory tables in an Autonomous Database.
*/
memoryTableGbs?: number | null;
/**
* Optional. Immutable. This field specifies if the Autonomous Database requires mTLS connections.
*/
mtlsConnectionRequired?: boolean | null;
/**
* Optional. Immutable. The national character set for the Autonomous Database. The default is AL16UTF16.
*/
nCharacterSet?: string | null;
/**
* Output only. The long term backup schedule of the Autonomous Database.
*/
nextLongTermBackupTime?: string | null;
/**
* Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
*/
ocid?: string | null;
/**
* Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.
*/
ociUrl?: string | null;
/**
* Output only. This field indicates the current mode of the Autonomous Database.
*/
openMode?: string | null;
/**
* Output only. This field indicates the state of Operations Insights for the Autonomous Database.
*/
operationsInsightsState?: string | null;
/**
* Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.
*/
peerDbIds?: string[] | null;
/**
* Output only. The permission level of the Autonomous Database.
*/
permissionLevel?: string | null;
/**
* Output only. The private endpoint for the Autonomous Database.
*/
privateEndpoint?: string | null;
/**
* Optional. Immutable. The private endpoint IP address for the Autonomous Database.
*/
privateEndpointIp?: string | null;
/**
* Optional. Immutable. The private endpoint label for the Autonomous Database.
*/
privateEndpointLabel?: string | null;
/**
* Output only. The refresh mode of the cloned Autonomous Database.
*/
refreshableMode?: string | null;
/**
* Output only. The refresh State of the clone.
*/
refreshableState?: string | null;
/**
* Output only. The Data Guard role of the Autonomous Database.
*/
role?: string | null;
/**
* Output only. The list and details of the scheduled operations of the Autonomous Database.
*/
scheduledOperationDetails?: Schema$ScheduledOperationDetails[];
/**
* Optional. Immutable. The ID of the Oracle Cloud Infrastructure vault secret.
*/
secretId?: string | null;
/**
* Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project.
*/
serviceAgentEmail?: string | null;
/**
* Output only. The SQL Web Developer URL for the Autonomous Database.
*/
sqlWebDeveloperUrl?: string | null;
/**
* Output only. The current lifecycle state of the Autonomous Database.
*/
state?: string | null;
/**
* Output only. The list of available regions that can be used to create a clone for the Autonomous Database.
*/
supportedCloneRegions?: string[] | null;
/**
* Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.
*/
totalAutoBackupStorageSizeGbs?: number | null;
/**
* Output only. The storage space used by Autonomous Database, in gigabytes.
*/
usedDataStorageSizeTbs?: number | null;
/**
* Optional. Immutable. The ID of the Oracle Cloud Infrastructure vault.
*/
vaultId?: string | null;
}
/**
* Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary
*/
export interface Schema$AutonomousDatabaseStandbySummary {
/**
* Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.
*/
dataGuardRoleChangedTime?: string | null;
/**
* Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
*/
disasterRecoveryRoleChangedTime?: string | null;
/**
* Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.
*/
lagTimeDuration?: string | null;
/**
* Output only. The additional details about the current lifecycle state of the Autonomous Database.
*/
lifecycleDetails?: string | null;
/**
* Output only. The current lifecycle state of the Autonomous Database.
*/
state?: string | null;
}
/**
* Details of the Autonomous Database version. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/
*/
export interface Schema$AutonomousDbVersion {
/**
* Output only. The Autonomous Database workload type.
*/
dbWorkload?: string | null;
/**
* Identifier. The name of the Autonomous Database Version resource with the format: projects/{project\}/locations/{region\}/autonomousDbVersions/{autonomous_db_version\}
*/
name?: string | null;
/**
* Output only. An Oracle Database version for Autonomous Database.
*/
version?: string | null;
/**
* Output only. A URL that points to a detailed description of the Autonomous Database version.
*/
workloadUri?: string | null;
}
/**
* The details of the database backup destination.
*/
export interface Schema$BackupDestinationDetails {
/**
* Optional. The type of the database backup destination.
*/
type?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* Details of the OCI Cloud Account.
*/
export interface Schema$CloudAccountDetails {
/**
* Output only. URL to create a new account and link.
*/
accountCreationUri?: string | null;
/**
* Output only. OCI account name.
*/
cloudAccount?: string | null;
/**
* Output only. OCI account home region.
*/
cloudAccountHomeRegion?: string | null;
/**
* Output only. URL to link an existing account.
*/
linkExistingAccountUri?: string | null;
}
/**
* Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/
*/
export interface Schema$CloudExadataInfrastructure {
/**
* Output only. The date and time that the Exadata Infrastructure was created.
*/
createTime?: string | null;
/**
* Optional. User friendly name for this resource.
*/
displayName?: string | null;
/**
* Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned.
*/
entitlementId?: string | null;
/**
* Optional. The GCP Oracle zone where Oracle Exadata Infrastructure is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
*/
gcpOracleZone?: string | null;
/**
* Optional. Labels or tags associated with the resource.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project\}/locations/{region\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}
*/
name?: string | null;
/**
* Optional. Various properties of the infra.
*/
properties?: Schema$CloudExadataInfrastructureProperties;
}
/**
* Various properties of Exadata Infrastructure.
*/
export interface Schema$CloudExadataInfrastructureProperties {
/**
* Output only. The requested number of additional storage servers activated for the Exadata Infrastructure.
*/
activatedStorageCount?: number | null;
/**
* Output only. The requested number of additional storage servers for the Exadata Infrastructure.
*/
additionalStorageCount?: number | null;
/**
* Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB).
*/
availableStorageSizeGb?: number | null;
/**
* Optional. The number of compute servers for the Exadata Infrastructure.
*/
computeCount?: number | null;
/**
* Output only. The compute model of the Exadata Infrastructure.
*/
computeModel?: string | null;
/**
* Output only. The number of enabled CPU cores.
*/
cpuCount?: number | null;
/**
* Optional. The list of customer contacts.
*/
customerContacts?: Schema$CustomerContact[];
/**
* Output only. The database server type of the Exadata Infrastructure.
*/
databaseServerType?: string | null;
/**
* Output only. Size, in terabytes, of the DATA disk group.
*/
dataStorageSizeTb?: number | null;
/**
* Output only. The local node storage allocated in GBs.
*/
dbNodeStorageSizeGb?: number | null;
/**
* Output only. The software version of the database servers (dom0) in the Exadata Infrastructure.
*/
dbServerVersion?: string | null;
/**
* Optional. Maintenance window for repair.
*/
maintenanceWindow?: Schema$MaintenanceWindow;
/**
* Output only. The total number of CPU cores available.
*/
maxCpuCount?: number | null;
/**
* Output only. The total available DATA disk group size.
*/
maxDataStorageTb?: number | null;
/**
* Output only. The total local node storage available in GBs.
*/
maxDbNodeStorageSizeGb?: number | null;
/**
* Output only. The total memory available in GBs.
*/
maxMemoryGb?: number | null;
/**
* Output only. The memory allocated in GBs.
*/
memorySizeGb?: number | null;
/**
* Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15
*/
monthlyDbServerVersion?: string | null;
/**
* Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15
*/
monthlyStorageServerVersion?: string | null;
/**
* Output only. The OCID of the next maintenance run.
*/
nextMaintenanceRunId?: string | null;
/**
* Output only. The time when the next maintenance run will occur.
*/
nextMaintenanceRunTime?: string | null;
/**
* Output only. The time when the next security maintenance run will occur.
*/
nextSecurityMaintenanceRunTime?: string | null;
/**
* Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle
*/
ocid?: string | null;
/**
* Output only. Deep link to the OCI console to view this resource.
*/
ociUrl?: string | null;
/**
* Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.
*/
shape?: string | null;
/**
* Output only. The current lifecycle state of the Exadata Infrastructure.
*/
state?: string | null;
/**
* Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure.
*/
storageCount?: number | null;
/**
* Output only. The storage server type of the Exadata Infrastructure.
*/
storageServerType?: string | null;
/**
* Output only. The software version of the storage servers (cells) in the Exadata Infrastructure.
*/
storageServerVersion?: string | null;
/**
* Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB).
*/
totalStorageSizeGb?: number | null;
}
/**
* Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/
*/
export interface Schema$CloudVmCluster {
/**
* Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}
*/
backupOdbSubnet?: string | null;
/**
* Optional. CIDR range of the backup subnet.
*/
backupSubnetCidr?: string | null;
/**
* Optional. Network settings. CIDR to use for cluster IP allocation.
*/
cidr?: string | null;
/**
* Output only. The date and time that the VM cluster was created.
*/
createTime?: string | null;
/**
* Optional. User friendly name for this resource.
*/
displayName?: string | null;
/**
* Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project\}/locations/{region\}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure\}
*/
exadataInfrastructure?: string | null;
/**
* Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.
*/
gcpOracleZone?: string | null;
/**
* Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.
*/
identityConnector?: Schema$IdentityConnector;
/**
* Optional. Labels or tags associated with the VM Cluster.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Identifier. The name of the VM Cluster resource with the format: projects/{project\}/locations/{region\}/cloudVmClusters/{cloud_vm_cluster\}
*/
name?: string | null;
/**
* Optional. The name of the VPC network. Format: projects/{project\}/global/networks/{network\}
*/
network?: string | null;
/**
* Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.
*/
odbNetwork?: string | null;
/**
* Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project\}/locations/{location\}/odbNetworks/{odb_network\}/odbSubnets/{odb_subnet\}
*/
odbSubnet?: string | null;
/**
* Optional. Various properties of the VM Cluster.
*/
properties?: Schema$CloudVmClusterProperties;
}
/**
* Various properties and settings associated with Exadata VM cluster.
*/
export interface Schema$CloudVmClusterProperties {
/**
* Optional. OCI Cluster name.
*/
clusterName?: string | null;
/**
* Output only. Compartment ID of cluster.
*/
compartmentId?: string | null;
/**
* Output only. The compute model of the VM Cluster.
*/
computeModel?: string | null;
/**
* Required. Number of enabled CPU cores.
*/
cpuCoreCount?: number | null;
/**
* Optional. The data disk group size to be allocated in TBs.
*/
dataStorageSizeTb?: number | null;
/**
* Optional. Local storage per VM.
*/
dbNodeStorageSizeGb?: number | null;
/**
* Optional. OCID of database servers.
*/
dbServerOcids?: string[] | null;
/**
* Optional. Data collection options for diagnostics.
*/
diagnosticsDataCollectionOptions?: Schema$DataCollectionOptions;
/**
* Optional. The type of redundancy.
*/
diskRedundancy?: string | null;
/**
* Output only. DNS listener IP.
*/
dnsListenerIp?: string | null;
/**
* Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com
*/
domain?: string | null;
/**
* Optional. Grid Infrastructure Version.
*/
giVersion?: string | null;
/**
* Output only. host name without domain. format: "-" with some suffix. ex: sp2-yi0xq where "sp2" is the hostname_prefix.
*/
hostname?: string | null;
/**
* Optional. Prefix for VM cluster host names.
*/
hostnamePrefix?: string | null;
/**
* Required. License type of VM Cluster.
*/
licenseType?: string | null;
/**
* Optional. Use local backup.
*/
localBackupEnabled?: boolean | null;
/**
* Optional. Memory allocated in GBs.
*/
memorySizeGb?: number | null;
/**
* Optional. Number of database servers.
*/
nodeCount?: number | null;
/**
* Output only. Oracle Cloud Infrastructure ID of VM Cluster.
*/
ocid?: string | null;
/**
* Output only. Deep link to the OCI console to view this resource.
*/
ociUrl?: string | null;
/**
* Optional. OCPU count per VM. Minimum is 0.1.
*/
ocpuCount?: number | null;
/**
* Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com
*/
scanDns?: string | null;
/**
* Output only. OCID of scan DNS record.
*/
scanDnsRecordId?: string | null;
/**
* Output only. OCIDs of scan IPs.
*/
scanIpIds?: string[] | null;
/**
* Output only. SCAN listener port - TCP
*/
scanListenerPortTcp?: number | null;
/**
* Output only. SCAN listener port - TLS
*/
scanListenerPortTcpSsl?: number | null;
/**
* Output only. Shape of VM Cluster.
*/
shape?: string | null;
/**
* Optional. Use exadata sparse snapshots.
*/
sparseDiskgroupEnabled?: boolean | null;
/**
* Optional. SSH public keys to be stored with cluster.
*/
sshPublicKeys?: string[] | null;
/**
* Output only. State of the cluster.
*/
state?: string | null;
/**
* Output only. The storage allocation for the disk group, in gigabytes (GB).
*/
storageSizeGb?: number | null;
/**
* Optional. Operating system version of the image.
*/
systemVersion?: string | null;
/**
* Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified.
*/
timeZone?: Schema$TimeZone;
}
/**
* The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact
*/
export interface Schema$CustomerContact {
/**
* Required. The email address used by Oracle to send notifications regarding databases and infrastructure.
*/
email?: string | null;
}
/**
* Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/
*/
export interface Schema$Database {
/**
* Required. The password for the default ADMIN user.
*/
adminPassword?: string | null;
/**
* Optional. The character set for the database. The default is AL32UTF8.
*/
characterSet?: string | null;
/**
* Output only. The date and time that the Database was created.
*/
createTime?: string | null;
/**
* Optional. The database ID of the Database.
*/
databaseId?: string | null;
/**
* Optional. The name of the DbHome resource associated with the Database.
*/
dbHomeName?: string | null;
/**
* Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
*/
dbName?: string | null;
/**
* Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
*/
dbUniqueName?: string | null;
/**
* Output only. The GCP Oracle zone where the Database is created.
*/
gcpOracleZone?: string | null;
/**
* Identifier. The name of the Database resource in the following format: projects/{project\}/locations/{region\}/databases/{database\}
*/
name?: string | null;
/**
* Optional. The national character set for the database. The default is AL16UTF16.
*/
ncharacterSet?: string | null;
/**
* Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
*/
ociUrl?: string | null;
/**
* Output only. The Status of Operations Insights for this Database.
*/
opsInsightsStatus?: string | null;
/**
* Optional. The properties of the Database.
*/
properties?: Schema$DatabaseProperties;
/**
* Optional. The TDE wallet password for the database.
*/
tdeWalletPassword?: string | null;
}
/**
* Details of the Database character set resource.
*/
export interface Schema$DatabaseCharacterSet {
/**
* Output only. The character set name for the Database which is the ID in the resource name.
*/
characterSet?: string | null;
/**
* Output only. The character set type for the Database.
*/
characterSetType?: string | null;
/**
* Identifier. The name of the Database Character Set resource in the following format: projects/{project\}/locations/{region\}/databaseCharacterSets/{database_character_set\}
*/
name?: string | null;
}
/**
* The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile
*/
export interface Schema$DatabaseConnectionStringProfile {
/**
* Output only. The current consumer group being used by the connection.
*/
consumerGroup?: string | null;
/**
* Output only. The display name for the database connection.
*/
displayName?: string | null;
/**
* Output only. The host name format being currently used in connection string.
*/
hostFormat?: string | null;
/**
* Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.
*/
isRegional?: boolean | null;
/**
* Output only. The protocol being used by the connection.
*/
protocol?: string | null;
/**
* Output only. The current session mode of the connection.
*/
sessionMode?: string | null;
/**
* Output only. The syntax of the connection string.
*/
syntaxFormat?: string | null;
/**
* Output only. This field indicates the TLS authentication type of the connection.
*/
tlsAuthentication?: string | null;
/**
* Output only. The value of the connection string.
*/
value?: string | null;
}
/**
* The configuration of the Database Management service.
*/
export interface Schema$DatabaseManagementConfig {
/**
* Output only. The status of the Database Management service.
*/
managementState?: string | null;
/**
* Output only. The Database Management type.
*/
managementType?: string | null;
}
/**
* The properties of a Database.
*/
export interface Schema$DatabaseProperties {
/**
* Output only. The Database Management config.
*/
databaseManagementConfig?: Schema$DatabaseManagementConfig;
/**
* Optional. Backup options for the Database.
*/
dbBackupConfig?: Schema$DbBackupConfig;
/**
* Required. The Oracle Database version.
*/
dbVersion?: string | null;
/**
* Output only. State of the Database.
*/
state?: string | null;
}
/**
* Data collection options for diagnostics.
*/
export interface Schema$DataCollectionOptions {
/**
* Optional. Indicates whether diagnostic collection is enabled for the VM cluster
*/
diagnosticsEventsEnabled?: boolean | null;
/**
* Optional. Indicates whether health monitoring is enabled for the VM cluster
*/
healthMonitoringEnabled?: boolean | null;
/**
* Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster
*/
incidentLogsEnabled?: boolean | null;
}
/**
* Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions
*/
export interface Schema$DataCollectionOptionsCommon {
/**
* Optional. Indicates whether to enable data collection for diagnostics.
*/
isDiagnosticsEventsEnabled?: boolean | null;
/**
* Optional. Indicates whether to enable health monitoring.
*/
isHealthMonitoringEnabled?: boolean | null;
/**
* Optional. Indicates whether to enable incident logs and trace collection.
*/
isIncidentLogsEnabled?: boolean | null;
}
/**
* Data coll