Class OracleDatabaseClient (0.1.2) 

OracleDatabaseClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.oracledatabase_v1.services.oracle_database.transports.base.OracleDatabaseTransport, typing.Callable[[...], google.cloud.oracledatabase_v1.services.oracle_database.transports.base.OracleDatabaseTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service describing handlers for resources

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
OracleDatabaseTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

OracleDatabaseClient

OracleDatabaseClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.oracledatabase_v1.services.oracle_database.transports.base.OracleDatabaseTransport, typing.Callable[[...], google.cloud.oracledatabase_v1.services.oracle_database.transports.base.OracleDatabaseTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the oracle database client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,OracleDatabaseTransport,Callable[..., OracleDatabaseTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the OracleDatabaseTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

autonomous_database_backup_path

autonomous_database_backup_path(
    project: str, location: str, autonomous_database_backup: str
) -> str

Returns a fully-qualified autonomous_database_backup string.

autonomous_database_character_set_path

autonomous_database_character_set_path(
    project: str, location: str, autonomous_database_character_set: str
) -> str

Returns a fully-qualified autonomous_database_character_set string.

autonomous_database_path

autonomous_database_path(
    project: str, location: str, autonomous_database: str
) -> str

Returns a fully-qualified autonomous_database string.

autonomous_db_version_path

autonomous_db_version_path(
    project: str, location: str, autonomous_db_version: str
) -> str

Returns a fully-qualified autonomous_db_version string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

cloud_exadata_infrastructure_path

cloud_exadata_infrastructure_path(
    project: str, location: str, cloud_exadata_infrastructure: str
) -> str

Returns a fully-qualified cloud_exadata_infrastructure string.

cloud_vm_cluster_path

cloud_vm_cluster_path(project: str, location: str, cloud_vm_cluster: str) -> str

Returns a fully-qualified cloud_vm_cluster string.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_autonomous_database

create_autonomous_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.CreateAutonomousDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    autonomous_database: typing.Optional[
        google.cloud.oracledatabase_v1.types.autonomous_database.AutonomousDatabase
    ] = None,
    autonomous_database_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new Autonomous Database in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_create_autonomous_database():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    autonomous_database = oracledatabase_v1.AutonomousDatabase()
    autonomous_database.network = "network_value"
    autonomous_database.cidr = "cidr_value"

    request = oracledatabase_v1.CreateAutonomousDatabaseRequest(
        parent="parent_value",
        autonomous_database_id="autonomous_database_id_value",
        autonomous_database=autonomous_database,
    )

    # Make the request
    operation = client.create_autonomous_database(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.CreateAutonomousDatabaseRequest, dict]

The request object. The request for AutonomousDatabase.Create.
parent str

Required. The name of the parent in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
autonomous_database google.cloud.oracledatabase_v1.types.AutonomousDatabase

Required. The Autonomous Database being created. This corresponds to the autonomous_database field on the request instance; if request is provided, this should not be set.
autonomous_database_id str

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. This corresponds to the autonomous_database_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be AutonomousDatabase Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/

create_cloud_exadata_infrastructure

create_cloud_exadata_infrastructure(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.CreateCloudExadataInfrastructureRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    cloud_exadata_infrastructure: typing.Optional[
        google.cloud.oracledatabase_v1.types.exadata_infra.CloudExadataInfrastructure
    ] = None,
    cloud_exadata_infrastructure_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new Exadata Infrastructure in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_create_cloud_exadata_infrastructure():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.CreateCloudExadataInfrastructureRequest(
        parent="parent_value",
        cloud_exadata_infrastructure_id="cloud_exadata_infrastructure_id_value",
    )

    # Make the request
    operation = client.create_cloud_exadata_infrastructure(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.CreateCloudExadataInfrastructureRequest, dict]

The request object. The request for CloudExadataInfrastructure.Create.
parent str

Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
cloud_exadata_infrastructure google.cloud.oracledatabase_v1.types.CloudExadataInfrastructure

Required. Details of the Exadata Infrastructure instance to create. This corresponds to the cloud_exadata_infrastructure field on the request instance; if request is provided, this should not be set.
cloud_exadata_infrastructure_id str

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. This corresponds to the cloud_exadata_infrastructure_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be CloudExadataInfrastructure Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/

create_cloud_vm_cluster

create_cloud_vm_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.CreateCloudVmClusterRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    cloud_vm_cluster: typing.Optional[
        google.cloud.oracledatabase_v1.types.vm_cluster.CloudVmCluster
    ] = None,
    cloud_vm_cluster_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Creates a new VM Cluster in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_create_cloud_vm_cluster():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    cloud_vm_cluster = oracledatabase_v1.CloudVmCluster()
    cloud_vm_cluster.exadata_infrastructure = "exadata_infrastructure_value"
    cloud_vm_cluster.cidr = "cidr_value"
    cloud_vm_cluster.backup_subnet_cidr = "backup_subnet_cidr_value"
    cloud_vm_cluster.network = "network_value"

    request = oracledatabase_v1.CreateCloudVmClusterRequest(
        parent="parent_value",
        cloud_vm_cluster_id="cloud_vm_cluster_id_value",
        cloud_vm_cluster=cloud_vm_cluster,
    )

    # Make the request
    operation = client.create_cloud_vm_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.CreateCloudVmClusterRequest, dict]

The request object. The request for CloudVmCluster.Create.
parent str

Required. The name of the parent in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
cloud_vm_cluster google.cloud.oracledatabase_v1.types.CloudVmCluster

Required. The resource being created This corresponds to the cloud_vm_cluster field on the request instance; if request is provided, this should not be set.
cloud_vm_cluster_id str

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. This corresponds to the cloud_vm_cluster_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be CloudVmCluster Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/

db_node_path

db_node_path(
    project: str, location: str, cloud_vm_cluster: str, db_node: str
) -> str

Returns a fully-qualified db_node string.

db_server_path

db_server_path(
    project: str, location: str, cloud_exadata_infrastructure: str, db_server: str
) -> str

Returns a fully-qualified db_server string.

db_system_shape_path

db_system_shape_path(project: str, location: str, db_system_shape: str) -> str

Returns a fully-qualified db_system_shape string.

delete_autonomous_database

delete_autonomous_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.DeleteAutonomousDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes a single Autonomous Database.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_delete_autonomous_database():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.DeleteAutonomousDatabaseRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_autonomous_database(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.DeleteAutonomousDatabaseRequest, dict]

The request object. The request for AutonomousDatabase.Delete.
name str

Required. The name of the resource in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty 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); }

delete_cloud_exadata_infrastructure

delete_cloud_exadata_infrastructure(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.DeleteCloudExadataInfrastructureRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes a single Exadata Infrastructure.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_delete_cloud_exadata_infrastructure():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.DeleteCloudExadataInfrastructureRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_cloud_exadata_infrastructure(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.DeleteCloudExadataInfrastructureRequest, dict]

The request object. The request for CloudExadataInfrastructure.Delete.
name str

Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty 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); }

