Oracle Database@Google Cloud API . projects . locations . databases

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets details of a single Database.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

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

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets details of a single Database.

Args:
  name: string, Required. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/
  "adminPassword": "A String", # Required. The password for the default ADMIN user.
  "characterSet": "A String", # Optional. The character set for the database. The default is AL32UTF8.
  "createTime": "A String", # Output only. The date and time that the Database was created.
  "databaseId": "A String", # Optional. The database ID of the Database.
  "dbHomeName": "A String", # Optional. The name of the DbHome resource associated with the Database.
  "dbName": "A String", # 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.
  "dbUniqueName": "A String", # Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
  "gcpOracleZone": "A String", # Output only. The GCP Oracle zone where the Database is created.
  "name": "A String", # Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
  "ncharacterSet": "A String", # Optional. The national character set for the database. The default is AL16UTF16.
  "ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
  "opsInsightsStatus": "A String", # Output only. The Status of Operations Insights for this Database.
  "properties": { # The properties of a Database. # Optional. The properties of the Database.
    "databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The Database Management config.
      "managementState": "A String", # Output only. The status of the Database Management service.
      "managementType": "A String", # Output only. The Database Management type.
    },
    "dbBackupConfig": { # Backup Options for the Database. # Optional. Backup options for the Database.
      "autoBackupEnabled": True or False, # Optional. If set to true, enables automatic backups on the database.
      "autoFullBackupDay": "A String", # 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.
      "autoFullBackupWindow": "A String", # Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.
      "autoIncrementalBackupWindow": "A String", # 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": "A String", # Optional. This defines when the backups will be deleted after Database termination.
      "backupDestinationDetails": [ # Optional. Details of the database backup destinations.
        { # The details of the database backup destination.
          "type": "A String", # Optional. The type of the database backup destination.
        },
      ],
      "retentionPeriodDays": 42, # 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.
    },
    "dbVersion": "A String", # Required. The Oracle Database version.
    "state": "A String", # Output only. State of the Database.
  },
  "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the Databases for the given project, location and DbSystem.

Args:
  parent: string, Required. The parent resource name in the following format: projects/{project}/locations/{region} (required)
  filter: string, 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}"`
  pageSize: integer, 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.
  pageToken: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for `Database.List`.
  "databases": [ # The list of Databases.
    { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/
      "adminPassword": "A String", # Required. The password for the default ADMIN user.
      "characterSet": "A String", # Optional. The character set for the database. The default is AL32UTF8.
      "createTime": "A String", # Output only. The date and time that the Database was created.
      "databaseId": "A String", # Optional. The database ID of the Database.
      "dbHomeName": "A String", # Optional. The name of the DbHome resource associated with the Database.
      "dbName": "A String", # 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.
      "dbUniqueName": "A String", # Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
      "gcpOracleZone": "A String", # Output only. The GCP Oracle zone where the Database is created.
      "name": "A String", # Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
      "ncharacterSet": "A String", # Optional. The national character set for the database. The default is AL16UTF16.
      "ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
      "opsInsightsStatus": "A String", # Output only. The Status of Operations Insights for this Database.
      "properties": { # The properties of a Database. # Optional. The properties of the Database.
        "databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The Database Management config.
          "managementState": "A String", # Output only. The status of the Database Management service.
          "managementType": "A String", # Output only. The Database Management type.
        },
        "dbBackupConfig": { # Backup Options for the Database. # Optional. Backup options for the Database.
          "autoBackupEnabled": True or False, # Optional. If set to true, enables automatic backups on the database.
          "autoFullBackupDay": "A String", # 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.
          "autoFullBackupWindow": "A String", # Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.
          "autoIncrementalBackupWindow": "A String", # 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": "A String", # Optional. This defines when the backups will be deleted after Database termination.
          "backupDestinationDetails": [ # Optional. Details of the database backup destinations.
            { # The details of the database backup destination.
              "type": "A String", # Optional. The type of the database backup destination.
            },
          ],
          "retentionPeriodDays": 42, # 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.
        },
        "dbVersion": "A String", # Required. The Oracle Database version.
        "state": "A String", # Output only. State of the Database.
      },
      "tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database.
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.