{ "version_module": true, "ownerName": "Google", "mtlsRootUrl": "https://oracledatabase.mtls.googleapis.com/", "rootUrl": "https://oracledatabase.googleapis.com/", "revision": "20260427", "baseUrl": "https://oracledatabase.googleapis.com/", "discoveryVersion": "v1", "servicePath": "", "endpoints": [ { "location": "asia-northeast2", "description": "Regional Endpoint", "endpointUrl": "https://oracledatabase.asia-northeast2.rep.googleapis.com/" }, { "location": "asia-south2", "description": "Regional Endpoint", "endpointUrl": "https://oracledatabase.asia-south2.rep.googleapis.com/" }, { "endpointUrl": "https://oracledatabase.asia-south1.rep.googleapis.com/", "location": "asia-south1", "description": "Regional Endpoint" }, { "location": "australia-southeast2", "description": "Regional Endpoint", "endpointUrl": "https://oracledatabase.australia-southeast2.rep.googleapis.com/" }, { "location": "europe-west8", "description": "Regional Endpoint", "endpointUrl": "https://oracledatabase.europe-west8.rep.googleapis.com/" }, { "location": "northamerica-northeast2", "description": "Regional Endpoint", "endpointUrl": "https://oracledatabase.northamerica-northeast2.rep.googleapis.com/" } ], "batchPath": "batch", "documentationLink": "https://cloud.google.com/oracle/database/docs", "id": "oracledatabase:v1", "fullyEncodeReservedExpansion": true, "canonicalName": "Oracle Database", "ownerDomain": "google.com", "schemas": { "DbSystemInitialStorageSizeProperties": { "properties": { "storageManagement": { "enum": [ "STORAGE_MANAGEMENT_UNSPECIFIED", "ASM", "LVM" ], "enumDescriptions": [ "Unspecified storage management.", "Automatic Storage Management.", "Logical Volume Management." ], "readOnly": true, "type": "string", "description": "Output only. The storage option used in DB system." }, "storageSizeDetails": { "type": "array", "readOnly": true, "description": "Output only. List of storage disk details.", "items": { "$ref": "StorageSizeDetails" } }, "shapeType": { "type": "string", "readOnly": true, "description": "Output only. VM shape platform type", "enumDescriptions": [ "Unspecified shape type.", "Standard X86." ], "enum": [ "SHAPE_TYPE_UNSPECIFIED", "STANDARD_X86" ] }, "launchFromBackupStorageSizeDetails": { "description": "Output only. List of storage disk details available for launches from backup.", "items": { "$ref": "StorageSizeDetails" }, "readOnly": true, "type": "array" } }, "description": "The properties of a DbSystem initial storage size summary.", "id": "DbSystemInitialStorageSizeProperties", "type": "object" }, "Database": { "properties": { "name": { "type": "string", "description": "Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}" }, "dbUniqueName": { "type": "string", "description": "Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up." }, "characterSet": { "description": "Optional. The character set for the database. The default is AL32UTF8.", "type": "string" }, "ncharacterSet": { "description": "Optional. The national character set for the database. The default is AL16UTF16.", "type": "string" }, "tdeWalletPasswordSecretVersion": { "type": "string", "description": "Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated." }, "createTime": { "description": "Output only. The date and time that the Database was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "ociUrl": { "readOnly": true, "type": "string", "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface." }, "databaseId": { "description": "Optional. The database ID of the Database.", "type": "string" }, "adminPasswordSecretVersion": { "description": "Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", "type": "string" }, "opsInsightsStatus": { "enumDescriptions": [ "Default unspecified value.", "Indicates that the operations insights are being enabled.", "Indicates that the operations insights are enabled.", "Indicates that the operations insights are being disabled.", "Indicates that the operations insights are not enabled.", "Indicates that the operations insights failed to enable.", "Indicates that the operations insights failed to disable." ], "enum": [ "OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED", "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING" ], "description": "Output only. The Status of Operations Insights for this Database.", "type": "string", "readOnly": true }, "pluggableDatabaseId": { "type": "string", "description": "Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location." }, "dbHomeName": { "description": "Optional. The name of the DbHome resource associated with the Database.", "type": "string" }, "dbName": { "type": "string", "description": "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." }, "pluggableDatabaseName": { "description": "Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters.", "type": "string" }, "properties": { "description": "Optional. The properties of the Database.", "$ref": "DatabaseProperties" }, "gcpOracleZone": { "type": "string", "readOnly": true, "description": "Output only. The GCP Oracle zone where the Database is created." }, "adminPassword": { "description": "Optional. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated.", "type": "string" }, "tdeWalletPassword": { "type": "string", "description": "Optional. The TDE wallet password for the database. Note: Only one of `tde_wallet_password_secret_version` or `tde_wallet_password` can be populated." } }, "description": "Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/", "id": "Database", "type": "object" }, "GiVersion": { "description": "Details of the Oracle Grid Infrastructure (GI) version resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiVersionSummary/", "properties": { "name": { "description": "Identifier. The name of the Oracle Grid Infrastructure (GI) version resource with the format: projects/{project}/locations/{region}/giVersions/{gi_versions}", "type": "string" }, "version": { "type": "string", "description": "Optional. version" } }, "id": "GiVersion", "type": "object" }, "ListDbSystemInitialStorageSizesResponse": { "properties": { "dbSystemInitialStorageSizes": { "type": "array", "description": "The list of DbSystemInitialStorageSizes.", "items": { "$ref": "DbSystemInitialStorageSize" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "description": "The response for `DbSystemInitialStorageSizes.List`.", "id": "ListDbSystemInitialStorageSizesResponse", "type": "object" }, "ExadbVmCluster": { "id": "ExadbVmCluster", "type": "object", "description": "ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/", "properties": { "backupOdbSubnet": { "description": "Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "createTime": { "description": "Output only. The date and time that the ExadbVmCluster was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "entitlementId": { "type": "string", "readOnly": true, "description": "Output only. The ID of the subscription entitlement associated with the ExadbVmCluster." }, "gcpOracleZone": { "readOnly": true, "type": "string", "description": "Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault." }, "properties": { "description": "Required. The properties of the ExadbVmCluster.", "$ref": "ExadbVmClusterProperties" }, "odbSubnet": { "type": "string", "description": "Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}" }, "displayName": { "type": "string", "description": "Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. The labels or tags associated with the ExadbVmCluster." }, "odbNetwork": { "type": "string", "description": "Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet." }, "name": { "description": "Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}", "type": "string" } } }, "MinorVersion": { "id": "MinorVersion", "type": "object", "properties": { "name": { "description": "Identifier. The name of the MinorVersion resource with the format: projects/{project}/locations/{region}/giVersions/{gi_version}/minorVersions/{minor_version}", "type": "string" }, "gridImageId": { "description": "Optional. The ID of the Grid Image.", "type": "string" }, "version": { "type": "string", "description": "Optional. The valid Oracle grid infrastructure software version." } }, "description": "MinorVersion represents a minor version of a GI. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiMinorVersionSummary/" }, "AutonomousDatabaseBackupProperties": { "properties": { "retentionPeriodDays": { "description": "Optional. Retention period in days for the backup.", "type": "integer", "format": "int32" }, "vaultId": { "description": "Optional. The OCID of the vault.", "type": "string" }, "sizeTb": { "readOnly": true, "format": "float", "type": "number", "description": "Output only. The backup size in terabytes." }, "ocid": { "readOnly": true, "type": "string", "description": "Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle" }, "keyStoreWallet": { "description": "Optional. The wallet name for Oracle Key Vault.", "type": "string" }, "kmsKeyId": { "type": "string", "description": "Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations." }, "isLongTermBackup": { "description": "Output only. Indicates if the backup is long term backup.", "type": "boolean", "readOnly": true }, "keyStoreId": { "type": "string", "description": "Optional. The OCID of the key store of Oracle Vault." }, "kmsKeyVersionId": { "type": "string", "description": "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." }, "availableTillTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. Timestamp until when the backup will be available." }, "isRestorable": { "type": "boolean", "readOnly": true, "description": "Output only. Indicates if the backup can be used to restore the Autonomous Database." }, "lifecycleState": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "UPDATING" ], "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in creating state.", "Indicates that the resource is in active state.", "Indicates that the resource is in deleting state.", "Indicates that the resource is in deleted state.", "Indicates that the resource is in failed state.", "Indicates that the resource is in updating state." ], "readOnly": true, "type": "string", "description": "Output only. The lifecycle state of the backup." }, "dbVersion": { "readOnly": true, "type": "string", "description": "Output only. A valid Oracle Database version for Autonomous Database." }, "startTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The date and time the backup started." }, "lifecycleDetails": { "description": "Output only. Additional information about the current lifecycle state.", "type": "string", "readOnly": true }, "type": { "enum": [ "TYPE_UNSPECIFIED", "INCREMENTAL", "FULL", "LONG_TERM" ], "enumDescriptions": [ "Default unspecified value.", "Incremental backups.", "Full backups.", "Long term backups." ], "readOnly": true, "type": "string", "description": "Output only. The type of the backup." }, "databaseSizeTb": { "description": "Output only. The quantity of data in the database, in terabytes.", "type": "number", "readOnly": true, "format": "float" }, "isAutomaticBackup": { "description": "Output only. Indicates if the backup is automatic or user initiated.", "type": "boolean", "readOnly": true }, "endTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The date and time the backup completed." }, "compartmentId": { "readOnly": true, "type": "string", "description": "Output only. The OCID of the compartment." } }, "description": "Properties of the Autonomous Database Backup resource.", "id": "AutonomousDatabaseBackupProperties", "type": "object" }, "ListGiVersionsResponse": { "properties": { "giVersions": { "description": "The list of Oracle Grid Infrastructure (GI) versions.", "items": { "$ref": "GiVersion" }, "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "description": "The response for `GiVersion.List`.", "id": "ListGiVersionsResponse", "type": "object" }, "DatabaseCharacterSet": { "description": "Details of the Database character set resource.", "properties": { "name": { "type": "string", "description": "Identifier. The name of the Database Character Set resource in the following format: projects/{project}/locations/{region}/databaseCharacterSets/{database_character_set}" }, "characterSetType": { "enumDescriptions": [ "Character set type is not specified.", "Character set type is set to database.", "Character set type is set to national." ], "enum": [ "CHARACTER_SET_TYPE_UNSPECIFIED", "DATABASE", "NATIONAL" ], "description": "Output only. The character set type for the Database.", "type": "string", "readOnly": true }, "characterSet": { "description": "Output only. The character set name for the Database which is the ID in the resource name.", "type": "string", "readOnly": true } }, "id": "DatabaseCharacterSet", "type": "object" }, "Location": { "description": "A resource that represents a Google Cloud location.", "properties": { "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "Service-specific metadata. For example the available capacity at the given location." }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" } }, "id": "Location", "type": "object" }, "DbSystemInitialStorageSize": { "id": "DbSystemInitialStorageSize", "type": "object", "description": "Summary of the DbSystem initial storage size.", "properties": { "name": { "type": "string", "readOnly": true, "description": "Output only. The name of the resource." }, "properties": { "readOnly": true, "$ref": "DbSystemInitialStorageSizeProperties", "description": "Output only. The properties of the DbSystem initial storage size summary." } } }, "DbVersionProperties": { "description": "The properties of a DbVersion.", "properties": { "isLatestForMajorVersion": { "description": "Output only. True if this version of the Oracle Database software is the latest version for a release.", "readOnly": true, "type": "boolean" }, "supportsPdb": { "description": "Output only. True if this version of the Oracle Database software supports pluggable databases.", "type": "boolean", "readOnly": true }, "isPreviewDbVersion": { "type": "boolean", "readOnly": true, "description": "Output only. True if this version of the Oracle Database software is the preview version." }, "version": { "description": "Output only. A valid Oracle Database version.", "readOnly": true, "type": "string" }, "isUpgradeSupported": { "description": "Output only. True if this version of the Oracle Database software is supported for Upgrade.", "type": "boolean", "readOnly": true } }, "id": "DbVersionProperties", "type": "object" }, "StartAutonomousDatabaseRequest": { "id": "StartAutonomousDatabaseRequest", "type": "object", "description": "The request for `AutonomousDatabase.Start`.", "properties": {} }, "ExadbVmClusterProperties": { "description": "The properties of an ExadbVmCluster.", "properties": { "clusterName": { "description": "Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name.", "type": "string" }, "hostname": { "readOnly": true, "type": "string", "description": "Output only. The hostname of the ExadbVmCluster." }, "additionalEcpuCountPerNode": { "description": "Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure.", "type": "integer", "format": "int32" }, "dataCollectionOptions": { "description": "Optional. Immutable. Indicates user preference for data collection options.", "$ref": "DataCollectionOptionsCommon" }, "hostnamePrefix": { "type": "string", "description": "Required. Immutable. Prefix for VM cluster host names." }, "vmFileSystemStorage": { "description": "Required. Immutable. Total storage details for the ExadbVmCluster.", "$ref": "ExadbVmClusterStorageDetails" }, "licenseModel": { "description": "Optional. Immutable. The license type of the ExadbVmCluster.", "type": "string", "enumDescriptions": [ "Unspecified.", "Default is license included.", "Bring your own license." ], "enum": [ "LICENSE_MODEL_UNSPECIFIED", "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" ] }, "ociUri": { "readOnly": true, "type": "string", "description": "Output only. Deep link to the OCI console to view this resource." }, "exascaleDbStorageVault": { "description": "Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", "type": "string" }, "shapeAttribute": { "description": "Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in smart storage.", "Indicates that the resource is in block storage." ], "enum": [ "SHAPE_ATTRIBUTE_UNSPECIFIED", "SMART_STORAGE", "BLOCK_STORAGE" ] }, "enabledEcpuCountPerNode": { "description": "Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure.", "type": "integer", "format": "int32" }, "timeZone": { "description": "Optional. Immutable. The time zone of the ExadbVmCluster.", "$ref": "TimeZone" }, "giVersion": { "description": "Output only. The Oracle Grid Infrastructure (GI) software version.", "type": "string", "readOnly": true }, "nodeCount": { "description": "Required. The number of nodes/VMs in the ExadbVmCluster.", "type": "integer", "format": "int32" }, "sshPublicKeys": { "description": "Required. Immutable. The SSH public keys for the ExadbVmCluster.", "items": { "type": "string" }, "type": "array" }, "scanListenerPortTcp": { "type": "integer", "format": "int32", "description": "Optional. Immutable. SCAN listener port - TCP" }, "lifecycleState": { "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in failed state.", "Indicates that the resource is in maintenance in progress state." ], "enum": [ "EXADB_VM_CLUSTER_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "MAINTENANCE_IN_PROGRESS" ], "description": "Output only. State of the cluster.", "type": "string", "readOnly": true }, "memorySizeGb": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs." }, "gridImageId": { "description": "Required. Immutable. Grid Infrastructure Version.", "type": "string" } }, "id": "ExadbVmClusterProperties", "type": "object" }, "RestartAutonomousDatabaseRequest": { "description": "The request for `AutonomousDatabase.Restart`.", "properties": {}, "id": "RestartAutonomousDatabaseRequest", "type": "object" }, "DbVersion": { "description": "A valid Oracle Database version.", "properties": { "properties": { "description": "Output only. The properties of the DbVersion.", "readOnly": true, "$ref": "DbVersionProperties" }, "name": { "description": "Output only. The name of the DbVersion resource in the following format: projects/{project}/locations/{region}/dbVersions/{db_version}", "readOnly": true, "type": "string" } }, "id": "DbVersion", "type": "object" }, "ListEntitlementsResponse": { "id": "ListEntitlementsResponse", "type": "object", "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "entitlements": { "type": "array", "description": "The list of Entitlements", "items": { "$ref": "Entitlement" } } }, "description": "The response for `Entitlement.List`." }, "ListAutonomousDatabaseCharacterSetsResponse": { "id": "ListAutonomousDatabaseCharacterSetsResponse", "type": "object", "properties": { "autonomousDatabaseCharacterSets": { "description": "The list of Autonomous Database Character Sets.", "items": { "$ref": "AutonomousDatabaseCharacterSet" }, "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "description": "The response for `AutonomousDatabaseCharacterSet.List`." }, "DatabaseProperties": { "description": "The properties of a Database.", "properties": { "dbBackupConfig": { "description": "Optional. Backup options for the Database.", "$ref": "DbBackupConfig" }, "databaseManagementConfig": { "readOnly": true, "$ref": "DatabaseManagementConfig", "description": "Output only. The Database Management config." }, "state": { "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in backup in progress state.", "Indicates that the resource is in upgrading state.", "Indicates that the resource is in converting state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in restore failed state.", "Indicates that the resource is in failed state." ], "enum": [ "DATABASE_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "BACKUP_IN_PROGRESS", "UPGRADING", "CONVERTING", "TERMINATING", "TERMINATED", "RESTORE_FAILED", "FAILED" ], "description": "Output only. State of the Database.", "type": "string", "readOnly": true }, "dbVersion": { "description": "Required. The Oracle Database version.", "type": "string" } }, "id": "DatabaseProperties", "type": "object" }, "RestoreAutonomousDatabaseRequest": { "description": "The request for `AutonomousDatabase.Restore`.", "properties": { "restoreTime": { "type": "string", "format": "google-datetime", "description": "Required. The time and date to restore the database to." } }, "id": "RestoreAutonomousDatabaseRequest", "type": "object" }, "EncryptionKeyHistoryEntry": { "properties": { "activationTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The date and time when the encryption key was activated on the Autonomous Database.." }, "encryptionKey": { "description": "Output only. The encryption key used to encrypt the Autonomous Database.", "readOnly": true, "$ref": "EncryptionKey" } }, "description": "The history of the encryption keys used to encrypt the Autonomous Database.", "id": "EncryptionKeyHistoryEntry", "type": "object" }, "ListAutonomousDbVersionsResponse": { "id": "ListAutonomousDbVersionsResponse", "type": "object", "description": "The response for `AutonomousDbVersion.List`.", "properties": { "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." }, "autonomousDbVersions": { "type": "array", "description": "The list of Autonomous Database versions.", "items": { "$ref": "AutonomousDbVersion" } } } }, "SwitchoverAutonomousDatabaseRequest": { "properties": { "peerAutonomousDatabase": { "type": "string", "description": "Optional. The peer database name to switch over to. Required for cross-region standby, and must be omitted for in-region Data Guard." } }, "description": "The request for `OracleDatabase.SwitchoverAutonomousDatabase`.", "id": "SwitchoverAutonomousDatabaseRequest", "type": "object" }, "ListOdbNetworksResponse": { "id": "ListOdbNetworksResponse", "type": "object", "description": "The response for `OdbNetwork.List`.", "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "items": { "type": "string" }, "type": "array" }, "odbNetworks": { "description": "The list of ODB Networks.", "items": { "$ref": "OdbNetwork" }, "type": "array" } } }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "properties": {}, "id": "CancelOperationRequest", "type": "object" }, "GenerateAutonomousDatabaseWalletRequest": { "properties": { "type": { "description": "Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Used to generate wallet for all databases in the region.", "Used to generate wallet for a single database." ], "enum": [ "GENERATE_TYPE_UNSPECIFIED", "ALL", "SINGLE" ] }, "isRegional": { "type": "boolean", "description": "Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only." }, "password": { "description": "Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters.", "type": "string" } }, "description": "The request for `AutonomousDatabase.GenerateWallet`.", "id": "GenerateAutonomousDatabaseWalletRequest", "type": "object" }, "ExadbVmClusterStorageDetails": { "properties": { "sizeInGbsPerNode": { "type": "integer", "format": "int32", "description": "Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster." } }, "description": "The storage allocation for the exadbvmcluster, in gigabytes (GB).", "id": "ExadbVmClusterStorageDetails", "type": "object" }, "ListPluggableDatabasesResponse": { "properties": { "pluggableDatabases": { "description": "The list of PluggableDatabases.", "items": { "$ref": "PluggableDatabase" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." } }, "description": "The response for `PluggableDatabase.List`.", "id": "ListPluggableDatabasesResponse", "type": "object" }, "AutonomousDatabaseBackup": { "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. labels or tags associated with the resource." }, "autonomousDatabase": { "description": "Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", "type": "string" }, "displayName": { "description": "Optional. User friendly name for the Backup. The name does not have to be unique.", "type": "string" }, "properties": { "description": "Optional. Various properties of the backup.", "$ref": "AutonomousDatabaseBackupProperties" }, "name": { "type": "string", "description": "Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup}" } }, "description": "Details of the Autonomous Database Backup resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/", "id": "AutonomousDatabaseBackup", "type": "object" }, "DbServer": { "description": "Details of the database server resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/", "properties": { "name": { "description": "Identifier. The name of the database server resource with the format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}", "type": "string" }, "displayName": { "type": "string", "description": "Optional. User friendly name for this resource." }, "properties": { "description": "Optional. Various properties of the database server.", "$ref": "DbServerProperties" } }, "id": "DbServer", "type": "object" }, "AutonomousDatabaseApex": { "id": "AutonomousDatabaseApex", "type": "object", "properties": { "apexVersion": { "type": "string", "readOnly": true, "description": "Output only. The Oracle APEX Application Development version." }, "ordsVersion": { "description": "Output only. The Oracle REST Data Services (ORDS) version.", "readOnly": true, "type": "string" } }, "description": "Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex" }, "ListDbVersionsResponse": { "id": "ListDbVersionsResponse", "type": "object", "properties": { "dbVersions": { "type": "array", "description": "The list of DbVersions.", "items": { "$ref": "DbVersion" } }, "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." } }, "description": "The response for `DbVersions.List`." }, "ListDbSystemShapesResponse": { "id": "ListDbSystemShapesResponse", "type": "object", "description": "The response for `DbSystemShape.List`.", "properties": { "dbSystemShapes": { "type": "array", "description": "The list of Database System shapes.", "items": { "$ref": "DbSystemShape" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } } }, "CustomerContact": { "id": "CustomerContact", "type": "object", "description": "The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact", "properties": { "email": { "description": "Required. The email address used by Oracle to send notifications regarding databases and infrastructure.", "type": "string" } } }, "DatabaseManagementConfig": { "properties": { "managementState": { "type": "string", "readOnly": true, "description": "Output only. The status of the Database Management service.", "enumDescriptions": [ "The status is not specified.", "The Database Management service is enabling.", "The Database Management service is enabled.", "The Database Management service is disabling.", "The Database Management service is disabled.", "The Database Management service is updating.", "The Database Management service failed to enable.", "The Database Management service failed to disable.", "The Database Management service failed to update." ], "enum": [ "MANAGEMENT_STATE_UNSPECIFIED", "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING", "FAILED_ENABLING", "FAILED_DISABLING", "FAILED_UPDATING" ] }, "managementType": { "enum": [ "MANAGEMENT_TYPE_UNSPECIFIED", "BASIC", "ADVANCED" ], "enumDescriptions": [ "The type is not specified.", "Basic Database Management.", "Advanced Database Management." ], "readOnly": true, "type": "string", "description": "Output only. The Database Management type." } }, "description": "The configuration of the Database Management service.", "id": "DatabaseManagementConfig", "type": "object" }, "ListAutonomousDatabaseBackupsResponse": { "id": "ListAutonomousDatabaseBackupsResponse", "type": "object", "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "autonomousDatabaseBackups": { "description": "The list of Autonomous Database Backups.", "items": { "$ref": "AutonomousDatabaseBackup" }, "type": "array" } }, "description": "The response for `AutonomousDatabaseBackup.List`." }, "ListAutonomousDatabasesResponse": { "id": "ListAutonomousDatabasesResponse", "type": "object", "description": "The response for `AutonomousDatabase.List`.", "properties": { "autonomousDatabases": { "description": "The list of Autonomous Databases.", "items": { "$ref": "AutonomousDatabase" }, "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "items": { "type": "string" }, "type": "array" } } }, "CloudVmCluster": { "id": "CloudVmCluster", "type": "object", "properties": { "odbNetwork": { "description": "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.", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels or tags associated with the VM Cluster." }, "cidr": { "type": "string", "description": "Optional. Network settings. CIDR to use for cluster IP allocation." }, "network": { "description": "Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}", "type": "string" }, "backupOdbSubnet": { "description": "Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "properties": { "description": "Optional. Various properties of the VM Cluster.", "$ref": "CloudVmClusterProperties" }, "odbSubnet": { "description": "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}", "type": "string" }, "gcpOracleZone": { "type": "string", "readOnly": true, "description": "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." }, "backupSubnetCidr": { "description": "Optional. CIDR range of the backup subnet.", "type": "string" }, "exadataInfrastructure": { "type": "string", "description": "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}" }, "name": { "type": "string", "description": "Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}" }, "identityConnector": { "readOnly": true, "$ref": "IdentityConnector", "description": "Output only. The identity connector details which will allow OCI to securely access the resources in the customer project." }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The date and time that the VM cluster was created." }, "displayName": { "type": "string", "description": "Optional. User friendly name for this resource." } }, "description": "Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/" }, "ExascaleDbStorageDetails": { "id": "ExascaleDbStorageDetails", "type": "object", "properties": { "availableSizeGbs": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The available storage capacity for the ExascaleDbStorageVault, in gigabytes (GB)." }, "totalSizeGbs": { "format": "int32", "type": "integer", "description": "Required. The total storage allocation for the ExascaleDbStorageVault, in gigabytes (GB)." } }, "description": "The storage details of the ExascaleDbStorageVault." }, "StorageSizeDetails": { "properties": { "recoStorageSizeInGbs": { "description": "Output only. The RECO/REDO storage size, in gigabytes, that is applicable for virtual machine DBSystem.", "type": "integer", "readOnly": true, "format": "int32" }, "dataStorageSizeInGbs": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. The data storage size, in gigabytes, that is applicable for virtual machine DBSystem." } }, "description": "The initial storage size, in gigabytes, that is applicable for virtual machine DBSystem.", "id": "StorageSizeDetails", "type": "object" }, "ListCloudExadataInfrastructuresResponse": { "id": "ListCloudExadataInfrastructuresResponse", "type": "object", "properties": { "cloudExadataInfrastructures": { "type": "array", "description": "The list of Exadata Infrastructures.", "items": { "$ref": "CloudExadataInfrastructure" } }, "unreachable": { "type": "array", "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "items": { "type": "string" } }, "nextPageToken": { "description": "A token for fetching next page of response.", "type": "string" } }, "description": "The response for `CloudExadataInfrastructures.list`." }, "AutonomousDatabaseCharacterSet": { "description": "Details of the Autonomous Database character set resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/", "properties": { "characterSetType": { "enumDescriptions": [ "Character set type is not specified.", "Character set type is set to database.", "Character set type is set to national." ], "enum": [ "CHARACTER_SET_TYPE_UNSPECIFIED", "DATABASE", "NATIONAL" ], "type": "string", "readOnly": true, "description": "Output only. The character set type for the Autonomous Database." }, "characterSet": { "readOnly": true, "type": "string", "description": "Output only. The character set name for the Autonomous Database which is the ID in the resource name." }, "name": { "type": "string", "description": "Identifier. The name of the Autonomous Database Character Set resource in the following format: projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set}" } }, "id": "AutonomousDatabaseCharacterSet", "type": "object" }, "Entitlement": { "description": "Details of the Entitlement resource.", "properties": { "name": { "type": "string", "description": "Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement}" }, "entitlementId": { "description": "Output only. Google Cloud Marketplace order ID (aka entitlement ID)", "type": "string", "readOnly": true }, "cloudAccountDetails": { "description": "Details of the OCI Cloud Account.", "$ref": "CloudAccountDetails" }, "state": { "readOnly": true, "type": "string", "description": "Output only. Entitlement State.", "enum": [ "STATE_UNSPECIFIED", "ACCOUNT_NOT_LINKED", "ACCOUNT_NOT_ACTIVE", "ACTIVE", "ACCOUNT_SUSPENDED", "NOT_APPROVED_IN_PRIVATE_MARKETPLACE" ], "enumDescriptions": [ "Default unspecified value.", "Account not linked.", "Account is linked but not active.", "Entitlement and Account are active.", "Account is suspended.", "Entitlement is not approved in private marketplace." ] } }, "id": "Entitlement", "type": "object" }, "ScheduledOperationDetails": { "description": "Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails", "properties": { "startTime": { "description": "Output only. Auto start time.", "readOnly": true, "$ref": "TimeOfDay" }, "dayOfWeek": { "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "description": "Output only. Day of week.", "readOnly": true, "type": "string" }, "stopTime": { "readOnly": true, "$ref": "TimeOfDay", "description": "Output only. Auto stop time." } }, "id": "ScheduledOperationDetails", "type": "object" }, "DbSystemProperties": { "description": "The properties of a DbSystem.", "properties": { "hostnamePrefix": { "description": "Optional. Prefix for DB System host names.", "type": "string" }, "dataCollectionOptions": { "description": "Optional. Data collection options for diagnostics.", "$ref": "DataCollectionOptionsDbSystem" }, "dbSystemOptions": { "description": "Optional. The options for the DbSystem.", "$ref": "DbSystemOptions" }, "privateIp": { "type": "string", "description": "Optional. The private IP address of the DbSystem." }, "hostname": { "type": "string", "readOnly": true, "description": "Output only. The hostname of the DbSystem." }, "shape": { "type": "string", "description": "Required. Shape of DB System." }, "databaseEdition": { "description": "Required. The database edition of the DbSystem.", "enum": [ "DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED", "STANDARD_EDITION", "ENTERPRISE_EDITION", "ENTERPRISE_EDITION_HIGH_PERFORMANCE" ], "type": "string", "enumDescriptions": [ "The database edition is unspecified.", "The database edition is Standard.", "The database edition is Enterprise.", "The database edition is Enterprise Edition." ] }, "licenseModel": { "type": "string", "enumDescriptions": [ "The license model is unspecified.", "The license model is included.", "The license model is bring your own license." ], "enum": [ "LICENSE_MODEL_UNSPECIFIED", "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" ], "description": "Required. The license model of the DbSystem." }, "ocid": { "description": "Output only. OCID of the DbSystem.", "readOnly": true, "type": "string" }, "recoStorageSizeGb": { "type": "integer", "format": "int32", "description": "Optional. The reco/redo storage size in GB." }, "sshPublicKeys": { "description": "Required. SSH public keys to be stored with the DbSystem.", "items": { "type": "string" }, "type": "array" }, "nodeCount": { "format": "int32", "type": "integer", "description": "Optional. The number of nodes in the DbSystem." }, "timeZone": { "description": "Optional. Time zone of the DbSystem.", "$ref": "TimeZone" }, "domain": { "type": "string", "description": "Optional. The host domain name of the DbSystem." }, "initialDataStorageSizeGb": { "format": "int32", "type": "integer", "description": "Required. The initial data storage size in GB." }, "dataStorageSizeGb": { "format": "int32", "type": "integer", "description": "Optional. The data storage size in GB that is currently available to DbSystems." }, "computeModel": { "description": "Optional. The compute model of the DbSystem.", "enum": [ "COMPUTE_MODEL_UNSPECIFIED", "ECPU", "OCPU" ], "type": "string", "enumDescriptions": [ "The compute model is unspecified.", "The compute model is virtual.", "The compute model is physical." ] }, "lifecycleState": { "readOnly": true, "type": "string", "description": "Output only. State of the DbSystem.", "enum": [ "DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "MIGRATED", "MAINTENANCE_IN_PROGRESS", "NEEDS_ATTENTION", "UPGRADING" ], "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in failed state.", "Indicates that the resource has been migrated.", "Indicates that the resource is in maintenance in progress state.", "Indicates that the resource needs attention.", "Indicates that the resource is upgrading." ] }, "memorySizeGb": { "description": "Optional. The memory size in GB.", "format": "int32", "type": "integer" }, "dbHome": { "description": "Optional. Details for creating a Database Home.", "$ref": "DbHome" }, "computeCount": { "type": "integer", "format": "int32", "description": "Required. The number of CPU cores to enable for the DbSystem." } }, "id": "DbSystemProperties", "type": "object" }, "Empty": { "id": "Empty", "type": "object", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "properties": {} }, "AutonomousDbVersion": { "id": "AutonomousDbVersion", "type": "object", "description": "Details of the Autonomous Database version. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/", "properties": { "dbWorkload": { "enumDescriptions": [ "Default unspecified value.", "Autonomous Transaction Processing database.", "Autonomous Data Warehouse database.", "Autonomous JSON Database.", "Autonomous Database with the Oracle APEX Application Development workload type." ], "enum": [ "DB_WORKLOAD_UNSPECIFIED", "OLTP", "DW", "AJD", "APEX" ], "description": "Output only. The Autonomous Database workload type.", "type": "string", "readOnly": true }, "name": { "type": "string", "description": "Identifier. The name of the Autonomous Database Version resource with the format: projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version}" }, "version": { "readOnly": true, "type": "string", "description": "Output only. An Oracle Database version for Autonomous Database." }, "workloadUri": { "type": "string", "readOnly": true, "description": "Output only. A URL that points to a detailed description of the Autonomous Database version." } } }, "OdbNetwork": { "id": "OdbNetwork", "type": "object", "description": "Represents OdbNetwork resource.", "properties": { "labels": { "description": "Optional. Labels or tags associated with the resource.", "type": "object", "additionalProperties": { "type": "string" } }, "state": { "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "TERMINATING", "FAILED" ], "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in failed state." ], "description": "Output only. State of the ODB Network.", "readOnly": true, "type": "string" }, "gcpOracleZone": { "description": "Optional. The GCP Oracle zone where OdbNetwork is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" }, "name": { "type": "string", "description": "Identifier. The name of the OdbNetwork resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}" }, "network": { "description": "Required. The name of the VPC network in the following format: projects/{project}/global/networks/{network}", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The date and time that the OdbNetwork was created." }, "entitlementId": { "description": "Output only. The ID of the subscription entitlement associated with the OdbNetwork.", "readOnly": true, "type": "string" } } }, "DbServerProperties": { "description": "Various properties and settings associated with Exadata database server.", "properties": { "dbNodeIds": { "type": "array", "readOnly": true, "description": "Output only. OCID of database nodes associated with the database server.", "items": { "type": "string" } }, "maxDbNodeStorageSizeGb": { "type": "integer", "format": "int32", "description": "Optional. Maximum local storage per VM." }, "maxOcpuCount": { "type": "integer", "format": "int32", "description": "Optional. Maximum OCPU count per database." }, "memorySizeGb": { "type": "integer", "format": "int32", "description": "Optional. Memory allocated in GBs." }, "ocid": { "readOnly": true, "type": "string", "description": "Output only. OCID of database server." }, "vmCount": { "format": "int32", "type": "integer", "description": "Optional. Vm count per database." }, "dbNodeStorageSizeGb": { "description": "Optional. Local storage per VM.", "format": "int32", "type": "integer" }, "state": { "enum": [ "STATE_UNSPECIFIED", "CREATING", "AVAILABLE", "UNAVAILABLE", "DELETING", "DELETED" ], "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in creating state.", "Indicates that the resource is in available state.", "Indicates that the resource is in unavailable state.", "Indicates that the resource is in deleting state.", "Indicates that the resource is in deleted state." ], "description": "Output only. State of the database server.", "readOnly": true, "type": "string" }, "ocpuCount": { "type": "integer", "format": "int32", "description": "Optional. OCPU count per database." }, "maxMemorySizeGb": { "description": "Optional. Maximum memory allocated in GBs.", "type": "integer", "format": "int32" } }, "id": "DbServerProperties", "type": "object" }, "LocationMetadata": { "description": "Metadata for a given Location.", "properties": { "gcpOracleZones": { "type": "array", "readOnly": true, "description": "Output only. Google Cloud Platform Oracle zones in a location.", "items": { "type": "string" } } }, "id": "LocationMetadata", "type": "object" }, "PluggableDatabase": { "id": "PluggableDatabase", "type": "object", "properties": { "properties": { "description": "Optional. The properties of the PluggableDatabase.", "$ref": "PluggableDatabaseProperties" }, "name": { "type": "string", "description": "Identifier. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}" }, "createTime": { "description": "Output only. The date and time that the PluggableDatabase was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "ociUrl": { "readOnly": true, "type": "string", "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface." } }, "description": "The PluggableDatabase resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/PluggableDatabase/" }, "CloudVmClusterProperties": { "description": "Various properties and settings associated with Exadata VM cluster.", "properties": { "computeModel": { "enum": [ "COMPUTE_MODEL_UNSPECIFIED", "COMPUTE_MODEL_ECPU", "COMPUTE_MODEL_OCPU" ], "enumDescriptions": [ "Unspecified compute model.", "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", "Physical measure of compute resources. OCPUs are based on the physical core of a processor." ], "description": "Output only. The compute model of the VM Cluster.", "readOnly": true, "type": "string" }, "memorySizeGb": { "format": "int32", "type": "integer", "description": "Optional. Memory allocated in GBs." }, "scanListenerPortTcpSsl": { "description": "Output only. SCAN listener port - TLS", "type": "integer", "readOnly": true, "format": "int32" }, "licenseType": { "description": "Required. License type of VM Cluster.", "type": "string", "enumDescriptions": [ "Unspecified", "License included part of offer", "Bring your own license" ], "enum": [ "LICENSE_TYPE_UNSPECIFIED", "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" ] }, "cpuCoreCount": { "description": "Required. Number of enabled CPU cores.", "type": "integer", "format": "int32" }, "compartmentId": { "readOnly": true, "type": "string", "description": "Output only. Compartment ID of cluster." }, "state": { "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "MAINTENANCE_IN_PROGRESS" ], "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in failed state.", "Indicates that the resource is in maintenance in progress state." ], "description": "Output only. State of the cluster.", "readOnly": true, "type": "string" }, "scanListenerPortTcp": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. SCAN listener port - TCP" }, "sshPublicKeys": { "description": "Optional. SSH public keys to be stored with cluster.", "items": { "type": "string" }, "type": "array" }, "nodeCount": { "format": "int32", "type": "integer", "description": "Optional. Number of database servers." }, "dbServerOcids": { "type": "array", "description": "Optional. OCID of database servers.", "items": { "type": "string" } }, "diskRedundancy": { "description": "Optional. The type of redundancy.", "type": "string", "enumDescriptions": [ "Unspecified.", "High - 3 way mirror.", "Normal - 2 way mirror." ], "enum": [ "DISK_REDUNDANCY_UNSPECIFIED", "HIGH", "NORMAL" ] }, "scanDnsRecordId": { "description": "Output only. OCID of scan DNS record.", "type": "string", "readOnly": true }, "hostnamePrefix": { "description": "Optional. Prefix for VM cluster host names.", "type": "string" }, "sparseDiskgroupEnabled": { "type": "boolean", "description": "Optional. Use exadata sparse snapshots." }, "localBackupEnabled": { "type": "boolean", "description": "Optional. Use local backup." }, "dnsListenerIp": { "description": "Output only. DNS listener IP.", "type": "string", "readOnly": true }, "domain": { "description": "Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com", "type": "string", "readOnly": true }, "timeZone": { "description": "Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified.", "$ref": "TimeZone" }, "dataStorageSizeTb": { "description": "Optional. The data disk group size to be allocated in TBs.", "format": "double", "type": "number" }, "dbNodeStorageSizeGb": { "format": "int32", "type": "integer", "description": "Optional. Local storage per VM." }, "scanDns": { "description": "Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com", "type": "string", "readOnly": true }, "giVersion": { "type": "string", "description": "Optional. Grid Infrastructure Version." }, "ocid": { "type": "string", "readOnly": true, "description": "Output only. Oracle Cloud Infrastructure ID of VM Cluster." }, "diagnosticsDataCollectionOptions": { "description": "Optional. Data collection options for diagnostics.", "$ref": "DataCollectionOptions" }, "shape": { "readOnly": true, "type": "string", "description": "Output only. Shape of VM Cluster." }, "ocpuCount": { "format": "float", "type": "number", "description": "Optional. OCPU count per VM. Minimum is 0.1." }, "hostname": { "readOnly": true, "type": "string", "description": "Output only. host name without domain. format: \"-\" with some suffix. ex: sp2-yi0xq where \"sp2\" is the hostname_prefix." }, "scanIpIds": { "description": "Output only. OCIDs of scan IPs.", "items": { "type": "string" }, "type": "array", "readOnly": true }, "ociUrl": { "type": "string", "readOnly": true, "description": "Output only. Deep link to the OCI console to view this resource." }, "systemVersion": { "description": "Optional. Operating system version of the image.", "type": "string" }, "clusterName": { "type": "string", "description": "Optional. OCI Cluster name." }, "storageSizeGb": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The storage allocation for the disk group, in gigabytes (GB)." } }, "id": "CloudVmClusterProperties", "type": "object" }, "DbNodeProperties": { "properties": { "dbNodeStorageSizeGb": { "description": "Optional. Local storage per database node.", "format": "int32", "type": "integer" }, "state": { "type": "string", "readOnly": true, "description": "Output only. State of the database node.", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in updating state.", "Indicates that the resource is in stopping state.", "Indicates that the resource is in stopped state.", "Indicates that the resource is in starting state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in terminated state.", "Indicates that the resource is in failed state." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "STOPPING", "STOPPED", "STARTING", "TERMINATING", "TERMINATED", "FAILED" ] }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The date and time that the database node was created." }, "ocpuCount": { "description": "Optional. OCPU count per database node.", "format": "int32", "type": "integer" }, "totalCpuCoreCount": { "format": "int32", "type": "integer", "description": "Total CPU core count of the database node." }, "dbServerOcid": { "description": "Optional. Database server OCID.", "type": "string" }, "hostname": { "description": "Optional. DNS", "type": "string" }, "memorySizeGb": { "description": "Memory allocated in GBs.", "type": "integer", "format": "int32" }, "ocid": { "description": "Output only. OCID of database node.", "readOnly": true, "type": "string" } }, "description": "Various properties and settings associated with Db node.", "id": "DbNodeProperties", "type": "object" }, "PluggableDatabaseNodeLevelDetails": { "id": "PluggableDatabaseNodeLevelDetails", "type": "object", "description": "The Pluggable Database Node Level Details.", "properties": { "nodeName": { "type": "string", "description": "Required. The Node name of the Database home." }, "openMode": { "description": "Required. The mode that the pluggable database is in to open it.", "enum": [ "PLUGGABLE_DATABASE_OPEN_MODE_UNSPECIFIED", "READ_ONLY", "READ_WRITE", "MOUNTED", "MIGRATE" ], "type": "string", "enumDescriptions": [ "The open mode is unspecified.", "The pluggable database is opened in read-only mode.", "The pluggable database is opened in read-write mode.", "The pluggable database is mounted.", "The pluggable database is migrated." ] }, "pluggableDatabaseId": { "description": "Required. The OCID of the Pluggable Database.", "type": "string" } } }, "EncryptionKey": { "properties": { "provider": { "description": "Optional. The provider of the encryption key.", "enum": [ "PROVIDER_UNSPECIFIED", "GOOGLE_MANAGED", "ORACLE_MANAGED" ], "type": "string", "enumDescriptions": [ "Default unspecified value.", "Google Managed KMS key, if selected, please provide the KMS key name.", "Oracle Managed." ] }, "kmsKey": { "description": "Optional. The KMS key used to encrypt the Autonomous Database. This field is required if the provider is GOOGLE_MANAGED. The name of the KMS key resource in the following format: `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", "type": "string" } }, "description": "The encryption key used to encrypt the Autonomous Database.", "id": "EncryptionKey", "type": "object" }, "SourceConfig": { "id": "SourceConfig", "type": "object", "description": "The source configuration for the standby Autonomous Database.", "properties": { "automaticBackupsReplicationEnabled": { "type": "boolean", "description": "Optional. This field specifies if the replication of automatic backups is enabled when creating a Data Guard." }, "autonomousDatabase": { "type": "string", "description": "Optional. The name of the primary Autonomous Database that is used to create a Peer Autonomous Database from a source." } } }, "DbBackupConfig": { "id": "DbBackupConfig", "type": "object", "description": "Backup Options for the Database.", "properties": { "backupDestinationDetails": { "type": "array", "description": "Optional. Details of the database backup destinations.", "items": { "$ref": "BackupDestinationDetails" } }, "retentionPeriodDays": { "description": "Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.", "format": "int32", "type": "integer" }, "autoBackupEnabled": { "description": "Optional. If set to true, enables automatic backups on the database.", "type": "boolean" }, "autoFullBackupDay": { "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "type": "string", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "description": "Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday." }, "autoIncrementalBackupWindow": { "enum": [ "BACKUP_WINDOW_UNSPECIFIED", "SLOT_ONE", "SLOT_TWO", "SLOT_THREE", "SLOT_FOUR", "SLOT_FIVE", "SLOT_SIX", "SLOT_SEVEN", "SLOT_EIGHT", "SLOT_NINE", "SLOT_TEN", "SLOT_ELEVEN", "SLOT_TWELVE" ], "type": "string", "enumDescriptions": [ "Default unspecified value.", "12:00 AM - 2:00 AM", "2:00 AM - 4:00 AM", "4:00 AM - 6:00 AM", "6:00 AM - 8:00 AM", "8:00 AM - 10:00 AM", "10:00 AM - 12:00 PM", "12:00 PM - 2:00 PM", "2:00 PM - 4:00 PM", "4:00 PM - 6:00 PM", "6:00 PM - 8:00 PM", "8:00 PM - 10:00 PM", "10:00 PM - 12:00 AM" ], "description": "Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day." }, "backupDeletionPolicy": { "description": "Optional. This defines when the backups will be deleted after Database termination.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Keeps the backup for predefined time i.e. 72 hours and then delete permanently.", "Keeps the backups as per the policy defined for database backups." ], "enum": [ "BACKUP_DELETION_POLICY_UNSPECIFIED", "DELETE_IMMEDIATELY", "DELETE_AFTER_RETENTION_PERIOD" ] }, "autoFullBackupWindow": { "type": "string", "enumDescriptions": [ "Default unspecified value.", "12:00 AM - 2:00 AM", "2:00 AM - 4:00 AM", "4:00 AM - 6:00 AM", "6:00 AM - 8:00 AM", "8:00 AM - 10:00 AM", "10:00 AM - 12:00 PM", "12:00 PM - 2:00 PM", "2:00 PM - 4:00 PM", "4:00 PM - 6:00 PM", "6:00 PM - 8:00 PM", "8:00 PM - 10:00 PM", "10:00 PM - 12:00 AM" ], "enum": [ "BACKUP_WINDOW_UNSPECIFIED", "SLOT_ONE", "SLOT_TWO", "SLOT_THREE", "SLOT_FOUR", "SLOT_FIVE", "SLOT_SIX", "SLOT_SEVEN", "SLOT_EIGHT", "SLOT_NINE", "SLOT_TEN", "SLOT_ELEVEN", "SLOT_TWELVE" ], "description": "Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime." } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "description": "The response message for Locations.ListLocations.", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } } }, "Status": { "id": "Status", "type": "object", "properties": { "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } }, "code": { "format": "int32", "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code." }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." } }, "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)." }, "DefinedTagValue": { "properties": { "tags": { "description": "The tags within the namespace.", "type": "object", "additionalProperties": { "type": "string" } } }, "description": "Wrapper message for the value of a defined tag.", "id": "DefinedTagValue", "type": "object" }, "ExascaleDbStorageVault": { "id": "ExascaleDbStorageVault", "type": "object", "description": "ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/", "properties": { "name": { "description": "Identifier. The resource name of the ExascaleDbStorageVault. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}", "type": "string" }, "createTime": { "description": "Output only. The date and time when the ExascaleDbStorageVault was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "entitlementId": { "description": "Output only. The ID of the subscription entitlement associated with the ExascaleDbStorageVault.", "type": "string", "readOnly": true }, "displayName": { "description": "Required. The display name for the ExascaleDbStorageVault. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.", "type": "string" }, "properties": { "description": "Required. The properties of the ExascaleDbStorageVault.", "$ref": "ExascaleDbStorageVaultProperties" }, "gcpOracleZone": { "description": "Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.", "type": "string" }, "labels": { "description": "Optional. The labels or tags associated with the ExascaleDbStorageVault.", "type": "object", "additionalProperties": { "type": "string" } } } }, "AutonomousDatabaseProperties": { "id": "AutonomousDatabaseProperties", "type": "object", "properties": { "supportedCloneRegions": { "readOnly": true, "type": "array", "description": "Output only. The list of available regions that can be used to create a clone for the Autonomous Database.", "items": { "type": "string" } }, "memoryPerOracleComputeUnitGbs": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. The amount of memory enabled per ECPU, in gigabytes." }, "localDisasterRecoveryType": { "enumDescriptions": [ "Default unspecified value.", "Autonomous Data Guard recovery.", "Backup based recovery.", "Local disaster recovery is not available." ], "enum": [ "LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED", "ADG", "BACKUP_BASED", "NOT_AVAILABLE" ], "description": "Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.", "type": "string", "readOnly": true }, "autonomousContainerDatabaseId": { "type": "string", "readOnly": true, "description": "Output only. The Autonomous Container Database OCID." }, "dataGuardRoleChangedTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The date and time the Autonomous Data Guard role was changed for the standby Autonomous Database." }, "maintenanceEndTime": { "description": "Output only. The date and time when maintenance will end.", "readOnly": true, "format": "google-datetime", "type": "string" }, "characterSet": { "type": "string", "description": "Optional. Immutable. The character set for the Autonomous Database. The default is AL32UTF8." }, "privateEndpointLabel": { "type": "string", "description": "Optional. Immutable. The private endpoint label for the Autonomous Database." }, "permissionLevel": { "description": "Output only. The permission level of the Autonomous Database.", "readOnly": true, "type": "string", "enum": [ "PERMISSION_LEVEL_UNSPECIFIED", "RESTRICTED", "UNRESTRICTED" ], "enumDescriptions": [ "Default unspecified value.", "Restricted mode allows access only by admin users.", "Normal access." ] }, "serviceAgentEmail": { "readOnly": true, "type": "string", "description": "Output only. An Oracle-managed Google Cloud service account on which customers can grant roles to access resources in the customer project." }, "usedDataStorageSizeTbs": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The storage space used by Autonomous Database, in gigabytes." }, "openMode": { "enumDescriptions": [ "Default unspecified value.", "Read Only Mode", "Read Write Mode" ], "enum": [ "OPEN_MODE_UNSPECIFIED", "READ_ONLY", "READ_WRITE" ], "type": "string", "readOnly": true, "description": "Output only. This field indicates the current mode of the Autonomous Database." }, "state": { "description": "Output only. The current lifecycle state of the Autonomous Database.", "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "STOPPING", "STOPPED", "STARTING", "TERMINATING", "TERMINATED", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "UPDATING", "MAINTENANCE_IN_PROGRESS", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY" ], "enumDescriptions": [ "Default unspecified value.", "Indicates that the Autonomous Database is in provisioning state.", "Indicates that the Autonomous Database is in available state.", "Indicates that the Autonomous Database is in stopping state.", "Indicates that the Autonomous Database is in stopped state.", "Indicates that the Autonomous Database is in starting state.", "Indicates that the Autonomous Database is in terminating state.", "Indicates that the Autonomous Database is in terminated state.", "Indicates that the Autonomous Database is in unavailable state.", "Indicates that the Autonomous Database restore is in progress.", "Indicates that the Autonomous Database failed to restore.", "Indicates that the Autonomous Database backup is in progress.", "Indicates that the Autonomous Database scale is in progress.", "Indicates that the Autonomous Database is available but needs attention state.", "Indicates that the Autonomous Database is in updating state.", "Indicates that the Autonomous Database's maintenance is in progress state.", "Indicates that the Autonomous Database is in restarting state.", "Indicates that the Autonomous Database is in recreating state.", "Indicates that the Autonomous Database's role change is in progress state.", "Indicates that the Autonomous Database is in upgrading state.", "Indicates that the Autonomous Database is in inaccessible state.", "Indicates that the Autonomous Database is in standby state." ] }, "lifecycleDetails": { "type": "string", "readOnly": true, "description": "Output only. The details of the current lifestyle state of the Autonomous Database." }, "actualUsedDataStorageSizeTb": { "type": "number", "readOnly": true, "format": "double", "description": "Output only. The amount of storage currently being used for user and system data, in terabytes." }, "dbWorkload": { "type": "string", "enumDescriptions": [ "Default unspecified value.", "Autonomous Transaction Processing database.", "Autonomous Data Warehouse database.", "Autonomous JSON Database.", "Autonomous Database with the Oracle APEX Application Development workload type." ], "enum": [ "DB_WORKLOAD_UNSPECIFIED", "OLTP", "DW", "AJD", "APEX" ], "description": "Required. Immutable. The workload type of the Autonomous Database." }, "encryptionKey": { "description": "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.", "$ref": "EncryptionKey" }, "ociUrl": { "description": "Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.", "readOnly": true, "type": "string" }, "peerDbIds": { "type": "array", "readOnly": true, "description": "Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.", "items": { "type": "string" } }, "nCharacterSet": { "description": "Optional. Immutable. The national character set for the Autonomous Database. The default is AL16UTF16.", "type": "string" }, "localStandbyDb": { "description": "Output only. The details of the Autonomous Data Guard standby database.", "readOnly": true, "$ref": "AutonomousDatabaseStandbySummary" }, "connectionUrls": { "readOnly": true, "$ref": "AutonomousDatabaseConnectionUrls", "description": "Output only. The Oracle Connection URLs for an Autonomous Database." }, "privateEndpoint": { "description": "Output only. The private endpoint for the Autonomous Database.", "type": "string", "readOnly": true }, "localAdgAutoFailoverMaxDataLossLimitDuration": { "description": "Optional. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", "format": "int32", "type": "integer" }, "failedDataRecoveryDuration": { "type": "string", "readOnly": true, "format": "google-duration", "description": "Output only. This field indicates the number of seconds of data loss during a Data Guard failover." }, "encryptionKeyHistoryEntries": { "description": "Output only. The history of the encryption keys used to encrypt the Autonomous Database.", "items": { "$ref": "EncryptionKeyHistoryEntry" }, "readOnly": true, "type": "array" }, "isLocalDataGuardEnabled": { "description": "Output only. Deprecated: Please use `local_data_guard_enabled` instead. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.", "deprecated": true, "type": "boolean", "readOnly": true }, "connectionStrings": { "readOnly": true, "$ref": "AutonomousDatabaseConnectionStrings", "description": "Output only. The connection strings used to connect to an Autonomous Database." }, "vaultId": { "type": "string", "description": "Optional. Immutable. The ID of the Oracle Cloud Infrastructure vault." }, "privateEndpointIp": { "description": "Optional. Immutable. The private endpoint IP address for the Autonomous Database.", "type": "string" }, "dataStorageSizeTb": { "description": "Optional. Immutable. The size of the data stored in the database, in terabytes.", "format": "int32", "type": "integer" }, "allocatedStorageSizeTb": { "description": "Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.", "type": "number", "readOnly": true, "format": "double" }, "scheduledOperationDetails": { "description": "Output only. The list and details of the scheduled operations of the Autonomous Database.", "items": { "$ref": "ScheduledOperationDetails" }, "readOnly": true, "type": "array" }, "dataSafeState": { "enum": [ "DATA_SAFE_STATE_UNSPECIFIED", "REGISTERING", "REGISTERED", "DEREGISTERING", "NOT_REGISTERED", "FAILED" ], "enumDescriptions": [ "Default unspecified value.", "Registering data safe state.", "Registered data safe state.", "Deregistering data safe state.", "Not registered data safe state.", "Failed data safe state." ], "description": "Output only. The current state of the Data Safe registration for the Autonomous Database.", "readOnly": true, "type": "string" }, "dbVersion": { "type": "string", "description": "Optional. Immutable. The Oracle Database version for the Autonomous Database." }, "secretId": { "type": "string", "description": "Optional. Immutable. The ID of the Oracle Cloud Infrastructure vault secret." }, "maintenanceScheduleType": { "type": "string", "enumDescriptions": [ "Default unspecified value.", "An EARLY maintenance schedule patches the database before the regular scheduled maintenance.", "A REGULAR maintenance schedule follows the normal maintenance cycle." ], "enum": [ "MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED", "EARLY", "REGULAR" ], "description": "Optional. Immutable. The maintenance schedule of the Autonomous Database." }, "refreshableMode": { "description": "Output only. The refresh mode of the cloned Autonomous Database.", "readOnly": true, "type": "string", "enum": [ "REFRESHABLE_MODE_UNSPECIFIED", "AUTOMATIC", "MANUAL" ], "enumDescriptions": [ "The default unspecified value.", "AUTOMATIC indicates that the cloned database is automatically refreshed with data from the source Autonomous Database.", "MANUAL indicates that the cloned database is manually refreshed with data from the source Autonomous Database." ] }, "dataStorageSizeGb": { "description": "Optional. Immutable. The size of the data stored in the database, in gigabytes.", "format": "int32", "type": "integer" }, "allowlistedIps": { "description": "Optional. Immutable. The list of allowlisted IP addresses for the Autonomous Database.", "items": { "type": "string" }, "type": "array" }, "maintenanceBeginTime": { "description": "Output only. The date and time when maintenance will begin.", "type": "string", "readOnly": true, "format": "google-datetime" }, "mtlsConnectionRequired": { "description": "Optional. Immutable. This field specifies if the Autonomous Database requires mTLS connections.", "type": "boolean" }, "disasterRecoveryRoleChangedTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The date and time the Disaster Recovery role was changed for the standby Autonomous Database." }, "customerContacts": { "description": "Optional. Immutable. The list of customer contacts.", "items": { "$ref": "CustomerContact" }, "type": "array" }, "nextLongTermBackupTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The long term backup schedule of the Autonomous Database." }, "apexDetails": { "readOnly": true, "$ref": "AutonomousDatabaseApex", "description": "Output only. The details for the Oracle APEX Application Development." }, "role": { "readOnly": true, "type": "string", "description": "Output only. The Data Guard role of the Autonomous Database.", "enum": [ "ROLE_UNSPECIFIED", "PRIMARY", "STANDBY", "DISABLED_STANDBY", "BACKUP_COPY", "SNAPSHOT_STANDBY" ], "enumDescriptions": [ "Default unspecified value.", "Primary role", "Standby role", "Disabled standby role", "Backup copy role", "Snapshot standby role" ] }, "sqlWebDeveloperUrl": { "description": "Output only. The SQL Web Developer URL for the Autonomous Database.", "readOnly": true, "type": "string" }, "isAutoScalingEnabled": { "description": "Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.", "type": "boolean" }, "localAdgAutoFailoverMaxDataLossLimit": { "format": "int32", "description": "Output only. Deprecated: Please use `local_adg_auto_failover_max_data_loss_limit_duration` instead. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", "readOnly": true, "deprecated": true, "type": "integer" }, "computeCount": { "format": "float", "type": "number", "description": "Optional. Immutable. The number of compute servers for the Autonomous Database." }, "licenseType": { "description": "Required. Immutable. The license type used for the Autonomous Database.", "enum": [ "LICENSE_TYPE_UNSPECIFIED", "LICENSE_INCLUDED", "BRING_YOUR_OWN_LICENSE" ], "type": "string", "enumDescriptions": [ "Unspecified", "License included part of offer", "Bring your own license" ] }, "cpuCoreCount": { "format": "int32", "type": "integer", "description": "Optional. Immutable. The number of CPU cores to be made available to the database." }, "backupRetentionPeriodDays": { "type": "integer", "format": "int32", "description": "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." }, "isStorageAutoScalingEnabled": { "description": "Optional. Immutable. This field indicates if auto scaling is enabled for the Autonomous Database storage.", "type": "boolean" }, "operationsInsightsState": { "enumDescriptions": [ "Default unspecified value.", "Enabling status for operation insights.", "Enabled status for operation insights.", "Disabling status for operation insights.", "Not Enabled status for operation insights.", "Failed enabling status for operation insights.", "Failed disabling status for operation insights." ], "enum": [ "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED", "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING" ], "type": "string", "readOnly": true, "description": "Output only. This field indicates the state of Operations Insights for the Autonomous Database." }, "totalAutoBackupStorageSizeGbs": { "description": "Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.", "readOnly": true, "format": "float", "type": "number" }, "ocid": { "readOnly": true, "type": "string", "description": "Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle" }, "memoryTableGbs": { "description": "Output only. The memory assigned to in-memory tables in an Autonomous Database.", "readOnly": true, "format": "int32", "type": "integer" }, "dbEdition": { "type": "string", "enumDescriptions": [ "Default unspecified value.", "Standard Database Edition", "Enterprise Database Edition" ], "enum": [ "DATABASE_EDITION_UNSPECIFIED", "STANDARD_EDITION", "ENTERPRISE_EDITION" ], "description": "Optional. Immutable. The edition of the Autonomous Databases." }, "availableUpgradeVersions": { "readOnly": true, "type": "array", "description": "Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.", "items": { "type": "string" } }, "localDataGuardEnabled": { "type": "boolean", "description": "Optional. Indicates whether the Autonomous Database has a local (in-region) standby database. Not applicable to cross-region Data Guard or dedicated Exadata infrastructure." }, "refreshableState": { "type": "string", "readOnly": true, "description": "Output only. The refresh State of the clone.", "enumDescriptions": [ "Default unspecified value.", "Refreshing", "Not refreshed" ], "enum": [ "REFRESHABLE_STATE_UNSPECIFIED", "REFRESHING", "NOT_REFRESHING" ] }, "databaseManagementState": { "description": "Output only. The current state of database management for the Autonomous Database.", "type": "string", "readOnly": true, "enumDescriptions": [ "Default unspecified value.", "Enabling Database Management state", "Enabled Database Management state", "Disabling Database Management state", "Not Enabled Database Management state", "Failed enabling Database Management state", "Failed disabling Database Management state" ], "enum": [ "DATABASE_MANAGEMENT_STATE_UNSPECIFIED", "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING" ] }, "arePrimaryAllowlistedIpsUsed": { "readOnly": true, "type": "boolean", "description": "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." } }, "description": "The properties of an Autonomous Database." }, "StopAutonomousDatabaseRequest": { "description": "The request for `AutonomousDatabase.Stop`.", "properties": {}, "id": "StopAutonomousDatabaseRequest", "type": "object" }, "AutonomousDatabase": { "properties": { "adminPasswordSecretVersion": { "type": "string", "description": "Optional. Immutable. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated." }, "disasterRecoverySupportedLocations": { "type": "array", "readOnly": true, "description": "Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.", "items": { "type": "string" } }, "displayName": { "type": "string", "description": "Optional. Immutable. The display name for the Autonomous Database. The name does not have to be unique within your project." }, "createTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The date and time that the Autonomous Database was created." }, "peerAutonomousDatabases": { "type": "array", "readOnly": true, "description": "Output only. The peer Autonomous Database names of the given Autonomous Database.", "items": { "type": "string" } }, "name": { "type": "string", "description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}" }, "adminPassword": { "type": "string", "description": "Optional. Immutable. The password for the default ADMIN user. Note: Only one of `admin_password_secret_version` or `admin_password` can be populated." }, "properties": { "description": "Optional. The properties of the Autonomous Database.", "$ref": "AutonomousDatabaseProperties" }, "odbSubnet": { "type": "string", "description": "Optional. Immutable. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}" }, "sourceConfig": { "description": "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.", "$ref": "SourceConfig" }, "database": { "description": "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.", "type": "string" }, "entitlementId": { "readOnly": true, "type": "string", "description": "Output only. The ID of the subscription entitlement associated with the Autonomous Database." }, "network": { "description": "Optional. Immutable. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", "type": "string" }, "labels": { "description": "Optional. The labels or tags associated with the Autonomous Database.", "type": "object", "additionalProperties": { "type": "string" } }, "cidr": { "type": "string", "description": "Optional. Immutable. The subnet CIDR range for the Autonomous Database." }, "odbNetwork": { "description": "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.", "type": "string" } }, "description": "Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/", "id": "AutonomousDatabase", "type": "object" }, "MaintenanceWindow": { "id": "MaintenanceWindow", "type": "object", "properties": { "daysOfWeek": { "type": "array", "description": "Optional. Days during the week when maintenance should be performed.", "items": { "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "type": "string", "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ] } }, "patchingMode": { "description": "Optional. Cloud CloudExadataInfrastructure node patching method, either \"ROLLING\" or \"NONROLLING\". Default value is ROLLING.", "enum": [ "PATCHING_MODE_UNSPECIFIED", "ROLLING", "NON_ROLLING" ], "type": "string", "enumDescriptions": [ "Default unspecified value.", "Updates the Cloud Exadata database server hosts in a rolling fashion.", "The non-rolling maintenance method first updates your storage servers at the same time, then your database servers at the same time." ] }, "months": { "description": "Optional. Months during the year when maintenance should be performed.", "items": { "enum": [ "MONTH_UNSPECIFIED", "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ], "type": "string", "enumDescriptions": [ "The unspecified month.", "The month of January.", "The month of February.", "The month of March.", "The month of April.", "The month of May.", "The month of June.", "The month of July.", "The month of August.", "The month of September.", "The month of October.", "The month of November.", "The month of December." ] }, "type": "array" }, "weeksOfMonth": { "description": "Optional. Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week.", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "leadTimeWeek": { "type": "integer", "format": "int32", "description": "Optional. Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4." }, "customActionTimeoutMins": { "format": "int32", "type": "integer", "description": "Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive)." }, "preference": { "enum": [ "MAINTENANCE_WINDOW_PREFERENCE_UNSPECIFIED", "CUSTOM_PREFERENCE", "NO_PREFERENCE" ], "type": "string", "enumDescriptions": [ "Default unspecified value.", "Custom preference.", "No preference." ], "description": "Optional. The maintenance window scheduling preference." }, "hoursOfDay": { "description": "Optional. The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are: 0 - represents time slot 0:00 - 3:59 UTC 4 - represents time slot 4:00 - 7:59 UTC 8 - represents time slot 8:00 - 11:59 UTC 12 - represents time slot 12:00 - 15:59 UTC 16 - represents time slot 16:00 - 19:59 UTC 20 - represents time slot 20:00 - 23:59 UTC", "items": { "type": "integer", "format": "int32" }, "type": "array" }, "isCustomActionTimeoutEnabled": { "description": "Optional. If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.", "type": "boolean" } }, "description": "Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow" }, "TimeZone": { "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", "properties": { "id": { "description": "IANA Time Zone Database time zone. For example \"America/New_York\".", "type": "string" }, "version": { "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", "type": "string" } }, "id": "TimeZone", "type": "object" }, "DatabaseConnectionStringProfile": { "properties": { "sessionMode": { "enum": [ "SESSION_MODE_UNSPECIFIED", "DIRECT", "INDIRECT" ], "enumDescriptions": [ "Default unspecified value.", "Direct", "Indirect" ], "readOnly": true, "type": "string", "description": "Output only. The current session mode of the connection." }, "protocol": { "description": "Output only. The protocol being used by the connection.", "type": "string", "readOnly": true, "enumDescriptions": [ "Default unspecified value.", "Tcp", "Tcps" ], "enum": [ "PROTOCOL_UNSPECIFIED", "TCP", "TCPS" ] }, "syntaxFormat": { "enum": [ "SYNTAX_FORMAT_UNSPECIFIED", "LONG", "EZCONNECT", "EZCONNECTPLUS" ], "enumDescriptions": [ "Default unspecified value.", "Long", "Ezconnect", "Ezconnectplus" ], "readOnly": true, "type": "string", "description": "Output only. The syntax of the connection string." }, "value": { "type": "string", "readOnly": true, "description": "Output only. The value of the connection string." }, "consumerGroup": { "type": "string", "readOnly": true, "description": "Output only. The current consumer group being used by the connection.", "enumDescriptions": [ "Default unspecified value.", "High consumer group.", "Medium consumer group.", "Low consumer group.", "TP consumer group.", "TPURGENT consumer group." ], "enum": [ "CONSUMER_GROUP_UNSPECIFIED", "HIGH", "MEDIUM", "LOW", "TP", "TPURGENT" ] }, "isRegional": { "type": "boolean", "readOnly": true, "description": "Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard." }, "tlsAuthentication": { "readOnly": true, "type": "string", "description": "Output only. This field indicates the TLS authentication type of the connection.", "enum": [ "TLS_AUTHENTICATION_UNSPECIFIED", "SERVER", "MUTUAL" ], "enumDescriptions": [ "Default unspecified value.", "Server", "Mutual" ] }, "hostFormat": { "readOnly": true, "type": "string", "description": "Output only. The host name format being currently used in connection string.", "enum": [ "HOST_FORMAT_UNSPECIFIED", "FQDN", "IP" ], "enumDescriptions": [ "Default unspecified value.", "FQDN", "IP" ] }, "displayName": { "description": "Output only. The display name for the database connection.", "type": "string", "readOnly": true } }, "description": "The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile", "id": "DatabaseConnectionStringProfile", "type": "object" }, "ListDatabasesResponse": { "description": "The response for `Database.List`.", "properties": { "databases": { "type": "array", "description": "The list of Databases.", "items": { "$ref": "Database" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "id": "ListDatabasesResponse", "type": "object" }, "DbNode": { "description": "Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/", "properties": { "properties": { "description": "Optional. Various properties of the database node.", "$ref": "DbNodeProperties" }, "name": { "type": "string", "description": "Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}" } }, "id": "DbNode", "type": "object" }, "PluggableDatabaseProperties": { "id": "PluggableDatabaseProperties", "type": "object", "properties": { "ocid": { "readOnly": true, "type": "string", "description": "Output only. The OCID of the pluggable database." }, "pdbNodeLevelDetails": { "description": "Optional. Pluggable Database Node Level Details", "items": { "$ref": "PluggableDatabaseNodeLevelDetails" }, "type": "array" }, "connectionStrings": { "description": "Optional. The Connection strings used to connect to the Oracle Database.", "$ref": "PluggableDatabaseConnectionStrings" }, "freeformTags": { "description": "Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.", "type": "object", "additionalProperties": { "type": "string" } }, "operationsInsightsState": { "enumDescriptions": [ "The status is not specified.", "Operations Insights is enabling.", "Operations Insights is enabled.", "Operations Insights is disabling.", "Operations Insights is not enabled.", "Operations Insights failed to enable.", "Operations Insights failed to disable." ], "enum": [ "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED", "ENABLING", "ENABLED", "DISABLING", "NOT_ENABLED", "FAILED_ENABLING", "FAILED_DISABLING" ], "description": "Output only. The status of Operations Insights for this Database.", "type": "string", "readOnly": true }, "pdbName": { "description": "Required. The database name.", "type": "string" }, "lifecycleDetails": { "type": "string", "readOnly": true, "description": "Output only. Additional information about the current lifecycle state." }, "lifecycleState": { "readOnly": true, "type": "string", "description": "Output only. The current state of the pluggable database.", "enum": [ "PLUGGABLE_DATABASE_LIFECYCLE_STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", "UPDATING", "FAILED", "RELOCATING", "RELOCATED", "REFRESHING", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "DISABLED" ], "enumDescriptions": [ "The lifecycle state is unspecified.", "The pluggable database is provisioning.", "The pluggable database is available.", "The pluggable database is terminating.", "The pluggable database is terminated.", "The pluggable database is updating.", "The pluggable database is in a failed state.", "The pluggable database is relocating.", "The pluggable database is relocated.", "The pluggable database is refreshing.", "The pluggable database is restoring.", "The pluggable database restore failed.", "The pluggable database is backing up.", "The pluggable database is disabled." ] }, "containerDatabaseOcid": { "type": "string", "description": "Required. The OCID of the CDB." }, "definedTags": { "description": "Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace.", "type": "object", "additionalProperties": { "$ref": "DefinedTagValue" } }, "compartmentId": { "type": "string", "description": "Required. The OCID of the compartment." }, "isRestricted": { "description": "Optional. The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.", "type": "boolean" }, "databaseManagementConfig": { "readOnly": true, "$ref": "DatabaseManagementConfig", "description": "Output only. The configuration of the Database Management service." } }, "description": "The properties of a PluggableDatabase." }, "ListOdbSubnetsResponse": { "id": "ListOdbSubnetsResponse", "type": "object", "properties": { "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "items": { "type": "string" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." }, "odbSubnets": { "type": "array", "description": "The list of ODB Subnets.", "items": { "$ref": "OdbSubnet" } } }, "description": "The response for `OdbSubnet.List`." }, "Operation": { "properties": { "done": { "type": "boolean", "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available." }, "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any." }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`." } }, "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", "type": "object" }, "ListDbSystemsResponse": { "id": "ListDbSystemsResponse", "type": "object", "description": "The response for `DbSystem.List`.", "properties": { "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." }, "dbSystems": { "type": "array", "description": "The list of DbSystems.", "items": { "$ref": "DbSystem" } }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "items": { "type": "string" }, "type": "array" } } }, "AllConnectionStrings": { "id": "AllConnectionStrings", "type": "object", "properties": { "low": { "type": "string", "readOnly": true, "description": "Output only. The database service provides the least level of resources to each SQL statement." }, "high": { "readOnly": true, "type": "string", "description": "Output only. The database service provides the highest level of resources to each SQL statement." }, "medium": { "type": "string", "readOnly": true, "description": "Output only. The database service provides a lower level of resources to each SQL statement." } }, "description": "A list of all connection strings that can be used to connect to the Autonomous Database." }, "AutonomousDatabaseConnectionUrls": { "id": "AutonomousDatabaseConnectionUrls", "type": "object", "properties": { "apexUri": { "description": "Output only. Oracle Application Express (APEX) URL.", "type": "string", "readOnly": true }, "machineLearningUserManagementUri": { "description": "Output only. The URL of Machine Learning user management the Autonomous Database.", "type": "string", "readOnly": true }, "mongoDbUri": { "description": "Output only. The URL of the MongoDB API for the Autonomous Database.", "type": "string", "readOnly": true }, "databaseTransformsUri": { "readOnly": true, "type": "string", "description": "Output only. The URL of the Database Transforms for the Autonomous Database." }, "graphStudioUri": { "description": "Output only. The URL of the Graph Studio for the Autonomous Database.", "readOnly": true, "type": "string" }, "sqlDevWebUri": { "description": "Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.", "readOnly": true, "type": "string" }, "machineLearningNotebookUri": { "readOnly": true, "type": "string", "description": "Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database." }, "ordsUri": { "description": "Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", "readOnly": true, "type": "string" } }, "description": "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" }, "IdentityConnector": { "description": "The identity connector details which will allow OCI to securely access the resources in the customer project.", "properties": { "serviceAgentEmail": { "type": "string", "readOnly": true, "description": "Output only. A google managed service account on which customers can grant roles to access resources in the customer project. Example: `p176944527254-55-75119d87fd8f@gcp-sa-oci.iam.gserviceaccount.com`" }, "connectionState": { "enumDescriptions": [ "Default unspecified value.", "The identity pool connection is connected.", "The identity pool connection is partially connected.", "The identity pool connection is disconnected.", "The identity pool connection is in an unknown state." ], "enum": [ "CONNECTION_STATE_UNSPECIFIED", "CONNECTED", "PARTIALLY_CONNECTED", "DISCONNECTED", "UNKNOWN" ], "description": "Output only. The connection state of the identity connector.", "type": "string", "readOnly": true } }, "id": "IdentityConnector", "type": "object" }, "CloudExadataInfrastructureProperties": { "properties": { "ocid": { "readOnly": true, "type": "string", "description": "Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle" }, "maxMemoryGb": { "description": "Output only. The total memory available in GBs.", "type": "integer", "readOnly": true, "format": "int32" }, "shape": { "description": "Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.", "type": "string" }, "maxCpuCount": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. The total number of CPU cores available." }, "ociUrl": { "type": "string", "readOnly": true, "description": "Output only. Deep link to the OCI console to view this resource." }, "nextSecurityMaintenanceRunTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The time when the next security maintenance run will occur." }, "monthlyDbServerVersion": { "readOnly": true, "type": "string", "description": "Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15" }, "storageServerType": { "description": "Output only. The storage server type of the Exadata Infrastructure.", "type": "string", "readOnly": true }, "maxDataStorageTb": { "readOnly": true, "format": "double", "type": "number", "description": "Output only. The total available DATA disk group size." }, "dataStorageSizeTb": { "readOnly": true, "format": "double", "type": "number", "description": "Output only. Size, in terabytes, of the DATA disk group." }, "activatedStorageCount": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. The requested number of additional storage servers activated for the Exadata Infrastructure." }, "storageServerVersion": { "type": "string", "readOnly": true, "description": "Output only. The software version of the storage servers (cells) in the Exadata Infrastructure." }, "databaseServerType": { "description": "Output only. The database server type of the Exadata Infrastructure.", "readOnly": true, "type": "string" }, "availableStorageSizeGb": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB)." }, "dbNodeStorageSizeGb": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The local node storage allocated in GBs." }, "dbServerVersion": { "description": "Output only. The software version of the database servers (dom0) in the Exadata Infrastructure.", "readOnly": true, "type": "string" }, "totalStorageSizeGb": { "type": "integer", "format": "int32", "description": "Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB)." }, "nextMaintenanceRunTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time when the next maintenance run will occur." }, "nextMaintenanceRunId": { "description": "Output only. The OCID of the next maintenance run.", "readOnly": true, "type": "string" }, "storageCount": { "description": "Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure.", "type": "integer", "format": "int32" }, "customerContacts": { "type": "array", "description": "Optional. The list of customer contacts.", "items": { "$ref": "CustomerContact" } }, "computeCount": { "type": "integer", "format": "int32", "description": "Optional. The number of compute servers for the Exadata Infrastructure." }, "computeModel": { "enumDescriptions": [ "Unspecified compute model.", "Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.", "Physical measure of compute resources. OCPUs are based on the physical core of a processor." ], "enum": [ "COMPUTE_MODEL_UNSPECIFIED", "COMPUTE_MODEL_ECPU", "COMPUTE_MODEL_OCPU" ], "type": "string", "readOnly": true, "description": "Output only. The compute model of the Exadata Infrastructure." }, "memorySizeGb": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The memory allocated in GBs." }, "maxDbNodeStorageSizeGb": { "readOnly": true, "format": "int32", "type": "integer", "description": "Output only. The total local node storage available in GBs." }, "additionalStorageCount": { "description": "Output only. The requested number of additional storage servers for the Exadata Infrastructure.", "readOnly": true, "format": "int32", "type": "integer" }, "monthlyStorageServerVersion": { "type": "string", "readOnly": true, "description": "Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15" }, "cpuCount": { "type": "integer", "readOnly": true, "format": "int32", "description": "Output only. The number of enabled CPU cores." }, "maintenanceWindow": { "description": "Optional. Maintenance window for repair.", "$ref": "MaintenanceWindow" }, "state": { "description": "Output only. The current lifecycle state of the Exadata Infrastructure.", "readOnly": true, "type": "string", "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED", "MAINTENANCE_IN_PROGRESS" ], "enumDescriptions": [ "Default unspecified value.", "The Exadata Infrastructure is being provisioned.", "The Exadata Infrastructure is available for use.", "The Exadata Infrastructure is being updated.", "The Exadata Infrastructure is being terminated.", "The Exadata Infrastructure is terminated.", "The Exadata Infrastructure is in failed state.", "The Exadata Infrastructure is in maintenance." ] } }, "description": "Various properties of Exadata Infrastructure.", "id": "CloudExadataInfrastructureProperties", "type": "object" }, "ListMinorVersionsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." }, "minorVersions": { "description": "The list of MinorVersions.", "items": { "$ref": "MinorVersion" }, "type": "array" } }, "description": "The response for `MinorVersion.List`.", "id": "ListMinorVersionsResponse", "type": "object" }, "PluggableDatabaseConnectionStrings": { "properties": { "pdbDefault": { "type": "string", "description": "Optional. The default connection string to use to connect to the pluggable database." }, "pdbIpDefault": { "type": "string", "description": "Optional. The default connection string to use to connect to the pluggable database using IP." }, "allConnectionStrings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. All connection strings to use to connect to the pluggable database." } }, "description": "The connection strings used to connect to the Oracle Database.", "id": "PluggableDatabaseConnectionStrings", "type": "object" }, "DbSystemShape": { "id": "DbSystemShape", "type": "object", "properties": { "shape": { "description": "Optional. shape", "type": "string" }, "name": { "description": "Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape}", "type": "string" }, "minNodeCount": { "type": "integer", "format": "int32", "description": "Optional. Minimum number of database servers." }, "minMemoryPerNodeGb": { "description": "Optional. Minimum memory per node in gigabytes.", "format": "int32", "type": "integer" }, "maxStorageCount": { "description": "Optional. Maximum number of storage servers.", "type": "integer", "format": "int32" }, "availableCoreCountPerNode": { "format": "int32", "type": "integer", "description": "Optional. Number of cores per node." }, "minDbNodeStoragePerNodeGb": { "format": "int32", "type": "integer", "description": "Optional. Minimum node storage per database server in gigabytes." }, "minCoreCountPerNode": { "format": "int32", "type": "integer", "description": "Optional. Minimum core count per node." }, "availableDataStorageTb": { "description": "Optional. Storage per storage server in terabytes.", "format": "int32", "type": "integer" }, "minStorageCount": { "description": "Optional. Minimum number of storage servers.", "type": "integer", "format": "int32" }, "maxNodeCount": { "type": "integer", "format": "int32", "description": "Optional. Maximum number of database servers." }, "availableMemoryPerNodeGb": { "description": "Optional. Memory per database server node in gigabytes.", "type": "integer", "format": "int32" } }, "description": "Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/" }, "ListDatabaseCharacterSetsResponse": { "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "databaseCharacterSets": { "type": "array", "description": "The list of DatabaseCharacterSets.", "items": { "$ref": "DatabaseCharacterSet" } } }, "description": "The response for `DatabaseCharacterSet.List`.", "id": "ListDatabaseCharacterSetsResponse", "type": "object" }, "ExascaleDbStorageVaultProperties": { "properties": { "timeZone": { "readOnly": true, "$ref": "TimeZone", "description": "Output only. The time zone of the ExascaleDbStorageVault." }, "description": { "description": "Optional. The description of the ExascaleDbStorageVault.", "type": "string" }, "exascaleDbStorageDetails": { "description": "Required. The storage details of the ExascaleDbStorageVault.", "$ref": "ExascaleDbStorageDetails" }, "availableShapeAttributes": { "readOnly": true, "type": "array", "description": "Output only. The shape attributes available for the VM clusters to be attached to the ExascaleDbStorageVault.", "items": { "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in smart storage.", "Indicates that the resource is in block storage." ], "enum": [ "SHAPE_ATTRIBUTE_UNSPECIFIED", "SMART_STORAGE", "BLOCK_STORAGE" ] } }, "state": { "enumDescriptions": [ "The state of the ExascaleDbStorageVault is unspecified.", "The ExascaleDbStorageVault is being provisioned.", "The ExascaleDbStorageVault is available.", "The ExascaleDbStorageVault is being updated.", "The ExascaleDbStorageVault is being deleted.", "The ExascaleDbStorageVault has been deleted.", "The ExascaleDbStorageVault has failed." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "UPDATING", "TERMINATING", "TERMINATED", "FAILED" ], "type": "string", "readOnly": true, "description": "Output only. The state of the ExascaleDbStorageVault." }, "attachedShapeAttributes": { "readOnly": true, "type": "array", "description": "Output only. The shape attributes of the VM clusters attached to the ExascaleDbStorageVault.", "items": { "type": "string", "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in smart storage.", "Indicates that the resource is in block storage." ], "enum": [ "SHAPE_ATTRIBUTE_UNSPECIFIED", "SMART_STORAGE", "BLOCK_STORAGE" ] } }, "vmClusterIds": { "description": "Output only. The list of VM cluster OCIDs associated with the ExascaleDbStorageVault.", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "ocid": { "description": "Output only. The OCID for the ExascaleDbStorageVault.", "type": "string", "readOnly": true }, "ociUri": { "description": "Output only. Deep link to the OCI console to view this resource.", "readOnly": true, "type": "string" }, "vmClusterCount": { "description": "Output only. The number of VM clusters associated with the ExascaleDbStorageVault.", "readOnly": true, "format": "int32", "type": "integer" }, "additionalFlashCachePercent": { "description": "Optional. The size of additional flash cache in percentage of high capacity database storage.", "type": "integer", "format": "int32" } }, "description": "The properties of the ExascaleDbStorageVault. next ID: 12", "id": "ExascaleDbStorageVaultProperties", "type": "object" }, "ListExascaleDbStorageVaultsResponse": { "properties": { "exascaleDbStorageVaults": { "description": "The ExascaleDbStorageVaults.", "items": { "$ref": "ExascaleDbStorageVault" }, "type": "array" }, "unreachable": { "type": "array", "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "items": { "type": "string" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return. If present, the next page token can be provided to a subsequent ListExascaleDbStorageVaults call to list the next page. If empty, there are no more pages.", "type": "string" } }, "description": "The response for `ExascaleDbStorageVault.List`.", "id": "ListExascaleDbStorageVaultsResponse", "type": "object" }, "CloudAccountDetails": { "description": "Details of the OCI Cloud Account.", "properties": { "cloudAccount": { "type": "string", "readOnly": true, "description": "Output only. OCI account name." }, "cloudAccountHomeRegion": { "readOnly": true, "type": "string", "description": "Output only. OCI account home region." }, "linkExistingAccountUri": { "description": "Output only. URL to link an existing account.", "type": "string", "readOnly": true }, "accountCreationUri": { "readOnly": true, "type": "string", "description": "Output only. URL to create a new account and link." } }, "id": "CloudAccountDetails", "type": "object" }, "ListOperationsResponse": { "id": "ListOperationsResponse", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" }, "type": "array" }, "unreachable": { "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "description": "The response message for Operations.ListOperations." }, "GenerateAutonomousDatabaseWalletResponse": { "id": "GenerateAutonomousDatabaseWalletResponse", "type": "object", "properties": { "archiveContent": { "type": "string", "readOnly": true, "format": "byte", "description": "Output only. The base64 encoded wallet files." } }, "description": "The response for `AutonomousDatabase.GenerateWallet`." }, "ListDbServersResponse": { "id": "ListDbServersResponse", "type": "object", "properties": { "dbServers": { "type": "array", "description": "The list of database servers.", "items": { "$ref": "DbServer" } }, "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." } }, "description": "The response for `DbServer.List`." }, "DataCollectionOptionsDbSystem": { "properties": { "isDiagnosticsEventsEnabled": { "description": "Optional. Indicates whether to enable data collection for diagnostics.", "type": "boolean" }, "isIncidentLogsEnabled": { "description": "Optional. Indicates whether to enable incident logs and trace collection.", "type": "boolean" } }, "description": "Data collection options for DbSystem.", "id": "DataCollectionOptionsDbSystem", "type": "object" }, "ListCloudVmClustersResponse": { "id": "ListCloudVmClustersResponse", "type": "object", "properties": { "nextPageToken": { "description": "A token to fetch the next page of results.", "type": "string" }, "cloudVmClusters": { "description": "The list of VM Clusters.", "items": { "$ref": "CloudVmCluster" }, "type": "array" }, "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "items": { "type": "string" }, "type": "array" } }, "description": "The response for `CloudVmCluster.List`." }, "OdbSubnet": { "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels or tags associated with the resource." }, "purpose": { "enum": [ "PURPOSE_UNSPECIFIED", "CLIENT_SUBNET", "BACKUP_SUBNET" ], "type": "string", "enumDescriptions": [ "Default unspecified value.", "Subnet to be used for client connections.", "Subnet to be used for backup." ], "description": "Required. Purpose of the subnet." }, "name": { "description": "Identifier. The name of the OdbSubnet resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", "type": "string" }, "createTime": { "description": "Output only. The date and time that the OdbNetwork was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "cidrRange": { "description": "Required. The CIDR range of the subnet.", "type": "string" }, "state": { "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "TERMINATING", "FAILED" ], "enumDescriptions": [ "Default unspecified value.", "Indicates that the resource is in provisioning state.", "Indicates that the resource is in available state.", "Indicates that the resource is in terminating state.", "Indicates that the resource is in failed state." ], "description": "Output only. State of the ODB Subnet.", "readOnly": true, "type": "string" } }, "description": "Represents OdbSubnet resource.", "id": "OdbSubnet", "type": "object" }, "FailoverAutonomousDatabaseRequest": { "properties": { "peerAutonomousDatabase": { "description": "Optional. The peer database name to fail over to. Required for cross-region standby, and must be omitted for in-region Data Guard.", "type": "string" } }, "description": "The request for `OracleDatabase.FailoverAutonomousDatabase`.", "id": "FailoverAutonomousDatabaseRequest", "type": "object" }, "DbSystemOptions": { "properties": { "storageManagement": { "description": "Optional. The storage option used in DB system.", "enum": [ "STORAGE_MANAGEMENT_UNSPECIFIED", "ASM", "LVM" ], "type": "string", "enumDescriptions": [ "The storage management is unspecified.", "Automatic storage management.", "Logical Volume management." ] } }, "description": "Details of the DbSystem Options.", "id": "DbSystemOptions", "type": "object" }, "ListDbNodesResponse": { "properties": { "dbNodes": { "type": "array", "description": "The list of DB Nodes", "items": { "$ref": "DbNode" } }, "nextPageToken": { "description": "A token identifying a page of results the node should return.", "type": "string" } }, "description": "The response for `DbNode.List`.", "id": "ListDbNodesResponse", "type": "object" }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "properties": { "hours": { "type": "integer", "format": "int32", "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time." }, "minutes": { "format": "int32", "type": "integer", "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59." }, "seconds": { "format": "int32", "type": "integer", "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds." }, "nanos": { "format": "int32", "type": "integer", "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999." } }, "id": "TimeOfDay", "type": "object" }, "RemoveVirtualMachineExadbVmClusterRequest": { "description": "The request for `ExadbVmCluster.RemoveVirtualMachine`.", "properties": { "requestId": { "description": "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).", "type": "string" }, "hostnames": { "type": "array", "description": "Required. The list of host names of db nodes to be removed from the ExadbVmCluster.", "items": { "type": "string" } } }, "id": "RemoveVirtualMachineExadbVmClusterRequest", "type": "object" }, "AutonomousDatabaseConnectionStrings": { "properties": { "profiles": { "readOnly": true, "type": "array", "description": "Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.", "items": { "$ref": "DatabaseConnectionStringProfile" } }, "low": { "description": "Output only. The database service provides the least level of resources to each SQL statement.", "type": "string", "readOnly": true }, "allConnectionStrings": { "description": "Output only. Returns all connection strings that can be used to connect to the Autonomous Database.", "readOnly": true, "$ref": "AllConnectionStrings" }, "high": { "type": "string", "readOnly": true, "description": "Output only. The database service provides the highest level of resources to each SQL statement." }, "medium": { "readOnly": true, "type": "string", "description": "Output only. The database service provides a lower level of resources to each SQL statement." }, "dedicated": { "type": "string", "readOnly": true, "description": "Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements." } }, "description": "The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings", "id": "AutonomousDatabaseConnectionStrings", "type": "object" }, "DbHome": { "id": "DbHome", "type": "object", "properties": { "database": { "description": "Required. The Database resource.", "$ref": "Database" }, "isUnifiedAuditingEnabled": { "description": "Optional. Whether unified auditing is enabled for the Database Home.", "type": "boolean" }, "displayName": { "type": "string", "description": "Optional. The display name for the Database Home. The name does not have to be unique within your project." }, "dbVersion": { "description": "Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.", "type": "string" } }, "description": "Details of the Database Home resource." }, "DataCollectionOptions": { "id": "DataCollectionOptions", "type": "object", "description": "Data collection options for diagnostics.", "properties": { "diagnosticsEventsEnabled": { "type": "boolean", "description": "Optional. Indicates whether diagnostic collection is enabled for the VM cluster" }, "healthMonitoringEnabled": { "type": "boolean", "description": "Optional. Indicates whether health monitoring is enabled for the VM cluster" }, "incidentLogsEnabled": { "type": "boolean", "description": "Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster" } } }, "BackupDestinationDetails": { "description": "The details of the database backup destination.", "properties": { "type": { "description": "Optional. The type of the database backup destination.", "type": "string", "enumDescriptions": [ "Default unspecified value.", "Backup destination type is NFS.", "Backup destination type is Recovery Appliance.", "Backup destination type is Object Store.", "Backup destination type is Local.", "Backup destination type is DBRS." ], "enum": [ "BACKUP_DESTINATION_TYPE_UNSPECIFIED", "NFS", "RECOVERY_APPLIANCE", "OBJECT_STORE", "LOCAL", "DBRS" ] } }, "id": "BackupDestinationDetails", "type": "object" }, "DbSystem": { "id": "DbSystem", "type": "object", "properties": { "entitlementId": { "description": "Output only. The ID of the subscription entitlement associated with the DbSystem", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The date and time that the DbSystem was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "properties": { "description": "Optional. The properties of the DbSystem.", "$ref": "DbSystemProperties" }, "odbSubnet": { "type": "string", "description": "Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}" }, "displayName": { "description": "Required. The display name for the System db. The name does not have to be unique within your project.", "type": "string" }, "gcpOracleZone": { "type": "string", "description": "Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability." }, "ociUrl": { "readOnly": true, "type": "string", "description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface." }, "name": { "description": "Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}", "type": "string" }, "odbNetwork": { "description": "Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. The labels or tags associated with the DbSystem." } }, "description": "Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/" }, "DataCollectionOptionsCommon": { "description": "Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions", "properties": { "isIncidentLogsEnabled": { "type": "boolean", "description": "Optional. Indicates whether to enable incident logs and trace collection." }, "isHealthMonitoringEnabled": { "description": "Optional. Indicates whether to enable health monitoring.", "type": "boolean" }, "isDiagnosticsEventsEnabled": { "type": "boolean", "description": "Optional. Indicates whether to enable data collection for diagnostics." } }, "id": "DataCollectionOptionsCommon", "type": "object" }, "OperationMetadata": { "properties": { "verb": { "type": "string", "readOnly": true, "description": "Output only. Name of the verb executed by the operation." }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" }, "createTime": { "description": "Output only. The time the operation was created.", "readOnly": true, "format": "google-datetime", "type": "string" }, "statusMessage": { "description": "Output only. The status of the operation.", "readOnly": true, "type": "string" }, "target": { "type": "string", "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation." }, "percentComplete": { "description": "Output only. An estimated percentage of the operation that has been completed at a given moment of time, between 0 and 100.", "readOnly": true, "format": "double", "type": "number" }, "endTime": { "readOnly": true, "format": "google-datetime", "type": "string", "description": "Output only. The time the operation finished running." } }, "description": "Represents the metadata of the long-running operation.", "id": "OperationMetadata", "type": "object" }, "AutonomousDatabaseStandbySummary": { "properties": { "lagTimeDuration": { "type": "string", "readOnly": true, "format": "google-duration", "description": "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." }, "dataGuardRoleChangedTime": { "description": "Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.", "type": "string", "readOnly": true, "format": "google-datetime" }, "state": { "description": "Output only. The current lifecycle state of the Autonomous Database.", "type": "string", "readOnly": true, "enumDescriptions": [ "Default unspecified value.", "Indicates that the Autonomous Database is in provisioning state.", "Indicates that the Autonomous Database is in available state.", "Indicates that the Autonomous Database is in stopping state.", "Indicates that the Autonomous Database is in stopped state.", "Indicates that the Autonomous Database is in starting state.", "Indicates that the Autonomous Database is in terminating state.", "Indicates that the Autonomous Database is in terminated state.", "Indicates that the Autonomous Database is in unavailable state.", "Indicates that the Autonomous Database restore is in progress.", "Indicates that the Autonomous Database failed to restore.", "Indicates that the Autonomous Database backup is in progress.", "Indicates that the Autonomous Database scale is in progress.", "Indicates that the Autonomous Database is available but needs attention state.", "Indicates that the Autonomous Database is in updating state.", "Indicates that the Autonomous Database's maintenance is in progress state.", "Indicates that the Autonomous Database is in restarting state.", "Indicates that the Autonomous Database is in recreating state.", "Indicates that the Autonomous Database's role change is in progress state.", "Indicates that the Autonomous Database is in upgrading state.", "Indicates that the Autonomous Database is in inaccessible state.", "Indicates that the Autonomous Database is in standby state." ], "enum": [ "STATE_UNSPECIFIED", "PROVISIONING", "AVAILABLE", "STOPPING", "STOPPED", "STARTING", "TERMINATING", "TERMINATED", "UNAVAILABLE", "RESTORE_IN_PROGRESS", "RESTORE_FAILED", "BACKUP_IN_PROGRESS", "SCALE_IN_PROGRESS", "AVAILABLE_NEEDS_ATTENTION", "UPDATING", "MAINTENANCE_IN_PROGRESS", "RESTARTING", "RECREATING", "ROLE_CHANGE_IN_PROGRESS", "UPGRADING", "INACCESSIBLE", "STANDBY" ] }, "lifecycleDetails": { "description": "Output only. The additional details about the current lifecycle state of the Autonomous Database.", "readOnly": true, "type": "string" }, "disasterRecoveryRoleChangedTime": { "description": "Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "description": "Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary", "id": "AutonomousDatabaseStandbySummary", "type": "object" }, "ListExadbVmClustersResponse": { "id": "ListExadbVmClustersResponse", "type": "object", "properties": { "unreachable": { "description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", "items": { "type": "string" }, "type": "array" }, "exadbVmClusters": { "description": "The list of ExadbVmClusters.", "items": { "$ref": "ExadbVmCluster" }, "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" } }, "description": "The response for `ExadbVmCluster.List`." }, "CloudExadataInfrastructure": { "id": "CloudExadataInfrastructure", "type": "object", "description": "Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/", "properties": { "name": { "type": "string", "description": "Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}" }, "entitlementId": { "description": "Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned.", "type": "string", "readOnly": true }, "createTime": { "description": "Output only. The date and time that the Exadata Infrastructure was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "displayName": { "type": "string", "description": "Optional. User friendly name for this resource." }, "properties": { "description": "Optional. Various properties of the infra.", "$ref": "CloudExadataInfrastructureProperties" }, "gcpOracleZone": { "type": "string", "description": "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." }, "labels": { "description": "Optional. Labels or tags associated with the resource.", "type": "object", "additionalProperties": { "type": "string" } } } } }, "parameters": { "alt": { "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "description": "Data format for response.", "type": "string", "default": "json" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "quotaUser": { "type": "string", "description": "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.", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "location": "query", "default": "true", "type": "boolean" }, "$.xgafv": { "location": "query", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "type": "string" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "key": { "description": "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.", "location": "query", "type": "string" } }, "description": "The Oracle Database@Google Cloud API provides a set of APIs to manage Oracle database services, such as Exadata and Autonomous Databases.", "basePath": "", "kind": "discovery#restDescription", "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "response": { "$ref": "ListLocationsResponse" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query" }, "extraLocationTypes": { "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true }, "name": { "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string", "description": "The resource that owns the locations collection, if applicable." }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" } }, "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "id": "oracledatabase.projects.locations.list", "path": "v1/{+name}/locations" }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Resource name for the location." } }, "description": "Gets information about a location.", "id": "oracledatabase.projects.locations.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "response": { "$ref": "Location" }, "httpMethod": "GET", "parameterOrder": [ "name" ] } }, "resources": { "giVersions": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions", "response": { "$ref": "ListGiVersionsResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "filter": { "description": "Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape=\"{shape}\"`.", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "pageSize": { "description": "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.", "location": "query", "type": "integer", "format": "int32" } }, "description": "Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location.", "id": "oracledatabase.projects.locations.giVersions.list", "path": "v1/{+parent}/giVersions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "minorVersions": { "methods": { "list": { "id": "oracledatabase.projects.locations.giVersions.minorVersions.list", "path": "v1/{+parent}/minorVersions", "parameters": { "filter": { "description": "Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family=\"{shapeFamily}\" AND gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/giVersions/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent value for the MinorVersion resource with the format: projects/{project}/locations/{location}/giVersions/{gi_version}" }, "pageToken": { "type": "string", "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "location": "query" } }, "description": "Lists all the valid minor versions for the given project, location, gi version and shape family.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions/{giVersionsId}/minorVersions", "parameterOrder": [ "parent" ], "response": { "$ref": "ListMinorVersionsResponse" }, "httpMethod": "GET" } } } } }, "cloudExadataInfrastructures": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "CloudExadataInfrastructure" }, "parameters": { "requestId": { "type": "string", "description": "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).", "location": "query" }, "parent": { "description": "Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "cloudExadataInfrastructureId": { "type": "string", "description": "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.", "location": "query" } }, "description": "Creates a new Exadata Infrastructure in a given project and location.", "path": "v1/{+parent}/cloudExadataInfrastructures", "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.create", "httpMethod": "POST", "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures", "parameterOrder": [ "parent" ], "response": { "$ref": "ListCloudExadataInfrastructuresResponse" }, "httpMethod": "GET", "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.list", "path": "v1/{+parent}/cloudExadataInfrastructures", "parameters": { "pageToken": { "type": "string", "description": "Optional. A token identifying a page of results the server should return.", "location": "query" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" }, "parent": { "required": true, "type": "string", "description": "Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageSize": { "type": "integer", "format": "int32", "description": "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.", "location": "query" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" } }, "description": "Lists Exadata Infrastructures in a given project and location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/cloudExadataInfrastructures/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}." } }, "description": "Gets details of a single Exadata Infrastructure.", "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.get", "path": "v1/{+name}", "response": { "$ref": "CloudExadataInfrastructure" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}" }, "delete": { "parameterOrder": [ "name" ], "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/cloudExadataInfrastructures/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}." }, "force": { "description": "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.", "location": "query", "type": "boolean" }, "requestId": { "type": "string", "description": "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).", "location": "query" } }, "description": "Deletes a single Exadata Infrastructure." } }, "resources": { "dbServers": { "methods": { "list": { "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.dbServers.list", "path": "v1/{+parent}/dbServers", "parameters": { "pageSize": { "description": "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.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/cloudExadataInfrastructures/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent value for database server in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloudExadataInfrastructure}." }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "description": "Lists the database servers of an Exadata Infrastructure instance.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}/dbServers", "parameterOrder": [ "parent" ], "response": { "$ref": "ListDbServersResponse" }, "httpMethod": "GET" } } } } }, "operations": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "ListOperationsResponse" }, "path": "v1/{+name}/operations", "id": "oracledatabase.projects.locations.operations.list", "parameters": { "name": { "description": "The name of the operation's parent resource.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "format": "int32", "type": "integer", "description": "The standard list page size.", "location": "query" } }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "oracledatabase.projects.locations.operations.get", "parameters": { "name": { "description": "The name of the operation resource.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "description": "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." }, "delete": { "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true, "type": "string" } }, "description": "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`.", "id": "oracledatabase.projects.locations.operations.delete", "path": "v1/{+name}" }, "cancel": { "httpMethod": "POST", "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "CancelOperationRequest" }, "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "description": "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`.", "path": "v1/{+name}:cancel", "id": "oracledatabase.projects.locations.operations.cancel" } } }, "dbSystemShapes": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystemShapes", "parameterOrder": [ "parent" ], "response": { "$ref": "ListDbSystemShapesResponse" }, "httpMethod": "GET", "id": "oracledatabase.projects.locations.dbSystemShapes.list", "path": "v1/{+parent}/dbSystemShapes", "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "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.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent value for Database System Shapes in the following format: projects/{project}/locations/{location}." }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. Only the gcp_oracle_zone_id field is supported in this format: `gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.", "location": "query", "type": "string" } }, "description": "Lists the database system shapes available for the project and location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "odbNetworks": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.odbNetworks.list", "path": "v1/{+parent}/odbNetworks", "parameters": { "pageToken": { "type": "string", "description": "Optional. A token identifying a page of results the server should return.", "location": "query" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string" }, "filter": { "type": "string", "description": "Optional. An expression for filtering the results of the request.", "location": "query" } }, "description": "Lists the ODB Networks in a given project and location.", "parameterOrder": [ "parent" ], "response": { "$ref": "ListOdbNetworksResponse" }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks" }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "OdbNetwork" }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.odbNetworks.get", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}." } }, "description": "Gets details of a single ODB Network." }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "requestId": { "type": "string", "description": "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).", "location": "query" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", "description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", "required": true, "type": "string" } }, "description": "Deletes a single ODB Network.", "id": "oracledatabase.projects.locations.odbNetworks.delete", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "request": { "$ref": "OdbNetwork" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.odbNetworks.create", "path": "v1/{+parent}/odbNetworks", "parameters": { "odbNetworkId": { "type": "string", "description": "Required. The ID of the OdbNetwork 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.", "location": "query" }, "requestId": { "type": "string", "description": "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).", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}." } }, "description": "Creates a new ODB Network in a given project and location.", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks" } }, "resources": { "odbSubnets": { "methods": { "create": { "parameters": { "odbSubnetId": { "type": "string", "description": "Required. The ID of the OdbSubnet 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.", "location": "query" }, "requestId": { "type": "string", "description": "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).", "location": "query" }, "parent": { "description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$" } }, "description": "Creates a new ODB Subnet in a given ODB Network.", "path": "v1/{+parent}/odbSubnets", "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "OdbSubnet" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", "httpMethod": "POST", "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ] }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", "response": { "$ref": "ListOdbSubnetsResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "type": "string", "description": "Optional. A token identifying a page of results the server should return.", "location": "query" }, "orderBy": { "type": "string", "description": "Optional. An expression for ordering the results of the request.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" }, "parent": { "description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$" }, "filter": { "type": "string", "description": "Optional. An expression for filtering the results of the request.", "location": "query" } }, "description": "Lists all the ODB Subnets in a given ODB Network.", "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.list", "path": "v1/{+parent}/odbSubnets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", "location": "path" } }, "description": "Gets details of a single ODB Subnet.", "path": "v1/{+name}", "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", "httpMethod": "GET", "response": { "$ref": "OdbSubnet" }, "parameterOrder": [ "name" ] }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", "description": "Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", "required": true, "type": "string" }, "requestId": { "type": "string", "description": "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).", "location": "query" } }, "description": "Deletes a single ODB Subnet.", "path": "v1/{+name}", "id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } }, "cloudVmClusters": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "CloudVmCluster" }, "path": "v1/{+parent}/cloudVmClusters", "id": "oracledatabase.projects.locations.cloudVmClusters.create", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The name of the parent in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string" }, "cloudVmClusterId": { "description": "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.", "location": "query", "type": "string" }, "requestId": { "description": "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).", "location": "query", "type": "string" } }, "description": "Creates a new VM Cluster in a given project and location.", "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters", "response": { "$ref": "ListCloudVmClustersResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "filter": { "type": "string", "description": "Optional. An expression for filtering the results of the request.", "location": "query" }, "pageSize": { "description": "Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The name of the parent in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string" }, "pageToken": { "description": "Optional. A token identifying the page of results the server returns.", "location": "query", "type": "string" } }, "description": "Lists the VM Clusters in a given project and location.", "id": "oracledatabase.projects.locations.cloudVmClusters.list", "path": "v1/{+parent}/cloudVmClusters", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameters": { "name": { "description": "Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/cloudVmClusters/[^/]+$" } }, "description": "Gets details of a single VM Cluster.", "path": "v1/{+name}", "id": "oracledatabase.projects.locations.cloudVmClusters.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}", "httpMethod": "GET", "response": { "$ref": "CloudVmCluster" }, "parameterOrder": [ "name" ] }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "id": "oracledatabase.projects.locations.cloudVmClusters.delete", "path": "v1/{+name}", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/cloudVmClusters/[^/]+$", "description": "Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.", "required": true, "type": "string" }, "force": { "type": "boolean", "description": "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.", "location": "query" }, "requestId": { "description": "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).", "location": "query", "type": "string" } }, "description": "Deletes a single VM Cluster.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "dbNodes": { "methods": { "list": { "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "ListDbNodesResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}/dbNodes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/dbNodes", "id": "oracledatabase.projects.locations.cloudVmClusters.dbNodes.list", "parameters": { "pageSize": { "description": "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.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/cloudVmClusters/[^/]+$", "description": "Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}. .", "required": true, "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results the node should return.", "location": "query", "type": "string" } }, "description": "Lists the database nodes of a VM Cluster." } } } } }, "entitlements": { "methods": { "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "ListEntitlementsResponse" }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.entitlements.list", "path": "v1/{+parent}/entitlements", "parameters": { "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "description": "Required. The parent value for the entitlement in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "description": "Lists the entitlements in a given project." } } }, "databases": { "methods": { "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "ListDatabasesResponse" }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/databases", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.databases.list", "path": "v1/{+parent}/databases", "parameters": { "filter": { "description": "Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem=\"projects/{project}/locations/{location}/dbSystems/{dbSystemId}\"`", "location": "query", "type": "string" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent resource name in the following format: projects/{project}/locations/{region}", "required": true, "type": "string" }, "pageToken": { "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "location": "query", "type": "integer", "format": "int32" } }, "description": "Lists all the Databases for the given project, location and DbSystem." }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "Database" }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/databases/{databasesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.databases.get", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/databases/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}" } }, "description": "Gets details of a single Database." } } }, "dbSystemInitialStorageSizes": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystemInitialStorageSizes", "httpMethod": "GET", "response": { "$ref": "ListDbSystemInitialStorageSizesResponse" }, "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbSystemInitialStorageSizes will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project}/locations/{location}", "required": true, "type": "string" }, "pageToken": { "type": "string", "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", "location": "query" } }, "description": "Lists all the DbSystemInitialStorageSizes for the given project and location.", "path": "v1/{+parent}/dbSystemInitialStorageSizes", "id": "oracledatabase.projects.locations.dbSystemInitialStorageSizes.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "dbVersions": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbVersions", "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "ListDbVersionsResponse" }, "path": "v1/{+parent}/dbVersions", "id": "oracledatabase.projects.locations.dbVersions.list", "parameters": { "filter": { "description": "Optional. Filter expression that matches a subset of the DbVersions to show. The supported filter for dbSystem creation is `db_system_shape = {db_system_shape} AND storage_management = {storage_management}`. If no filter is provided, all DbVersions will be returned.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 DbVersions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent value for the DbVersion resource with the format: projects/{project}/locations/{location}" }, "pageToken": { "description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.", "location": "query", "type": "string" } }, "description": "List DbVersions for the given project and location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "autonomousDatabaseCharacterSets": { "methods": { "list": { "response": { "$ref": "ListAutonomousDatabaseCharacterSetsResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseCharacterSets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "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.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}." }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "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`.", "location": "query", "type": "string" } }, "description": "Lists Autonomous Database Character Sets in a given project and location.", "id": "oracledatabase.projects.locations.autonomousDatabaseCharacterSets.list", "path": "v1/{+parent}/autonomousDatabaseCharacterSets" } } }, "pluggableDatabases": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases", "parameterOrder": [ "parent" ], "response": { "$ref": "ListPluggableDatabasesResponse" }, "httpMethod": "GET", "id": "oracledatabase.projects.locations.pluggableDatabases.list", "path": "v1/{+parent}/pluggableDatabases", "parameters": { "pageSize": { "description": "Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "description": "Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "Optional. A page token, received from a previous `ListPluggableDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluggableDatabases` must match the call that provided the page token.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: `database=\"projects/{project}/locations/{location}/databases/{database}\"`", "location": "query", "type": "string" } }, "description": "Lists all the PluggableDatabases for the given project, location and Container Database.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "PluggableDatabase" }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases/{pluggableDatabasesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.pluggableDatabases.get", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/pluggableDatabases/[^/]+$" } }, "description": "Gets details of a single PluggableDatabase." } } }, "autonomousDbVersions": { "methods": { "list": { "httpMethod": "GET", "response": { "$ref": "ListAutonomousDbVersionsResponse" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDbVersions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "required": true, "type": "string", "description": "Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "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.", "location": "query" } }, "description": "Lists all the available Autonomous Database versions for a project and location.", "path": "v1/{+parent}/autonomousDbVersions", "id": "oracledatabase.projects.locations.autonomousDbVersions.list" } } }, "dbSystems": { "methods": { "create": { "id": "oracledatabase.projects.locations.dbSystems.create", "path": "v1/{+parent}/dbSystems", "parameters": { "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The value for parent of the DbSystem in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string" }, "dbSystemId": { "type": "string", "description": "Required. The ID of the DbSystem 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.", "location": "query" }, "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore 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).", "location": "query" } }, "description": "Creates a new DbSystem in a given project and location.", "request": { "$ref": "DbSystem" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "httpMethod": "POST" }, "list": { "parameterOrder": [ "parent" ], "httpMethod": "GET", "response": { "$ref": "ListDbSystemsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/dbSystems", "id": "oracledatabase.projects.locations.dbSystems.list", "parameters": { "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent value for DbSystems in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "orderBy": { "type": "string", "description": "Optional. An expression for ordering the results of the request.", "location": "query" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "description": "Lists all the DbSystems for the given project and location." }, "get": { "response": { "$ref": "DbSystem" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems/{dbSystemsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dbSystems/[^/]+$", "description": "Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.", "required": true, "type": "string" } }, "description": "Gets details of a single DbSystem.", "id": "oracledatabase.projects.locations.dbSystems.get", "path": "v1/{+name}" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "requestId": { "type": "string", "description": "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).", "location": "query" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/dbSystems/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}." } }, "description": "Deletes a single DbSystem.", "path": "v1/{+name}", "id": "oracledatabase.projects.locations.dbSystems.delete", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystems/{dbSystemsId}" } } }, "databaseCharacterSets": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/databaseCharacterSets", "response": { "$ref": "ListDatabaseCharacterSetsResponse" }, "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "filter": { "type": "string", "description": "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`.", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of DatabaseCharacterSets to return. The service may return fewer than this value. If unspecified, at most 50 DatabaseCharacterSets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The parent value for DatabaseCharacterSets in the following format: projects/{project}/locations/{location}." }, "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `ListDatabaseCharacterSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabaseCharacterSets` must match the call that provided the page token.", "location": "query" } }, "description": "List DatabaseCharacterSets for the given project and location.", "id": "oracledatabase.projects.locations.databaseCharacterSets.list", "path": "v1/{+parent}/databaseCharacterSets", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "exascaleDbStorageVaults": { "methods": { "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults", "response": { "$ref": "Operation" }, "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "exascaleDbStorageVaultId": { "description": "Required. The ID of the ExascaleDbStorageVault 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.", "location": "query", "type": "string" }, "requestId": { "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore 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).", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string" } }, "description": "Creates a new ExascaleDB Storage Vault resource.", "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.create", "path": "v1/{+parent}/exascaleDbStorageVaults", "request": { "$ref": "ExascaleDbStorageVault" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults", "parameterOrder": [ "parent" ], "response": { "$ref": "ListExascaleDbStorageVaultsResponse" }, "httpMethod": "GET", "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.list", "path": "v1/{+parent}/exascaleDbStorageVaults", "parameters": { "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "format": "int32", "type": "integer" }, "parent": { "description": "Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "type": "string", "description": "Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160.", "location": "query" } }, "description": "Lists all the ExascaleDB Storage Vaults for the given project and location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/exascaleDbStorageVaults/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}." } }, "description": "Gets details of a single ExascaleDB Storage Vault.", "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults/{exascaleDbStorageVaultsId}", "response": { "$ref": "ExascaleDbStorageVault" }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.exascaleDbStorageVaults.delete", "path": "v1/{+name}", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.", "pattern": "^projects/[^/]+/locations/[^/]+/exascaleDbStorageVaults/[^/]+$", "location": "path" }, "requestId": { "description": "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).", "location": "query", "type": "string" } }, "description": "Deletes a single ExascaleDB Storage Vault.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults/{exascaleDbStorageVaultsId}" } } }, "exadbVmClusters": { "resources": { "dbNodes": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}/dbNodes", "httpMethod": "GET", "response": { "$ref": "ListDbNodesResponse" }, "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "format": "int32", "type": "integer", "description": "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.", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", "description": "Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}. .", "required": true, "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results the node should return.", "location": "query", "type": "string" } }, "description": "Lists the database nodes of a VM Cluster.", "path": "v1/{+parent}/dbNodes", "id": "oracledatabase.projects.locations.exadbVmClusters.dbNodes.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } }, "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "orderBy": { "type": "string", "description": "Optional. An expression for ordering the results of the request.", "location": "query" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent value for ExadbVmClusters in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "format": "int32", "type": "integer", "description": "Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" } }, "description": "Lists all the Exadb (Exascale) VM Clusters for the given project and location.", "path": "v1/{+parent}/exadbVmClusters", "id": "oracledatabase.projects.locations.exadbVmClusters.list", "httpMethod": "GET", "response": { "$ref": "ListExadbVmClustersResponse" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters" }, "create": { "httpMethod": "POST", "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ExadbVmCluster" }, "parameters": { "exadbVmClusterId": { "type": "string", "description": "Required. The ID of the ExadbVmCluster 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.", "location": "query" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore 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).", "location": "query", "type": "string" }, "parent": { "description": "Required. The value for parent of the ExadbVmCluster in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "description": "Creates a new Exadb (Exascale) VM Cluster resource.", "path": "v1/{+parent}/exadbVmClusters", "id": "oracledatabase.projects.locations.exadbVmClusters.create" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}." } }, "description": "Gets details of a single Exadb (Exascale) VM Cluster.", "path": "v1/{+name}", "id": "oracledatabase.projects.locations.exadbVmClusters.get", "httpMethod": "GET", "response": { "$ref": "ExadbVmCluster" }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}" }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$" }, "requestId": { "type": "string", "description": "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).", "location": "query" } }, "description": "Deletes a single Exadb (Exascale) VM Cluster.", "path": "v1/{+name}", "id": "oracledatabase.projects.locations.exadbVmClusters.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "request": { "$ref": "ExadbVmCluster" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "requestId": { "type": "string", "description": "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).", "location": "query" }, "updateMask": { "description": "Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "required": true, "type": "string", "description": "Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}", "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$", "location": "path" } }, "description": "Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count.", "id": "oracledatabase.projects.locations.exadbVmClusters.patch", "path": "v1/{+name}", "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}" }, "removeVirtualMachine": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "RemoveVirtualMachineExadbVmClusterRequest" }, "parameters": { "name": { "description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$" } }, "description": "Removes virtual machines from an existing exadb vm cluster.", "path": "v1/{+name}:removeVirtualMachine", "id": "oracledatabase.projects.locations.exadbVmClusters.removeVirtualMachine", "httpMethod": "POST", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}:removeVirtualMachine" } } }, "autonomousDatabases": { "methods": { "generateWallet": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:generateWallet", "response": { "$ref": "GenerateAutonomousDatabaseWalletResponse" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "required": true, "type": "string" } }, "description": "Generates a wallet for an Autonomous Database.", "id": "oracledatabase.projects.locations.autonomousDatabases.generateWallet", "path": "v1/{+name}:generateWallet", "request": { "$ref": "GenerateAutonomousDatabaseWalletRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}", "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "requestId": { "description": "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).", "location": "query", "type": "string" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", "required": true, "type": "string" }, "updateMask": { "format": "google-fieldmask", "type": "string", "description": "Optional. Field mask is used to specify the fields to be overwritten in the Exadata resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query" } }, "description": "Updates the parameters of a single Autonomous Database.", "id": "oracledatabase.projects.locations.autonomousDatabases.patch", "path": "v1/{+name}", "request": { "$ref": "AutonomousDatabase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.autonomousDatabases.delete", "path": "v1/{+name}", "parameters": { "requestId": { "description": "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).", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}." } }, "description": "Deletes a single Autonomous Database.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}" }, "restart": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:restart", "httpMethod": "POST", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$" } }, "description": "Restarts an Autonomous Database.", "path": "v1/{+name}:restart", "id": "oracledatabase.projects.locations.autonomousDatabases.restart", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "RestartAutonomousDatabaseRequest" } }, "create": { "id": "oracledatabase.projects.locations.autonomousDatabases.create", "path": "v1/{+parent}/autonomousDatabases", "parameters": { "requestId": { "type": "string", "description": "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).", "location": "query" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the parent in the following format: projects/{project}/locations/{location}." }, "autonomousDatabaseId": { "type": "string", "description": "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.", "location": "query" } }, "description": "Creates a new Autonomous Database in a given project and location.", "request": { "$ref": "AutonomousDatabase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases", "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "httpMethod": "POST" }, "list": { "httpMethod": "GET", "response": { "$ref": "ListAutonomousDatabasesResponse" }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageSize": { "description": "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.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "required": true, "type": "string", "description": "Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path" }, "filter": { "description": "Optional. An expression for filtering the results of the request.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "orderBy": { "type": "string", "description": "Optional. An expression for ordering the results of the request.", "location": "query" } }, "description": "Lists the Autonomous Databases in a given project and location.", "path": "v1/{+parent}/autonomousDatabases", "id": "oracledatabase.projects.locations.autonomousDatabases.list" }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}", "parameterOrder": [ "name" ], "response": { "$ref": "AutonomousDatabase" }, "httpMethod": "GET", "id": "oracledatabase.projects.locations.autonomousDatabases.get", "path": "v1/{+name}", "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path" } }, "description": "Gets the details of a single Autonomous Database.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "stop": { "id": "oracledatabase.projects.locations.autonomousDatabases.stop", "path": "v1/{+name}:stop", "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$" } }, "description": "Stops an Autonomous Database.", "request": { "$ref": "StopAutonomousDatabaseRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:stop", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "httpMethod": "POST" }, "start": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:start", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "httpMethod": "POST", "id": "oracledatabase.projects.locations.autonomousDatabases.start", "path": "v1/{+name}:start", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}." } }, "description": "Starts an Autonomous Database.", "request": { "$ref": "StartAutonomousDatabaseRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "failover": { "request": { "$ref": "FailoverAutonomousDatabaseRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.autonomousDatabases.failover", "path": "v1/{+name}:failover", "parameters": { "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "required": true, "type": "string" } }, "description": "Initiates a failover to target autonomous database from the associated primary database.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:failover" }, "restore": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:restore", "parameterOrder": [ "name" ], "httpMethod": "POST", "response": { "$ref": "Operation" }, "path": "v1/{+name}:restore", "id": "oracledatabase.projects.locations.autonomousDatabases.restore", "parameters": { "name": { "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$" } }, "description": "Restores a single Autonomous Database.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "RestoreAutonomousDatabaseRequest" } }, "switchover": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:switchover", "response": { "$ref": "Operation" }, "httpMethod": "POST", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", "location": "path", "required": true, "type": "string", "description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}." } }, "description": "Initiates a switchover of specified autonomous database to the associated peer database.", "id": "oracledatabase.projects.locations.autonomousDatabases.switchover", "path": "v1/{+name}:switchover", "request": { "$ref": "SwitchoverAutonomousDatabaseRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "autonomousDatabaseBackups": { "methods": { "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "ListAutonomousDatabaseBackupsResponse" }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseBackups", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "oracledatabase.projects.locations.autonomousDatabaseBackups.list", "path": "v1/{+parent}/autonomousDatabaseBackups", "parameters": { "pageSize": { "format": "int32", "type": "integer", "description": "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.", "location": "query" }, "parent": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project}/locations/{location}.", "required": true, "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "filter": { "description": "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.", "location": "query", "type": "string" } }, "description": "Lists the long-term and automatic backups of an Autonomous Database." } } } } } } } }, "name": "oracledatabase", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "version": "v1", "title": "Oracle Database@Google Cloud API" }