delete_cloud_vm_cluster

delete_cloud_vm_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.DeleteCloudVmClusterRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Deletes a single VM Cluster.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_delete_cloud_vm_cluster():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.DeleteCloudVmClusterRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_cloud_vm_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.DeleteCloudVmClusterRequest, dict]

The request object. The request for CloudVmCluster.Delete.
name str

Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty 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); }

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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.

Parameters
Name Description
request .operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

entitlement_path

entitlement_path(project: str, location: str, entitlement: str) -> str

Returns a fully-qualified entitlement string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
OracleDatabaseClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
OracleDatabaseClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
OracleDatabaseClient The constructed client.

generate_autonomous_database_wallet

generate_autonomous_database_wallet(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.GenerateAutonomousDatabaseWalletRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    type_: typing.Optional[
        google.cloud.oracledatabase_v1.types.autonomous_database.GenerateType
    ] = None,
    is_regional: typing.Optional[bool] = None,
    password: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.oracledatabase_v1.types.oracledatabase.GenerateAutonomousDatabaseWalletResponse
)

Generates a wallet for an Autonomous Database.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_generate_autonomous_database_wallet():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.GenerateAutonomousDatabaseWalletRequest(
        name="name_value",
        password="password_value",
    )

    # Make the request
    response = client.generate_autonomous_database_wallet(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.GenerateAutonomousDatabaseWalletRequest, dict]

The request object. The request for AutonomousDatabase.GenerateWallet.
name str

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
type_ google.cloud.oracledatabase_v1.types.GenerateType

Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE. This corresponds to the type_ field on the request instance; if request is provided, this should not be set.
is_regional bool

Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only. This corresponds to the is_regional field on the request instance; if request is provided, this should not be set.
password str

Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters. This corresponds to the password field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.types.GenerateAutonomousDatabaseWalletResponse The response for AutonomousDatabase.GenerateWallet.

get_autonomous_database

get_autonomous_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.GetAutonomousDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.oracledatabase_v1.types.autonomous_database.AutonomousDatabase

Gets the details of a single Autonomous Database.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_get_autonomous_database():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.GetAutonomousDatabaseRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_autonomous_database(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.GetAutonomousDatabaseRequest, dict]

The request object. The request for AutonomousDatabase.Get.
name str

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.types.AutonomousDatabase Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/

get_cloud_exadata_infrastructure

