| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="oracledatabase_v1.html">Oracle Database@Google Cloud API</a> . <a href="oracledatabase_v1.projects.html">projects</a> . <a href="oracledatabase_v1.projects.locations.html">locations</a> . <a href="oracledatabase_v1.projects.locations.pluggableDatabases.html">pluggableDatabases</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a single PluggableDatabase.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all the PluggableDatabases for the given project, location and Container Database.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>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. |
| }, |
| ], |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>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. |
| }, |
| ], |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| </body></html> |
