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

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets details of a single PluggableDatabase.

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

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

list_next()

Retrieves the next page of results.

Method Details

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

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

Returns:
  An object of the form:

    { # The PluggableDatabase resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/PluggableDatabase/
  "createTime": "A String", # Output only. The date and time that the PluggableDatabase was created.
  "name": "A String", # Identifier. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}
  "ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
  "properties": { # The properties of a PluggableDatabase. # Optional. The properties of the PluggableDatabase.
    "compartmentId": "A String", # Required. The OCID of the compartment.
    "connectionStrings": { # The connection strings used to connect to the Oracle Database. # Optional. The Connection strings used to connect to the Oracle Database.
      "allConnectionStrings": { # Optional. All connection strings to use to connect to the pluggable database.
        "a_key": "A String",
      },
      "pdbDefault": "A String", # Optional. The default connection string to use to connect to the pluggable database.
      "pdbIpDefault": "A String", # Optional. The default connection string to use to connect to the pluggable database using IP.
    },
    "containerDatabaseOcid": "A String", # Required. The OCID of the CDB.
    "databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The configuration of the Database Management service.
      "managementState": "A String", # Output only. The status of the Database Management service.
      "managementType": "A String", # Output only. The Database Management type.
    },
    "definedTags": { # Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace.
      "a_key": { # Wrapper message for the value of a defined tag.
        "tags": { # The tags within the namespace.
          "a_key": "A String",
        },
      },
    },
    "freeformTags": { # Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
      "a_key": "A String",
    },
    "isRestricted": True or False, # 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.
    "lifecycleDetails": "A String", # Output only. Additional information about the current lifecycle state.
    "lifecycleState": "A String", # Output only. The current state of the pluggable database.
    "ocid": "A String", # Output only. The OCID of the pluggable database.
    "operationsInsightsState": "A String", # Output only. The status of Operations Insights for this Database.
    "pdbName": "A String", # Required. The database name.
    "pdbNodeLevelDetails": [ # Optional. Pluggable Database Node Level Details
      { # The Pluggable Database Node Level Details.
        "nodeName": "A String", # Required. The Node name of the Database home.
        "openMode": "A String", # Required. The mode that the pluggable database is in to open it.
        "pluggableDatabaseId": "A String", # Required. The OCID of the Pluggable Database.
      },
    ],
  },
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the PluggableDatabases for the given project, location and Container Database.

Args:
  parent: string, Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location} (required)
  filter: string, 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}"`
  pageSize: integer, Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.
  pageToken: string, 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.
  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 `PluggableDatabase.List`.
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "pluggableDatabases": [ # The list of PluggableDatabases.
    { # The PluggableDatabase resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/PluggableDatabase/
      "createTime": "A String", # Output only. The date and time that the PluggableDatabase was created.
      "name": "A String", # Identifier. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}
      "ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
      "properties": { # The properties of a PluggableDatabase. # Optional. The properties of the PluggableDatabase.
        "compartmentId": "A String", # Required. The OCID of the compartment.
        "connectionStrings": { # The connection strings used to connect to the Oracle Database. # Optional. The Connection strings used to connect to the Oracle Database.
          "allConnectionStrings": { # Optional. All connection strings to use to connect to the pluggable database.
            "a_key": "A String",
          },
          "pdbDefault": "A String", # Optional. The default connection string to use to connect to the pluggable database.
          "pdbIpDefault": "A String", # Optional. The default connection string to use to connect to the pluggable database using IP.
        },
        "containerDatabaseOcid": "A String", # Required. The OCID of the CDB.
        "databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The configuration of the Database Management service.
          "managementState": "A String", # Output only. The status of the Database Management service.
          "managementType": "A String", # Output only. The Database Management type.
        },
        "definedTags": { # Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace.
          "a_key": { # Wrapper message for the value of a defined tag.
            "tags": { # The tags within the namespace.
              "a_key": "A String",
            },
          },
        },
        "freeformTags": { # Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
          "a_key": "A String",
        },
        "isRestricted": True or False, # 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.
        "lifecycleDetails": "A String", # Output only. Additional information about the current lifecycle state.
        "lifecycleState": "A String", # Output only. The current state of the pluggable database.
        "ocid": "A String", # Output only. The OCID of the pluggable database.
        "operationsInsightsState": "A String", # Output only. The status of Operations Insights for this Database.
        "pdbName": "A String", # Required. The database name.
        "pdbNodeLevelDetails": [ # Optional. Pluggable Database Node Level Details
          { # The Pluggable Database Node Level Details.
            "nodeName": "A String", # Required. The Node name of the Database home.
            "openMode": "A String", # Required. The mode that the pluggable database is in to open it.
            "pluggableDatabaseId": "A String", # Required. The OCID of the Pluggable Database.
          },
        ],
      },
    },
  ],
}
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.