get_cloud_exadata_infrastructure(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.GetCloudExadataInfrastructureRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.oracledatabase_v1.types.exadata_infra.CloudExadataInfrastructure

Gets details of a single Exadata Infrastructure.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_get_cloud_exadata_infrastructure():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.GetCloudExadataInfrastructureRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_cloud_exadata_infrastructure(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.GetCloudExadataInfrastructureRequest, dict]

The request object. The request for CloudExadataInfrastructure.Get.
name str

Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.types.CloudExadataInfrastructure Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/

get_cloud_vm_cluster

get_cloud_vm_cluster(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.GetCloudVmClusterRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.oracledatabase_v1.types.vm_cluster.CloudVmCluster

Gets details of a single VM Cluster.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_get_cloud_vm_cluster():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.GetCloudVmClusterRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_cloud_vm_cluster(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.GetCloudVmClusterRequest, dict]

The request object. The request for CloudVmCluster.Get.
name str

Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.types.CloudVmCluster Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.location_pb2.Location Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operations_pb2.Operation An Operation object.

gi_version_path

gi_version_path(project: str, location: str, gi_version: str) -> str

Returns a fully-qualified gi_version string.

list_autonomous_database_backups

list_autonomous_database_backups(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListAutonomousDatabaseBackupsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListAutonomousDatabaseBackupsPager
)

Lists the long-term and automatic backups of an Autonomous Database.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_autonomous_database_backups():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListAutonomousDatabaseBackupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_autonomous_database_backups(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListAutonomousDatabaseBackupsRequest, dict]

The request object. The request for AutonomousDatabaseBackup.List.
parent str

Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListAutonomousDatabaseBackupsPager The response for AutonomousDatabaseBackup.List. Iterating over this object will yield results and resolve additional pages automatically.

list_autonomous_database_character_sets

list_autonomous_database_character_sets(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListAutonomousDatabaseCharacterSetsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListAutonomousDatabaseCharacterSetsPager
)

Lists Autonomous Database Character Sets in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_autonomous_database_character_sets():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListAutonomousDatabaseCharacterSetsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_autonomous_database_character_sets(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListAutonomousDatabaseCharacterSetsRequest, dict]

The request object. The request for AutonomousDatabaseCharacterSet.List.
parent str

Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListAutonomousDatabaseCharacterSetsPager The response for AutonomousDatabaseCharacterSet.List. Iterating over this object will yield results and resolve additional pages automatically.

list_autonomous_databases

list_autonomous_databases(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListAutonomousDatabasesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListAutonomousDatabasesPager
)

Lists the Autonomous Databases in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_autonomous_databases():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListAutonomousDatabasesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_autonomous_databases(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListAutonomousDatabasesRequest, dict]

The request object. The request for AutonomousDatabase.List.
parent str

Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListAutonomousDatabasesPager The response for AutonomousDatabase.List. Iterating over this object will yield results and resolve additional pages automatically.

list_autonomous_db_versions

list_autonomous_db_versions(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListAutonomousDbVersionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListAutonomousDbVersionsPager
)

Lists all the available Autonomous Database versions for a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_autonomous_db_versions():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListAutonomousDbVersionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_autonomous_db_versions(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListAutonomousDbVersionsRequest, dict]

The request object. The request for AutonomousDbVersion.List.
parent str

Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListAutonomousDbVersionsPager The response for AutonomousDbVersion.List. Iterating over this object will yield results and resolve additional pages automatically.

list_cloud_exadata_infrastructures

list_cloud_exadata_infrastructures(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListCloudExadataInfrastructuresRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListCloudExadataInfrastructuresPager
)

Lists Exadata Infrastructures in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_cloud_exadata_infrastructures():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListCloudExadataInfrastructuresRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_cloud_exadata_infrastructures(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListCloudExadataInfrastructuresRequest, dict]

The request object. The request for CloudExadataInfrastructures.List.
parent str

Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListCloudExadataInfrastructuresPager The response for CloudExadataInfrastructures.list. Iterating over this object will yield results and resolve additional pages automatically.

list_cloud_vm_clusters

list_cloud_vm_clusters(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListCloudVmClustersRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListCloudVmClustersPager
)

Lists the VM Clusters in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_cloud_vm_clusters():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListCloudVmClustersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_cloud_vm_clusters(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListCloudVmClustersRequest, dict]

The request object. The request for CloudVmCluster.List.
parent str

Required. The name of the parent in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListCloudVmClustersPager The response for CloudVmCluster.List. Iterating over this object will yield results and resolve additional pages automatically.

list_db_nodes

list_db_nodes(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListDbNodesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListDbNodesPager

Lists the database nodes of a VM Cluster.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_db_nodes():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListDbNodesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_db_nodes(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListDbNodesRequest, dict]

The request object. The request for DbNode.List.
parent str

Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListDbNodesPager The response for DbNode.List. Iterating over this object will yield results and resolve additional pages automatically.

list_db_servers

list_db_servers(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListDbServersRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListDbServersPager

Lists the database servers of an Exadata Infrastructure instance.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_db_servers():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListDbServersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_db_servers(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListDbServersRequest, dict]

The request object. The request for DbServer.List.
parent str

Required. The parent value for database server in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloudExadataInfrastructure}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListDbServersPager The response for DbServer.List. Iterating over this object will yield results and resolve additional pages automatically.

list_db_system_shapes

list_db_system_shapes(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListDbSystemShapesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListDbSystemShapesPager
)

Lists the database system shapes available for the project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_db_system_shapes():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListDbSystemShapesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_db_system_shapes(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListDbSystemShapesRequest, dict]

The request object. The request for DbSystemShape.List.
parent str

Required. The parent value for Database System Shapes in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListDbSystemShapesPager The response for DbSystemShape.List. Iterating over this object will yield results and resolve additional pages automatically.

list_entitlements

list_entitlements(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListEntitlementsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListEntitlementsPager
)

Lists the entitlements in a given project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_entitlements():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListEntitlementsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_entitlements(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListEntitlementsRequest, dict]

The request object. The request for Entitlement.List.
parent str

Required. The parent value for the entitlement in the following format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListEntitlementsPager The response for Entitlement.List. Iterating over this object will yield results and resolve additional pages automatically.

list_gi_versions

list_gi_versions(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.ListGiVersionsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListGiVersionsPager

Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_list_gi_versions():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.ListGiVersionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_gi_versions(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.ListGiVersionsRequest, dict]

The request object. The request for GiVersion.List.
parent str

Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.oracledatabase_v1.services.oracle_database.pagers.ListGiVersionsPager The response for GiVersion.List. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

network_path

network_path(project: str, network: str) -> str

Returns a fully-qualified network string.

parse_autonomous_database_backup_path

parse_autonomous_database_backup_path(path: str) -> typing.Dict[str, str]

Parses a autonomous_database_backup path into its component segments.

parse_autonomous_database_character_set_path

parse_autonomous_database_character_set_path(path: str) -> typing.Dict[str, str]

Parses a autonomous_database_character_set path into its component segments.

parse_autonomous_database_path

parse_autonomous_database_path(path: str) -> typing.Dict[str, str]

Parses a autonomous_database path into its component segments.

parse_autonomous_db_version_path

parse_autonomous_db_version_path(path: str) -> typing.Dict[str, str]

Parses a autonomous_db_version path into its component segments.

parse_cloud_exadata_infrastructure_path

parse_cloud_exadata_infrastructure_path(path: str) -> typing.Dict[str, str]

Parses a cloud_exadata_infrastructure path into its component segments.

parse_cloud_vm_cluster_path

parse_cloud_vm_cluster_path(path: str) -> typing.Dict[str, str]

Parses a cloud_vm_cluster path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_db_node_path

parse_db_node_path(path: str) -> typing.Dict[str, str]

Parses a db_node path into its component segments.

parse_db_server_path

parse_db_server_path(path: str) -> typing.Dict[str, str]

Parses a db_server path into its component segments.

parse_db_system_shape_path

parse_db_system_shape_path(path: str) -> typing.Dict[str, str]

Parses a db_system_shape path into its component segments.

parse_entitlement_path

parse_entitlement_path(path: str) -> typing.Dict[str, str]

Parses a entitlement path into its component segments.

parse_gi_version_path

parse_gi_version_path(path: str) -> typing.Dict[str, str]

Parses a gi_version path into its component segments.

parse_network_path

parse_network_path(path: str) -> typing.Dict[str, str]

Parses a network path into its component segments.

restore_autonomous_database

restore_autonomous_database(
    request: typing.Optional[
        typing.Union[
            google.cloud.oracledatabase_v1.types.oracledatabase.RestoreAutonomousDatabaseRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    restore_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Restores a single Autonomous Database.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oracledatabase_v1

def sample_restore_autonomous_database():
    # Create a client
    client = oracledatabase_v1.OracleDatabaseClient()

    # Initialize request argument(s)
    request = oracledatabase_v1.RestoreAutonomousDatabaseRequest(
        name="name_value",
    )

    # Make the request
    operation = client.restore_autonomous_database(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.oracledatabase_v1.types.RestoreAutonomousDatabaseRequest, dict]

The request object. The request for AutonomousDatabase.Restore.
name str

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
restore_time google.protobuf.timestamp_pb2.Timestamp

Required. The time and date to restore the database to. This corresponds to the restore_time field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be AutonomousDatabase Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/