Google Cloud Oracle Database V1 Client - Class OracleDatabaseClient (0.8.0)

Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class OracleDatabaseClient.

Service Description: Service describing handlers for resources

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ OracleDatabase \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name Description
options array|Google\ApiCore\Options\ClientOptions

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials FetchAuthTokenInterface|CredentialsWrapper

This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\OracleDatabase\V1\OracleDatabaseClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new OracleDatabaseClient(['credentials' => $creds]); https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

↳ logger false|LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

↳ universeDomain string

The service domain for the client. Defaults to 'googleapis.com'.

createAutonomousDatabase

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

The async variant is OracleDatabaseClient::createAutonomousDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateAutonomousDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\AutonomousDatabase>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabase;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CreateAutonomousDatabaseRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent      The name of the parent in the following format:
 *                                     projects/{project}/locations/{location}. Please see
 *                                     {@see OracleDatabaseClient::locationName()} for help formatting this field.
 * @param string $autonomousDatabaseId 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.
 */
function create_autonomous_database_sample(
    string $formattedParent,
    string $autonomousDatabaseId
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $autonomousDatabase = new AutonomousDatabase();
    $request = (new CreateAutonomousDatabaseRequest())
        ->setParent($formattedParent)
        ->setAutonomousDatabaseId($autonomousDatabaseId)
        ->setAutonomousDatabase($autonomousDatabase);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->createAutonomousDatabase($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AutonomousDatabase $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');
    $autonomousDatabaseId = '[AUTONOMOUS_DATABASE_ID]';

    create_autonomous_database_sample($formattedParent, $autonomousDatabaseId);
}

createCloudExadataInfrastructure

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

The async variant is OracleDatabaseClient::createCloudExadataInfrastructureAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateCloudExadataInfrastructureRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\CloudExadataInfrastructure>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CloudExadataInfrastructure;
use Google\Cloud\OracleDatabase\V1\CreateCloudExadataInfrastructureRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent              The parent value for CloudExadataInfrastructure in the following
 *                                             format: projects/{project}/locations/{location}. Please see
 *                                             {@see OracleDatabaseClient::locationName()} for help formatting this field.
 * @param string $cloudExadataInfrastructureId 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.
 */
function create_cloud_exadata_infrastructure_sample(
    string $formattedParent,
    string $cloudExadataInfrastructureId
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $cloudExadataInfrastructure = new CloudExadataInfrastructure();
    $request = (new CreateCloudExadataInfrastructureRequest())
        ->setParent($formattedParent)
        ->setCloudExadataInfrastructureId($cloudExadataInfrastructureId)
        ->setCloudExadataInfrastructure($cloudExadataInfrastructure);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->createCloudExadataInfrastructure($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var CloudExadataInfrastructure $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');
    $cloudExadataInfrastructureId = '[CLOUD_EXADATA_INFRASTRUCTURE_ID]';

    create_cloud_exadata_infrastructure_sample($formattedParent, $cloudExadataInfrastructureId);
}

createCloudVmCluster

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

The async variant is OracleDatabaseClient::createCloudVmClusterAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateCloudVmClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\CloudVmCluster>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CloudVmCluster;
use Google\Cloud\OracleDatabase\V1\CreateCloudVmClusterRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                              The name of the parent in the following format:
 *                                                             projects/{project}/locations/{location}. Please see
 *                                                             {@see OracleDatabaseClient::locationName()} for help formatting this field.
 * @param string $cloudVmClusterId                             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.
 * @param string $formattedCloudVmClusterExadataInfrastructure The name of the Exadata Infrastructure resource on which VM
 *                                                             cluster resource is created, in the following format:
 *                                                             projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}
 *                                                             Please see {@see OracleDatabaseClient::cloudExadataInfrastructureName()} for help formatting this field.
 */
function create_cloud_vm_cluster_sample(
    string $formattedParent,
    string $cloudVmClusterId,
    string $formattedCloudVmClusterExadataInfrastructure
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $cloudVmCluster = (new CloudVmCluster())
        ->setExadataInfrastructure($formattedCloudVmClusterExadataInfrastructure);
    $request = (new CreateCloudVmClusterRequest())
        ->setParent($formattedParent)
        ->setCloudVmClusterId($cloudVmClusterId)
        ->setCloudVmCluster($cloudVmCluster);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->createCloudVmCluster($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var CloudVmCluster $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');
    $cloudVmClusterId = '[CLOUD_VM_CLUSTER_ID]';
    $formattedCloudVmClusterExadataInfrastructure = OracleDatabaseClient::cloudExadataInfrastructureName(
        '[PROJECT]',
        '[LOCATION]',
        '[CLOUD_EXADATA_INFRASTRUCTURE]'
    );

    create_cloud_vm_cluster_sample(
        $formattedParent,
        $cloudVmClusterId,
        $formattedCloudVmClusterExadataInfrastructure
    );
}

createDbSystem

Creates a new DbSystem in a given project and location.

The async variant is OracleDatabaseClient::createDbSystemAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateDbSystemRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\DbSystem>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CreateDbSystemRequest;
use Google\Cloud\OracleDatabase\V1\DbSystem;
use Google\Rpc\Status;

/**
 * @param string $formattedParent            The value for parent of the DbSystem in the following format:
 *                                           projects/{project}/locations/{location}. Please see
 *                                           {@see OracleDatabaseClient::locationName()} for help formatting this field.
 * @param string $dbSystemId                 The ID of the DbSystem to create. This value is
 *                                           restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of
 *                                           63 characters in length. The value must start with a letter and end with a
 *                                           letter or a number.
 * @param string $formattedDbSystemOdbSubnet The name of the OdbSubnet associated with the DbSystem for IP
 *                                           allocation. Format:
 *                                           projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
 *                                           Please see {@see OracleDatabaseClient::odbSubnetName()} for help formatting this field.
 * @param string $dbSystemDisplayName        The display name for the System db. The name does not have to
 *                                           be unique within your project.
 */
function create_db_system_sample(
    string $formattedParent,
    string $dbSystemId,
    string $formattedDbSystemOdbSubnet,
    string $dbSystemDisplayName
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $dbSystem = (new DbSystem())
        ->setOdbSubnet($formattedDbSystemOdbSubnet)
        ->setDisplayName($dbSystemDisplayName);
    $request = (new CreateDbSystemRequest())
        ->setParent($formattedParent)
        ->setDbSystemId($dbSystemId)
        ->setDbSystem($dbSystem);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->createDbSystem($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var DbSystem $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');
    $dbSystemId = '[DB_SYSTEM_ID]';
    $formattedDbSystemOdbSubnet = OracleDatabaseClient::odbSubnetName(
        '[PROJECT]',
        '[LOCATION]',
        '[ODB_NETWORK]',
        '[ODB_SUBNET]'
    );
    $dbSystemDisplayName = '[DISPLAY_NAME]';

    create_db_system_sample(
        $formattedParent,
        $dbSystemId,
        $formattedDbSystemOdbSubnet,
        $dbSystemDisplayName
    );
}

createExadbVmCluster

Creates a new Exadb (Exascale) VM Cluster resource.

The async variant is OracleDatabaseClient::createExadbVmClusterAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateExadbVmClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\ExadbVmCluster>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CreateExadbVmClusterRequest;
use Google\Cloud\OracleDatabase\V1\ExadbVmCluster;
use Google\Cloud\OracleDatabase\V1\ExadbVmClusterProperties;
use Google\Cloud\OracleDatabase\V1\ExadbVmClusterProperties\ShapeAttribute;
use Google\Cloud\OracleDatabase\V1\ExadbVmClusterStorageDetails;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                                             The value for parent of the ExadbVmCluster in the following
 *                                                                            format: projects/{project}/locations/{location}. Please see
 *                                                                            {@see OracleDatabaseClient::locationName()} for help formatting this field.
 * @param string $exadbVmClusterId                                            The ID of the ExadbVmCluster to create. This value is
 *                                                                            restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of
 *                                                                            63 characters in length. The value must start with a letter and end with a
 *                                                                            letter or a number.
 * @param string $exadbVmClusterPropertiesGridImageId                         Immutable. Grid Infrastructure Version.
 * @param int    $exadbVmClusterPropertiesNodeCount                           The number of nodes/VMs in the ExadbVmCluster.
 * @param int    $exadbVmClusterPropertiesEnabledEcpuCountPerNode             Immutable. The number of ECPUs enabled per node for an exadata vm
 *                                                                            cluster on exascale infrastructure.
 * @param int    $exadbVmClusterPropertiesVmFileSystemStorageSizeInGbsPerNode The storage allocation for the exadbvmcluster per node, in
 *                                                                            gigabytes (GB). This field is used to calculate the total storage
 *                                                                            allocation for the exadbvmcluster.
 * @param string $formattedExadbVmClusterPropertiesExascaleDbStorageVault     Immutable. The name of ExascaleDbStorageVault associated with the
 *                                                                            ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a
 *                                                                            new one can be created during the ExadbVmCluster creation (requires
 *                                                                            storage_vault_properties to be set).
 *                                                                            Format:
 *                                                                            projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
 *                                                                            Please see {@see OracleDatabaseClient::exascaleDbStorageVaultName()} for help formatting this field.
 * @param string $exadbVmClusterPropertiesHostnamePrefix                      Immutable. Prefix for VM cluster host names.
 * @param string $exadbVmClusterPropertiesSshPublicKeysElement                Immutable. The SSH public keys for the ExadbVmCluster.
 * @param int    $exadbVmClusterPropertiesShapeAttribute                      Immutable. The shape attribute of the VM cluster. The type of
 *                                                                            Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE
 *                                                                            which supports Oracle Database 23ai and later
 * @param string $formattedExadbVmClusterOdbSubnet                            Immutable. The name of the OdbSubnet associated with the
 *                                                                            ExadbVmCluster for IP allocation. Format:
 *                                                                            projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
 *                                                                            Please see {@see OracleDatabaseClient::odbSubnetName()} for help formatting this field.
 * @param string $formattedExadbVmClusterBackupOdbSubnet                      Immutable. The name of the backup OdbSubnet associated with the
 *                                                                            ExadbVmCluster. Format:
 *                                                                            projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
 *                                                                            Please see {@see OracleDatabaseClient::odbSubnetName()} for help formatting this field.
 * @param string $exadbVmClusterDisplayName                                   Immutable. The display name for the ExadbVmCluster. The name does
 *                                                                            not have to be unique within your project. The name must be 1-255
 *                                                                            characters long and can only contain alphanumeric characters.
 */
function create_exadb_vm_cluster_sample(
    string $formattedParent,
    string $exadbVmClusterId,
    string $exadbVmClusterPropertiesGridImageId,
    int $exadbVmClusterPropertiesNodeCount,
    int $exadbVmClusterPropertiesEnabledEcpuCountPerNode,
    int $exadbVmClusterPropertiesVmFileSystemStorageSizeInGbsPerNode,
    string $formattedExadbVmClusterPropertiesExascaleDbStorageVault,
    string $exadbVmClusterPropertiesHostnamePrefix,
    string $exadbVmClusterPropertiesSshPublicKeysElement,
    int $exadbVmClusterPropertiesShapeAttribute,
    string $formattedExadbVmClusterOdbSubnet,
    string $formattedExadbVmClusterBackupOdbSubnet,
    string $exadbVmClusterDisplayName
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $exadbVmClusterPropertiesVmFileSystemStorage = (new ExadbVmClusterStorageDetails())
        ->setSizeInGbsPerNode($exadbVmClusterPropertiesVmFileSystemStorageSizeInGbsPerNode);
    $exadbVmClusterPropertiesSshPublicKeys = [$exadbVmClusterPropertiesSshPublicKeysElement,];
    $exadbVmClusterProperties = (new ExadbVmClusterProperties())
        ->setGridImageId($exadbVmClusterPropertiesGridImageId)
        ->setNodeCount($exadbVmClusterPropertiesNodeCount)
        ->setEnabledEcpuCountPerNode($exadbVmClusterPropertiesEnabledEcpuCountPerNode)
        ->setVmFileSystemStorage($exadbVmClusterPropertiesVmFileSystemStorage)
        ->setExascaleDbStorageVault($formattedExadbVmClusterPropertiesExascaleDbStorageVault)
        ->setHostnamePrefix($exadbVmClusterPropertiesHostnamePrefix)
        ->setSshPublicKeys($exadbVmClusterPropertiesSshPublicKeys)
        ->setShapeAttribute($exadbVmClusterPropertiesShapeAttribute);
    $exadbVmCluster = (new ExadbVmCluster())
        ->setProperties($exadbVmClusterProperties)
        ->setOdbSubnet($formattedExadbVmClusterOdbSubnet)
        ->setBackupOdbSubnet($formattedExadbVmClusterBackupOdbSubnet)
        ->setDisplayName($exadbVmClusterDisplayName);
    $request = (new CreateExadbVmClusterRequest())
        ->setParent($formattedParent)
        ->setExadbVmClusterId($exadbVmClusterId)
        ->setExadbVmCluster($exadbVmCluster);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->createExadbVmCluster($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ExadbVmCluster $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');
    $exadbVmClusterId = '[EXADB_VM_CLUSTER_ID]';
    $exadbVmClusterPropertiesGridImageId = '[GRID_IMAGE_ID]';
    $exadbVmClusterPropertiesNodeCount = 0;
    $exadbVmClusterPropertiesEnabledEcpuCountPerNode = 0;
    $exadbVmClusterPropertiesVmFileSystemStorageSizeInGbsPerNode = 0;
    $formattedExadbVmClusterPropertiesExascaleDbStorageVault = OracleDatabaseClient::exascaleDbStorageVaultName(
        '[PROJECT]',
        '[LOCATION]',
        '[EXASCALE_DB_STORAGE_VAULT]'
    );
    $exadbVmClusterPropertiesHostnamePrefix = '[HOSTNAME_PREFIX]';
    $exadbVmClusterPropertiesSshPublicKeysElement = '[SSH_PUBLIC_KEYS]';
    $exadbVmClusterPropertiesShapeAttribute = ShapeAttribute::SHAPE_ATTRIBUTE_UNSPECIFIED;
    $formattedExadbVmClusterOdbSubnet = OracleDatabaseClient::odbSubnetName(
        '[PROJECT]',
        '[LOCATION]',
        '[ODB_NETWORK]',
        '[ODB_SUBNET]'
    );
    $formattedExadbVmClusterBackupOdbSubnet = OracleDatabaseClient::odbSubnetName(
        '[PROJECT]',
        '[LOCATION]',
        '[ODB_NETWORK]',
        '[ODB_SUBNET]'
    );
    $exadbVmClusterDisplayName = '[DISPLAY_NAME]';

    create_exadb_vm_cluster_sample(
        $formattedParent,
        $exadbVmClusterId,
        $exadbVmClusterPropertiesGridImageId,
        $exadbVmClusterPropertiesNodeCount,
        $exadbVmClusterPropertiesEnabledEcpuCountPerNode,
        $exadbVmClusterPropertiesVmFileSystemStorageSizeInGbsPerNode,
        $formattedExadbVmClusterPropertiesExascaleDbStorageVault,
        $exadbVmClusterPropertiesHostnamePrefix,
        $exadbVmClusterPropertiesSshPublicKeysElement,
        $exadbVmClusterPropertiesShapeAttribute,
        $formattedExadbVmClusterOdbSubnet,
        $formattedExadbVmClusterBackupOdbSubnet,
        $exadbVmClusterDisplayName
    );
}

createExascaleDbStorageVault

Creates a new ExascaleDB Storage Vault resource.

The async variant is OracleDatabaseClient::createExascaleDbStorageVaultAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateExascaleDbStorageVaultRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\ExascaleDbStorageVault>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CreateExascaleDbStorageVaultRequest;
use Google\Cloud\OracleDatabase\V1\ExascaleDbStorageDetails;
use Google\Cloud\OracleDatabase\V1\ExascaleDbStorageVault;
use Google\Cloud\OracleDatabase\V1\ExascaleDbStorageVaultProperties;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                                                      The value for parent of the ExascaleDbStorageVault in the
 *                                                                                     following format: projects/{project}/locations/{location}. Please see
 *                                                                                     {@see OracleDatabaseClient::locationName()} for help formatting this field.
 * @param string $exascaleDbStorageVaultId                                             The ID of the ExascaleDbStorageVault to create. This value is
 *                                                                                     restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of
 *                                                                                     63 characters in length. The value must start with a letter and end with a
 *                                                                                     letter or a number.
 * @param string $exascaleDbStorageVaultDisplayName                                    The display name for the ExascaleDbStorageVault. The name does
 *                                                                                     not have to be unique within your project. The name must be 1-255
 *                                                                                     characters long and can only contain alphanumeric characters.
 * @param int    $exascaleDbStorageVaultPropertiesExascaleDbStorageDetailsTotalSizeGbs The total storage allocation for the ExascaleDbStorageVault, in
 *                                                                                     gigabytes (GB).
 */
function create_exascale_db_storage_vault_sample(
    string $formattedParent,
    string $exascaleDbStorageVaultId,
    string $exascaleDbStorageVaultDisplayName,
    int $exascaleDbStorageVaultPropertiesExascaleDbStorageDetailsTotalSizeGbs
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $exascaleDbStorageVaultPropertiesExascaleDbStorageDetails = (new ExascaleDbStorageDetails())
        ->setTotalSizeGbs($exascaleDbStorageVaultPropertiesExascaleDbStorageDetailsTotalSizeGbs);
    $exascaleDbStorageVaultProperties = (new ExascaleDbStorageVaultProperties())
        ->setExascaleDbStorageDetails($exascaleDbStorageVaultPropertiesExascaleDbStorageDetails);
    $exascaleDbStorageVault = (new ExascaleDbStorageVault())
        ->setDisplayName($exascaleDbStorageVaultDisplayName)
        ->setProperties($exascaleDbStorageVaultProperties);
    $request = (new CreateExascaleDbStorageVaultRequest())
        ->setParent($formattedParent)
        ->setExascaleDbStorageVaultId($exascaleDbStorageVaultId)
        ->setExascaleDbStorageVault($exascaleDbStorageVault);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->createExascaleDbStorageVault($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ExascaleDbStorageVault $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');
    $exascaleDbStorageVaultId = '[EXASCALE_DB_STORAGE_VAULT_ID]';
    $exascaleDbStorageVaultDisplayName = '[DISPLAY_NAME]';
    $exascaleDbStorageVaultPropertiesExascaleDbStorageDetailsTotalSizeGbs = 0;

    create_exascale_db_storage_vault_sample(
        $formattedParent,
        $exascaleDbStorageVaultId,
        $exascaleDbStorageVaultDisplayName,
        $exascaleDbStorageVaultPropertiesExascaleDbStorageDetailsTotalSizeGbs
    );
}

createOdbNetwork

Creates a new ODB Network in a given project and location.

The async variant is OracleDatabaseClient::createOdbNetworkAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateOdbNetworkRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\OdbNetwork>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CreateOdbNetworkRequest;
use Google\Cloud\OracleDatabase\V1\OdbNetwork;
use Google\Rpc\Status;

/**
 * @param string $formattedParent            The parent value for the OdbNetwork in the following format:
 *                                           projects/{project}/locations/{location}. Please see
 *                                           {@see OracleDatabaseClient::locationName()} for help formatting this field.
 * @param string $odbNetworkId               The ID of the OdbNetwork to create. This value is restricted
 *                                           to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63
 *                                           characters in length. The value must start with a letter and end with
 *                                           a letter or a number.
 * @param string $formattedOdbNetworkNetwork The name of the VPC network in the following format:
 *                                           projects/{project}/global/networks/{network}
 *                                           Please see {@see OracleDatabaseClient::networkName()} for help formatting this field.
 */
function create_odb_network_sample(
    string $formattedParent,
    string $odbNetworkId,
    string $formattedOdbNetworkNetwork
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $odbNetwork = (new OdbNetwork())
        ->setNetwork($formattedOdbNetworkNetwork);
    $request = (new CreateOdbNetworkRequest())
        ->setParent($formattedParent)
        ->setOdbNetworkId($odbNetworkId)
        ->setOdbNetwork($odbNetwork);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->createOdbNetwork($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var OdbNetwork $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');
    $odbNetworkId = '[ODB_NETWORK_ID]';
    $formattedOdbNetworkNetwork = OracleDatabaseClient::networkName('[PROJECT]', '[NETWORK]');

    create_odb_network_sample($formattedParent, $odbNetworkId, $formattedOdbNetworkNetwork);
}

createOdbSubnet

Creates a new ODB Subnet in a given ODB Network.

The async variant is OracleDatabaseClient::createOdbSubnetAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateOdbSubnetRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\OdbSubnet>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CreateOdbSubnetRequest;
use Google\Cloud\OracleDatabase\V1\OdbSubnet;
use Google\Cloud\OracleDatabase\V1\OdbSubnet\Purpose;
use Google\Rpc\Status;

/**
 * @param string $formattedParent    The parent value for the OdbSubnet in the following format:
 *                                   projects/{project}/locations/{location}/odbNetworks/{odb_network}. Please see
 *                                   {@see OracleDatabaseClient::odbNetworkName()} for help formatting this field.
 * @param string $odbSubnetId        The ID of the OdbSubnet to create. This value is restricted
 *                                   to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63
 *                                   characters in length. The value must start with a letter and end with
 *                                   a letter or a number.
 * @param string $odbSubnetCidrRange The CIDR range of the subnet.
 * @param int    $odbSubnetPurpose   Purpose of the subnet.
 */
function create_odb_subnet_sample(
    string $formattedParent,
    string $odbSubnetId,
    string $odbSubnetCidrRange,
    int $odbSubnetPurpose
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $odbSubnet = (new OdbSubnet())
        ->setCidrRange($odbSubnetCidrRange)
        ->setPurpose($odbSubnetPurpose);
    $request = (new CreateOdbSubnetRequest())
        ->setParent($formattedParent)
        ->setOdbSubnetId($odbSubnetId)
        ->setOdbSubnet($odbSubnet);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->createOdbSubnet($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var OdbSubnet $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::odbNetworkName('[PROJECT]', '[LOCATION]', '[ODB_NETWORK]');
    $odbSubnetId = '[ODB_SUBNET_ID]';
    $odbSubnetCidrRange = '[CIDR_RANGE]';
    $odbSubnetPurpose = Purpose::PURPOSE_UNSPECIFIED;

    create_odb_subnet_sample($formattedParent, $odbSubnetId, $odbSubnetCidrRange, $odbSubnetPurpose);
}

deleteAutonomousDatabase

Deletes a single Autonomous Database.

The async variant is OracleDatabaseClient::deleteAutonomousDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteAutonomousDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DeleteAutonomousDatabaseRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the resource in the following format:
 *                              projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. Please see
 *                              {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 */
function delete_autonomous_database_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new DeleteAutonomousDatabaseRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->deleteAutonomousDatabase($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );

    delete_autonomous_database_sample($formattedName);
}

deleteCloudExadataInfrastructure

Deletes a single Exadata Infrastructure.

The async variant is OracleDatabaseClient::deleteCloudExadataInfrastructureAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteCloudExadataInfrastructureRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DeleteCloudExadataInfrastructureRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Cloud Exadata Infrastructure in the following
 *                              format:
 *                              projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}. Please see
 *                              {@see OracleDatabaseClient::cloudExadataInfrastructureName()} for help formatting this field.
 */
function delete_cloud_exadata_infrastructure_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new DeleteCloudExadataInfrastructureRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->deleteCloudExadataInfrastructure($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::cloudExadataInfrastructureName(
        '[PROJECT]',
        '[LOCATION]',
        '[CLOUD_EXADATA_INFRASTRUCTURE]'
    );

    delete_cloud_exadata_infrastructure_sample($formattedName);
}

deleteCloudVmCluster

Deletes a single VM Cluster.

The async variant is OracleDatabaseClient::deleteCloudVmClusterAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteCloudVmClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DeleteCloudVmClusterRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Cloud VM Cluster in the following format:
 *                              projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}. Please see
 *                              {@see OracleDatabaseClient::cloudVmClusterName()} for help formatting this field.
 */
function delete_cloud_vm_cluster_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new DeleteCloudVmClusterRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->deleteCloudVmCluster($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::cloudVmClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[CLOUD_VM_CLUSTER]'
    );

    delete_cloud_vm_cluster_sample($formattedName);
}

deleteDbSystem

Deletes a single DbSystem.

The async variant is OracleDatabaseClient::deleteDbSystemAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteDbSystemRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DeleteDbSystemRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the DbSystem in the following format:
 *                              projects/{project}/locations/{location}/dbSystems/{db_system}. Please see
 *                              {@see OracleDatabaseClient::dbSystemName()} for help formatting this field.
 */
function delete_db_system_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new DeleteDbSystemRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->deleteDbSystem($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::dbSystemName('[PROJECT]', '[LOCATION]', '[DB_SYSTEM]');

    delete_db_system_sample($formattedName);
}

deleteExadbVmCluster

Deletes a single Exadb (Exascale) VM Cluster.

The async variant is OracleDatabaseClient::deleteExadbVmClusterAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteExadbVmClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DeleteExadbVmClusterRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the ExadbVmCluster in the following format:
 *                              projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. Please see
 *                              {@see OracleDatabaseClient::exadbVmClusterName()} for help formatting this field.
 */
function delete_exadb_vm_cluster_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new DeleteExadbVmClusterRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->deleteExadbVmCluster($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::exadbVmClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[EXADB_VM_CLUSTER]'
    );

    delete_exadb_vm_cluster_sample($formattedName);
}

deleteExascaleDbStorageVault

Deletes a single ExascaleDB Storage Vault.

The async variant is OracleDatabaseClient::deleteExascaleDbStorageVaultAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteExascaleDbStorageVaultRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DeleteExascaleDbStorageVaultRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the ExascaleDbStorageVault in the following format:
 *                              projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}. Please see
 *                              {@see OracleDatabaseClient::exascaleDbStorageVaultName()} for help formatting this field.
 */
function delete_exascale_db_storage_vault_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new DeleteExascaleDbStorageVaultRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->deleteExascaleDbStorageVault($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::exascaleDbStorageVaultName(
        '[PROJECT]',
        '[LOCATION]',
        '[EXASCALE_DB_STORAGE_VAULT]'
    );

    delete_exascale_db_storage_vault_sample($formattedName);
}

deleteOdbNetwork

Deletes a single ODB Network.

The async variant is OracleDatabaseClient::deleteOdbNetworkAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteOdbNetworkRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DeleteOdbNetworkRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the resource in the following format:
 *                              projects/{project}/locations/{location}/odbNetworks/{odb_network}. Please see
 *                              {@see OracleDatabaseClient::odbNetworkName()} for help formatting this field.
 */
function delete_odb_network_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new DeleteOdbNetworkRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->deleteOdbNetwork($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::odbNetworkName('[PROJECT]', '[LOCATION]', '[ODB_NETWORK]');

    delete_odb_network_sample($formattedName);
}

deleteOdbSubnet

Deletes a single ODB Subnet.

The async variant is OracleDatabaseClient::deleteOdbSubnetAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteOdbSubnetRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<null>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DeleteOdbSubnetRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the resource in the following format:
 *                              projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}. Please see
 *                              {@see OracleDatabaseClient::odbSubnetName()} for help formatting this field.
 */
function delete_odb_subnet_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new DeleteOdbSubnetRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->deleteOdbSubnet($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::odbSubnetName(
        '[PROJECT]',
        '[LOCATION]',
        '[ODB_NETWORK]',
        '[ODB_SUBNET]'
    );

    delete_odb_subnet_sample($formattedName);
}

failoverAutonomousDatabase

Initiates a failover to target autonomous database from the associated primary database.

The async variant is OracleDatabaseClient::failoverAutonomousDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\FailoverAutonomousDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\AutonomousDatabase>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabase;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\FailoverAutonomousDatabaseRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName                   The name of the Autonomous Database in the following format:
 *                                                projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. Please see
 *                                                {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 * @param string $formattedPeerAutonomousDatabase The peer database name to fail over to. Please see
 *                                                {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 */
function failover_autonomous_database_sample(
    string $formattedName,
    string $formattedPeerAutonomousDatabase
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new FailoverAutonomousDatabaseRequest())
        ->setName($formattedName)
        ->setPeerAutonomousDatabase($formattedPeerAutonomousDatabase);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->failoverAutonomousDatabase($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AutonomousDatabase $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );
    $formattedPeerAutonomousDatabase = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );

    failover_autonomous_database_sample($formattedName, $formattedPeerAutonomousDatabase);
}

generateAutonomousDatabaseWallet

Generates a wallet for an Autonomous Database.

The async variant is OracleDatabaseClient::generateAutonomousDatabaseWalletAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GenerateAutonomousDatabaseWalletRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\GenerateAutonomousDatabaseWalletResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\GenerateAutonomousDatabaseWalletRequest;
use Google\Cloud\OracleDatabase\V1\GenerateAutonomousDatabaseWalletResponse;

/**
 * @param string $formattedName The name of the Autonomous Database in the following format:
 *                              projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. Please see
 *                              {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 * @param string $password      The password used to encrypt the keys inside the wallet. The
 *                              password must be a minimum of 8 characters.
 */
function generate_autonomous_database_wallet_sample(string $formattedName, string $password): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GenerateAutonomousDatabaseWalletRequest())
        ->setName($formattedName)
        ->setPassword($password);

    // Call the API and handle any network failures.
    try {
        /** @var GenerateAutonomousDatabaseWalletResponse $response */
        $response = $oracleDatabaseClient->generateAutonomousDatabaseWallet($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );
    $password = '[PASSWORD]';

    generate_autonomous_database_wallet_sample($formattedName, $password);
}

getAutonomousDatabase

Gets the details of a single Autonomous Database.

The async variant is OracleDatabaseClient::getAutonomousDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetAutonomousDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\AutonomousDatabase
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabase;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\GetAutonomousDatabaseRequest;

/**
 * @param string $formattedName The name of the Autonomous Database in the following format:
 *                              projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. Please see
 *                              {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 */
function get_autonomous_database_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GetAutonomousDatabaseRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var AutonomousDatabase $response */
        $response = $oracleDatabaseClient->getAutonomousDatabase($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );

    get_autonomous_database_sample($formattedName);
}

getCloudExadataInfrastructure

Gets details of a single Exadata Infrastructure.

The async variant is OracleDatabaseClient::getCloudExadataInfrastructureAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetCloudExadataInfrastructureRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\CloudExadataInfrastructure
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CloudExadataInfrastructure;
use Google\Cloud\OracleDatabase\V1\GetCloudExadataInfrastructureRequest;

/**
 * @param string $formattedName The name of the Cloud Exadata Infrastructure in the following
 *                              format:
 *                              projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}. Please see
 *                              {@see OracleDatabaseClient::cloudExadataInfrastructureName()} for help formatting this field.
 */
function get_cloud_exadata_infrastructure_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GetCloudExadataInfrastructureRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var CloudExadataInfrastructure $response */
        $response = $oracleDatabaseClient->getCloudExadataInfrastructure($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::cloudExadataInfrastructureName(
        '[PROJECT]',
        '[LOCATION]',
        '[CLOUD_EXADATA_INFRASTRUCTURE]'
    );

    get_cloud_exadata_infrastructure_sample($formattedName);
}

getCloudVmCluster

Gets details of a single VM Cluster.

The async variant is OracleDatabaseClient::getCloudVmClusterAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetCloudVmClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\CloudVmCluster
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CloudVmCluster;
use Google\Cloud\OracleDatabase\V1\GetCloudVmClusterRequest;

/**
 * @param string $formattedName The name of the Cloud VM Cluster in the following format:
 *                              projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}. Please see
 *                              {@see OracleDatabaseClient::cloudVmClusterName()} for help formatting this field.
 */
function get_cloud_vm_cluster_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GetCloudVmClusterRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var CloudVmCluster $response */
        $response = $oracleDatabaseClient->getCloudVmCluster($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::cloudVmClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[CLOUD_VM_CLUSTER]'
    );

    get_cloud_vm_cluster_sample($formattedName);
}

getDatabase

Gets details of a single Database.

The async variant is OracleDatabaseClient::getDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\Database
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\Database;
use Google\Cloud\OracleDatabase\V1\GetDatabaseRequest;

/**
 * @param string $formattedName The name of the Database resource in the following format:
 *                              projects/{project}/locations/{region}/databases/{database}
 *                              Please see {@see OracleDatabaseClient::databaseName()} for help formatting this field.
 */
function get_database_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GetDatabaseRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Database $response */
        $response = $oracleDatabaseClient->getDatabase($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::databaseName('[PROJECT]', '[LOCATION]', '[DATABASE]');

    get_database_sample($formattedName);
}

getDbSystem

Gets details of a single DbSystem.

The async variant is OracleDatabaseClient::getDbSystemAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetDbSystemRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\DbSystem
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DbSystem;
use Google\Cloud\OracleDatabase\V1\GetDbSystemRequest;

/**
 * @param string $formattedName The name of the DbSystem in the following format:
 *                              projects/{project}/locations/{location}/dbSystems/{db_system}. Please see
 *                              {@see OracleDatabaseClient::dbSystemName()} for help formatting this field.
 */
function get_db_system_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GetDbSystemRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var DbSystem $response */
        $response = $oracleDatabaseClient->getDbSystem($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::dbSystemName('[PROJECT]', '[LOCATION]', '[DB_SYSTEM]');

    get_db_system_sample($formattedName);
}

getExadbVmCluster

Gets details of a single Exadb (Exascale) VM Cluster.

The async variant is OracleDatabaseClient::getExadbVmClusterAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetExadbVmClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\ExadbVmCluster
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ExadbVmCluster;
use Google\Cloud\OracleDatabase\V1\GetExadbVmClusterRequest;

/**
 * @param string $formattedName The name of the ExadbVmCluster in the following format:
 *                              projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. Please see
 *                              {@see OracleDatabaseClient::exadbVmClusterName()} for help formatting this field.
 */
function get_exadb_vm_cluster_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GetExadbVmClusterRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var ExadbVmCluster $response */
        $response = $oracleDatabaseClient->getExadbVmCluster($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::exadbVmClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[EXADB_VM_CLUSTER]'
    );

    get_exadb_vm_cluster_sample($formattedName);
}

getExascaleDbStorageVault

Gets details of a single ExascaleDB Storage Vault.

The async variant is OracleDatabaseClient::getExascaleDbStorageVaultAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetExascaleDbStorageVaultRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\ExascaleDbStorageVault
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ExascaleDbStorageVault;
use Google\Cloud\OracleDatabase\V1\GetExascaleDbStorageVaultRequest;

/**
 * @param string $formattedName The name of the ExascaleDbStorageVault in the following format:
 *                              projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}. Please see
 *                              {@see OracleDatabaseClient::exascaleDbStorageVaultName()} for help formatting this field.
 */
function get_exascale_db_storage_vault_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GetExascaleDbStorageVaultRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var ExascaleDbStorageVault $response */
        $response = $oracleDatabaseClient->getExascaleDbStorageVault($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::exascaleDbStorageVaultName(
        '[PROJECT]',
        '[LOCATION]',
        '[EXASCALE_DB_STORAGE_VAULT]'
    );

    get_exascale_db_storage_vault_sample($formattedName);
}

getOdbNetwork

Gets details of a single ODB Network.

The async variant is OracleDatabaseClient::getOdbNetworkAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetOdbNetworkRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\OdbNetwork
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\GetOdbNetworkRequest;
use Google\Cloud\OracleDatabase\V1\OdbNetwork;

/**
 * @param string $formattedName The name of the OdbNetwork in the following format:
 *                              projects/{project}/locations/{location}/odbNetworks/{odb_network}. Please see
 *                              {@see OracleDatabaseClient::odbNetworkName()} for help formatting this field.
 */
function get_odb_network_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GetOdbNetworkRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OdbNetwork $response */
        $response = $oracleDatabaseClient->getOdbNetwork($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::odbNetworkName('[PROJECT]', '[LOCATION]', '[ODB_NETWORK]');

    get_odb_network_sample($formattedName);
}

getOdbSubnet

Gets details of a single ODB Subnet.

The async variant is OracleDatabaseClient::getOdbSubnetAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetOdbSubnetRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\OdbSubnet
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\GetOdbSubnetRequest;
use Google\Cloud\OracleDatabase\V1\OdbSubnet;

/**
 * @param string $formattedName The name of the OdbSubnet in the following format:
 *                              projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}. Please see
 *                              {@see OracleDatabaseClient::odbSubnetName()} for help formatting this field.
 */
function get_odb_subnet_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GetOdbSubnetRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OdbSubnet $response */
        $response = $oracleDatabaseClient->getOdbSubnet($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::odbSubnetName(
        '[PROJECT]',
        '[LOCATION]',
        '[ODB_NETWORK]',
        '[ODB_SUBNET]'
    );

    get_odb_subnet_sample($formattedName);
}

getPluggableDatabase

Gets details of a single PluggableDatabase.

The async variant is OracleDatabaseClient::getPluggableDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetPluggableDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\OracleDatabase\V1\PluggableDatabase
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\GetPluggableDatabaseRequest;
use Google\Cloud\OracleDatabase\V1\PluggableDatabase;

/**
 * @param string $formattedName The name of the PluggableDatabase resource in the following
 *                              format:
 *                              projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}
 *                              Please see {@see OracleDatabaseClient::pluggableDatabaseName()} for help formatting this field.
 */
function get_pluggable_database_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new GetPluggableDatabaseRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var PluggableDatabase $response */
        $response = $oracleDatabaseClient->getPluggableDatabase($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::pluggableDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[PLUGGABLE_DATABASE]'
    );

    get_pluggable_database_sample($formattedName);
}

listAutonomousDatabaseBackups

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

The async variant is OracleDatabaseClient::listAutonomousDatabaseBackupsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListAutonomousDatabaseBackupsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabaseBackup;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ListAutonomousDatabaseBackupsRequest;

/**
 * @param string $formattedParent The parent value for ListAutonomousDatabaseBackups in the
 *                                following format: projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_autonomous_database_backups_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListAutonomousDatabaseBackupsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listAutonomousDatabaseBackups($request);

        /** @var AutonomousDatabaseBackup $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_autonomous_database_backups_sample($formattedParent);
}

listAutonomousDatabaseCharacterSets

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

The async variant is OracleDatabaseClient::listAutonomousDatabaseCharacterSetsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListAutonomousDatabaseCharacterSetsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabaseCharacterSet;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ListAutonomousDatabaseCharacterSetsRequest;

/**
 * @param string $formattedParent The parent value for the Autonomous Database in the following
 *                                format: projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_autonomous_database_character_sets_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListAutonomousDatabaseCharacterSetsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listAutonomousDatabaseCharacterSets($request);

        /** @var AutonomousDatabaseCharacterSet $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_autonomous_database_character_sets_sample($formattedParent);
}

listAutonomousDatabases

Lists the Autonomous Databases in a given project and location.

The async variant is OracleDatabaseClient::listAutonomousDatabasesAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListAutonomousDatabasesRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabase;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ListAutonomousDatabasesRequest;

/**
 * @param string $formattedParent The parent value for the Autonomous Database in the following
 *                                format: projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_autonomous_databases_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListAutonomousDatabasesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listAutonomousDatabases($request);

        /** @var AutonomousDatabase $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_autonomous_databases_sample($formattedParent);
}

listAutonomousDbVersions

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

The async variant is OracleDatabaseClient::listAutonomousDbVersionsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListAutonomousDbVersionsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDbVersion;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ListAutonomousDbVersionsRequest;

/**
 * @param string $formattedParent The parent value for the Autonomous Database in the following
 *                                format: projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_autonomous_db_versions_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListAutonomousDbVersionsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listAutonomousDbVersions($request);

        /** @var AutonomousDbVersion $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_autonomous_db_versions_sample($formattedParent);
}

listCloudExadataInfrastructures

Lists Exadata Infrastructures in a given project and location.

The async variant is OracleDatabaseClient::listCloudExadataInfrastructuresAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListCloudExadataInfrastructuresRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CloudExadataInfrastructure;
use Google\Cloud\OracleDatabase\V1\ListCloudExadataInfrastructuresRequest;

/**
 * @param string $formattedParent The parent value for CloudExadataInfrastructure in the following
 *                                format: projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_cloud_exadata_infrastructures_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListCloudExadataInfrastructuresRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listCloudExadataInfrastructures($request);

        /** @var CloudExadataInfrastructure $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_cloud_exadata_infrastructures_sample($formattedParent);
}

listCloudVmClusters

Lists the VM Clusters in a given project and location.

The async variant is OracleDatabaseClient::listCloudVmClustersAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListCloudVmClustersRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\CloudVmCluster;
use Google\Cloud\OracleDatabase\V1\ListCloudVmClustersRequest;

/**
 * @param string $formattedParent The name of the parent in the following format:
 *                                projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_cloud_vm_clusters_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListCloudVmClustersRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listCloudVmClusters($request);

        /** @var CloudVmCluster $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_cloud_vm_clusters_sample($formattedParent);
}

listDatabaseCharacterSets

List DatabaseCharacterSets for the given project and location.

The async variant is OracleDatabaseClient::listDatabaseCharacterSetsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDatabaseCharacterSetsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DatabaseCharacterSet;
use Google\Cloud\OracleDatabase\V1\ListDatabaseCharacterSetsRequest;

/**
 * @param string $formattedParent The parent value for DatabaseCharacterSets in the following
 *                                format: projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_database_character_sets_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListDatabaseCharacterSetsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listDatabaseCharacterSets($request);

        /** @var DatabaseCharacterSet $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_database_character_sets_sample($formattedParent);
}

listDatabases

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

The async variant is OracleDatabaseClient::listDatabasesAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDatabasesRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\Database;
use Google\Cloud\OracleDatabase\V1\ListDatabasesRequest;

/**
 * @param string $formattedParent The parent resource name in the following format:
 *                                projects/{project}/locations/{region}
 *                                Please see {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_databases_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListDatabasesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listDatabases($request);

        /** @var Database $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_databases_sample($formattedParent);
}

listDbNodes

Lists the database nodes of a VM Cluster.

The async variant is OracleDatabaseClient::listDbNodesAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbNodesRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DbNode;
use Google\Cloud\OracleDatabase\V1\ListDbNodesRequest;

/**
 * @param string $formattedParent The parent value for database node in the following format:
 *                                projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}.
 *                                . Please see
 *                                {@see OracleDatabaseClient::exadbVmClusterName()} for help formatting this field.
 */
function list_db_nodes_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListDbNodesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listDbNodes($request);

        /** @var DbNode $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::exadbVmClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[EXADB_VM_CLUSTER]'
    );

    list_db_nodes_sample($formattedParent);
}

listDbServers

Lists the database servers of an Exadata Infrastructure instance.

The async variant is OracleDatabaseClient::listDbServersAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbServersRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DbServer;
use Google\Cloud\OracleDatabase\V1\ListDbServersRequest;

/**
 * @param string $formattedParent The parent value for database server in the following format:
 *                                projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloudExadataInfrastructure}. Please see
 *                                {@see OracleDatabaseClient::cloudExadataInfrastructureName()} for help formatting this field.
 */
function list_db_servers_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListDbServersRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listDbServers($request);

        /** @var DbServer $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::cloudExadataInfrastructureName(
        '[PROJECT]',
        '[LOCATION]',
        '[CLOUD_EXADATA_INFRASTRUCTURE]'
    );

    list_db_servers_sample($formattedParent);
}

listDbSystemInitialStorageSizes

Lists all the DbSystemInitialStorageSizes for the given project and location.

The async variant is OracleDatabaseClient::listDbSystemInitialStorageSizesAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbSystemInitialStorageSizesRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DbSystemInitialStorageSize;
use Google\Cloud\OracleDatabase\V1\ListDbSystemInitialStorageSizesRequest;

/**
 * @param string $formattedParent The parent value for the DbSystemInitialStorageSize resource with
 *                                the format: projects/{project}/locations/{location}
 *                                Please see {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_db_system_initial_storage_sizes_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListDbSystemInitialStorageSizesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listDbSystemInitialStorageSizes($request);

        /** @var DbSystemInitialStorageSize $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_db_system_initial_storage_sizes_sample($formattedParent);
}

listDbSystemShapes

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

The async variant is OracleDatabaseClient::listDbSystemShapesAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbSystemShapesRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DbSystemShape;
use Google\Cloud\OracleDatabase\V1\ListDbSystemShapesRequest;

/**
 * @param string $formattedParent The parent value for Database System Shapes in the following
 *                                format: projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_db_system_shapes_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListDbSystemShapesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listDbSystemShapes($request);

        /** @var DbSystemShape $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_db_system_shapes_sample($formattedParent);
}

listDbSystems

Lists all the DbSystems for the given project and location.

The async variant is OracleDatabaseClient::listDbSystemsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbSystemsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DbSystem;
use Google\Cloud\OracleDatabase\V1\ListDbSystemsRequest;

/**
 * @param string $formattedParent The parent value for DbSystems in the following format:
 *                                projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_db_systems_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListDbSystemsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listDbSystems($request);

        /** @var DbSystem $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_db_systems_sample($formattedParent);
}

listDbVersions

List DbVersions for the given project and location.

The async variant is OracleDatabaseClient::listDbVersionsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbVersionsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\DbVersion;
use Google\Cloud\OracleDatabase\V1\ListDbVersionsRequest;

/**
 * @param string $formattedParent The parent value for the DbVersion resource with the
 *                                format: projects/{project}/locations/{location}
 *                                Please see {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_db_versions_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListDbVersionsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listDbVersions($request);

        /** @var DbVersion $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_db_versions_sample($formattedParent);
}

listEntitlements

Lists the entitlements in a given project.

The async variant is OracleDatabaseClient::listEntitlementsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListEntitlementsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\Entitlement;
use Google\Cloud\OracleDatabase\V1\ListEntitlementsRequest;

/**
 * @param string $formattedParent The parent value for the entitlement in the following format:
 *                                projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_entitlements_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListEntitlementsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listEntitlements($request);

        /** @var Entitlement $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_entitlements_sample($formattedParent);
}

listExadbVmClusters

Lists all the Exadb (Exascale) VM Clusters for the given project and location.

The async variant is OracleDatabaseClient::listExadbVmClustersAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListExadbVmClustersRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ExadbVmCluster;
use Google\Cloud\OracleDatabase\V1\ListExadbVmClustersRequest;

/**
 * @param string $formattedParent The parent value for ExadbVmClusters in the following format:
 *                                projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_exadb_vm_clusters_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListExadbVmClustersRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listExadbVmClusters($request);

        /** @var ExadbVmCluster $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_exadb_vm_clusters_sample($formattedParent);
}

listExascaleDbStorageVaults

Lists all the ExascaleDB Storage Vaults for the given project and location.

The async variant is OracleDatabaseClient::listExascaleDbStorageVaultsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListExascaleDbStorageVaultsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ExascaleDbStorageVault;
use Google\Cloud\OracleDatabase\V1\ListExascaleDbStorageVaultsRequest;

/**
 * @param string $formattedParent The parent value for ExascaleDbStorageVault in the following
 *                                format: projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_exascale_db_storage_vaults_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListExascaleDbStorageVaultsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listExascaleDbStorageVaults($request);

        /** @var ExascaleDbStorageVault $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_exascale_db_storage_vaults_sample($formattedParent);
}

listGiVersions

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

The async variant is OracleDatabaseClient::listGiVersionsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListGiVersionsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\GiVersion;
use Google\Cloud\OracleDatabase\V1\ListGiVersionsRequest;

/**
 * @param string $formattedParent The parent value for Grid Infrastructure Version in the following
 *                                format: Format: projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_gi_versions_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListGiVersionsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listGiVersions($request);

        /** @var GiVersion $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_gi_versions_sample($formattedParent);
}

listMinorVersions

Lists all the valid minor versions for the given project, location, gi version and shape family.

The async variant is OracleDatabaseClient::listMinorVersionsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListMinorVersionsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ListMinorVersionsRequest;
use Google\Cloud\OracleDatabase\V1\MinorVersion;

/**
 * @param string $formattedParent The parent value for the MinorVersion resource with the format:
 *                                projects/{project}/locations/{location}/giVersions/{gi_version}
 *                                Please see {@see OracleDatabaseClient::giVersionName()} for help formatting this field.
 */
function list_minor_versions_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListMinorVersionsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listMinorVersions($request);

        /** @var MinorVersion $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::giVersionName('[PROJECT]', '[LOCATION]', '[GI_VERSION]');

    list_minor_versions_sample($formattedParent);
}

listOdbNetworks

Lists the ODB Networks in a given project and location.

The async variant is OracleDatabaseClient::listOdbNetworksAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListOdbNetworksRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ListOdbNetworksRequest;
use Google\Cloud\OracleDatabase\V1\OdbNetwork;

/**
 * @param string $formattedParent The parent value for the ODB Network in the following format:
 *                                projects/{project}/locations/{location}. Please see
 *                                {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_odb_networks_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListOdbNetworksRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listOdbNetworks($request);

        /** @var OdbNetwork $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_odb_networks_sample($formattedParent);
}

listOdbSubnets

Lists all the ODB Subnets in a given ODB Network.

The async variant is OracleDatabaseClient::listOdbSubnetsAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListOdbSubnetsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ListOdbSubnetsRequest;
use Google\Cloud\OracleDatabase\V1\OdbSubnet;

/**
 * @param string $formattedParent The parent value for the OdbSubnet in the following format:
 *                                projects/{project}/locations/{location}/odbNetworks/{odb_network}. Please see
 *                                {@see OracleDatabaseClient::odbNetworkName()} for help formatting this field.
 */
function list_odb_subnets_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListOdbSubnetsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listOdbSubnets($request);

        /** @var OdbSubnet $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::odbNetworkName('[PROJECT]', '[LOCATION]', '[ODB_NETWORK]');

    list_odb_subnets_sample($formattedParent);
}

listPluggableDatabases

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

The async variant is OracleDatabaseClient::listPluggableDatabasesAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListPluggableDatabasesRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ListPluggableDatabasesRequest;
use Google\Cloud\OracleDatabase\V1\PluggableDatabase;

/**
 * @param string $formattedParent The parent, which owns this collection of PluggableDatabases.
 *                                Format: projects/{project}/locations/{location}
 *                                Please see {@see OracleDatabaseClient::locationName()} for help formatting this field.
 */
function list_pluggable_databases_sample(string $formattedParent): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new ListPluggableDatabasesRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listPluggableDatabases($request);

        /** @var PluggableDatabase $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OracleDatabaseClient::locationName('[PROJECT]', '[LOCATION]');

    list_pluggable_databases_sample($formattedParent);
}

removeVirtualMachineExadbVmCluster

Removes virtual machines from an existing exadb vm cluster.

The async variant is OracleDatabaseClient::removeVirtualMachineExadbVmClusterAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\RemoveVirtualMachineExadbVmClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\ExadbVmCluster>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ExadbVmCluster;
use Google\Cloud\OracleDatabase\V1\RemoveVirtualMachineExadbVmClusterRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName    The name of the ExadbVmCluster in the following format:
 *                                 projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. Please see
 *                                 {@see OracleDatabaseClient::exadbVmClusterName()} for help formatting this field.
 * @param string $hostnamesElement The list of host names of db nodes to be removed from the
 *                                 ExadbVmCluster.
 */
function remove_virtual_machine_exadb_vm_cluster_sample(
    string $formattedName,
    string $hostnamesElement
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $hostnames = [$hostnamesElement,];
    $request = (new RemoveVirtualMachineExadbVmClusterRequest())
        ->setName($formattedName)
        ->setHostnames($hostnames);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->removeVirtualMachineExadbVmCluster($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ExadbVmCluster $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::exadbVmClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[EXADB_VM_CLUSTER]'
    );
    $hostnamesElement = '[HOSTNAMES]';

    remove_virtual_machine_exadb_vm_cluster_sample($formattedName, $hostnamesElement);
}

restartAutonomousDatabase

Restarts an Autonomous Database.

The async variant is OracleDatabaseClient::restartAutonomousDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\RestartAutonomousDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\AutonomousDatabase>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabase;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\RestartAutonomousDatabaseRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Autonomous Database in the following format:
 *                              projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. Please see
 *                              {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 */
function restart_autonomous_database_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new RestartAutonomousDatabaseRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->restartAutonomousDatabase($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AutonomousDatabase $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );

    restart_autonomous_database_sample($formattedName);
}

restoreAutonomousDatabase

Restores a single Autonomous Database.

The async variant is OracleDatabaseClient::restoreAutonomousDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\RestoreAutonomousDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\AutonomousDatabase>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabase;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\RestoreAutonomousDatabaseRequest;
use Google\Protobuf\Timestamp;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Autonomous Database in the following format:
 *                              projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. Please see
 *                              {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 */
function restore_autonomous_database_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $restoreTime = new Timestamp();
    $request = (new RestoreAutonomousDatabaseRequest())
        ->setName($formattedName)
        ->setRestoreTime($restoreTime);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->restoreAutonomousDatabase($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AutonomousDatabase $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );

    restore_autonomous_database_sample($formattedName);
}

startAutonomousDatabase

Starts an Autonomous Database.

The async variant is OracleDatabaseClient::startAutonomousDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\StartAutonomousDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\AutonomousDatabase>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabase;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\StartAutonomousDatabaseRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Autonomous Database in the following format:
 *                              projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. Please see
 *                              {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 */
function start_autonomous_database_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new StartAutonomousDatabaseRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->startAutonomousDatabase($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AutonomousDatabase $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );

    start_autonomous_database_sample($formattedName);
}

stopAutonomousDatabase

Stops an Autonomous Database.

The async variant is OracleDatabaseClient::stopAutonomousDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\StopAutonomousDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\AutonomousDatabase>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabase;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\StopAutonomousDatabaseRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Autonomous Database in the following format:
 *                              projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. Please see
 *                              {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 */
function stop_autonomous_database_sample(string $formattedName): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new StopAutonomousDatabaseRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->stopAutonomousDatabase($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AutonomousDatabase $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );

    stop_autonomous_database_sample($formattedName);
}

switchoverAutonomousDatabase

Initiates a switchover of specified autonomous database to the associated peer database.

The async variant is OracleDatabaseClient::switchoverAutonomousDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\SwitchoverAutonomousDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\AutonomousDatabase>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabase;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\SwitchoverAutonomousDatabaseRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName                   The name of the Autonomous Database in the following format:
 *                                                projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. Please see
 *                                                {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 * @param string $formattedPeerAutonomousDatabase The peer database name to switch over to. Please see
 *                                                {@see OracleDatabaseClient::autonomousDatabaseName()} for help formatting this field.
 */
function switchover_autonomous_database_sample(
    string $formattedName,
    string $formattedPeerAutonomousDatabase
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = (new SwitchoverAutonomousDatabaseRequest())
        ->setName($formattedName)
        ->setPeerAutonomousDatabase($formattedPeerAutonomousDatabase);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->switchoverAutonomousDatabase($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AutonomousDatabase $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );
    $formattedPeerAutonomousDatabase = OracleDatabaseClient::autonomousDatabaseName(
        '[PROJECT]',
        '[LOCATION]',
        '[AUTONOMOUS_DATABASE]'
    );

    switchover_autonomous_database_sample($formattedName, $formattedPeerAutonomousDatabase);
}

updateAutonomousDatabase

Updates the parameters of a single Autonomous Database.

The async variant is OracleDatabaseClient::updateAutonomousDatabaseAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\UpdateAutonomousDatabaseRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\AutonomousDatabase>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\AutonomousDatabase;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\UpdateAutonomousDatabaseRequest;
use Google\Rpc\Status;

/**
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_autonomous_database_sample(): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $autonomousDatabase = new AutonomousDatabase();
    $request = (new UpdateAutonomousDatabaseRequest())
        ->setAutonomousDatabase($autonomousDatabase);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->updateAutonomousDatabase($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var AutonomousDatabase $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

updateExadbVmCluster

Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count.

The async variant is OracleDatabaseClient::updateExadbVmClusterAsync() .

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\UpdateExadbVmClusterRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\OperationResponse<Google\Cloud\OracleDatabase\V1\ExadbVmCluster>
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;
use Google\Cloud\OracleDatabase\V1\ExadbVmCluster;
use Google\Cloud\OracleDatabase\V1\ExadbVmClusterProperties;
use Google\Cloud\OracleDatabase\V1\ExadbVmClusterProperties\ShapeAttribute;
use Google\Cloud\OracleDatabase\V1\ExadbVmClusterStorageDetails;
use Google\Cloud\OracleDatabase\V1\UpdateExadbVmClusterRequest;
use Google\Rpc\Status;

/**
 * @param string $exadbVmClusterPropertiesGridImageId                         Immutable. Grid Infrastructure Version.
 * @param int    $exadbVmClusterPropertiesNodeCount                           The number of nodes/VMs in the ExadbVmCluster.
 * @param int    $exadbVmClusterPropertiesEnabledEcpuCountPerNode             Immutable. The number of ECPUs enabled per node for an exadata vm
 *                                                                            cluster on exascale infrastructure.
 * @param int    $exadbVmClusterPropertiesVmFileSystemStorageSizeInGbsPerNode The storage allocation for the exadbvmcluster per node, in
 *                                                                            gigabytes (GB). This field is used to calculate the total storage
 *                                                                            allocation for the exadbvmcluster.
 * @param string $formattedExadbVmClusterPropertiesExascaleDbStorageVault     Immutable. The name of ExascaleDbStorageVault associated with the
 *                                                                            ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a
 *                                                                            new one can be created during the ExadbVmCluster creation (requires
 *                                                                            storage_vault_properties to be set).
 *                                                                            Format:
 *                                                                            projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
 *                                                                            Please see {@see OracleDatabaseClient::exascaleDbStorageVaultName()} for help formatting this field.
 * @param string $exadbVmClusterPropertiesHostnamePrefix                      Immutable. Prefix for VM cluster host names.
 * @param string $exadbVmClusterPropertiesSshPublicKeysElement                Immutable. The SSH public keys for the ExadbVmCluster.
 * @param int    $exadbVmClusterPropertiesShapeAttribute                      Immutable. The shape attribute of the VM cluster. The type of
 *                                                                            Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE
 *                                                                            which supports Oracle Database 23ai and later
 * @param string $formattedExadbVmClusterOdbSubnet                            Immutable. The name of the OdbSubnet associated with the
 *                                                                            ExadbVmCluster for IP allocation. Format:
 *                                                                            projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
 *                                                                            Please see {@see OracleDatabaseClient::odbSubnetName()} for help formatting this field.
 * @param string $formattedExadbVmClusterBackupOdbSubnet                      Immutable. The name of the backup OdbSubnet associated with the
 *                                                                            ExadbVmCluster. Format:
 *                                                                            projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
 *                                                                            Please see {@see OracleDatabaseClient::odbSubnetName()} for help formatting this field.
 * @param string $exadbVmClusterDisplayName                                   Immutable. The display name for the ExadbVmCluster. The name does
 *                                                                            not have to be unique within your project. The name must be 1-255
 *                                                                            characters long and can only contain alphanumeric characters.
 */
function update_exadb_vm_cluster_sample(
    string $exadbVmClusterPropertiesGridImageId,
    int $exadbVmClusterPropertiesNodeCount,
    int $exadbVmClusterPropertiesEnabledEcpuCountPerNode,
    int $exadbVmClusterPropertiesVmFileSystemStorageSizeInGbsPerNode,
    string $formattedExadbVmClusterPropertiesExascaleDbStorageVault,
    string $exadbVmClusterPropertiesHostnamePrefix,
    string $exadbVmClusterPropertiesSshPublicKeysElement,
    int $exadbVmClusterPropertiesShapeAttribute,
    string $formattedExadbVmClusterOdbSubnet,
    string $formattedExadbVmClusterBackupOdbSubnet,
    string $exadbVmClusterDisplayName
): void {
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $exadbVmClusterPropertiesVmFileSystemStorage = (new ExadbVmClusterStorageDetails())
        ->setSizeInGbsPerNode($exadbVmClusterPropertiesVmFileSystemStorageSizeInGbsPerNode);
    $exadbVmClusterPropertiesSshPublicKeys = [$exadbVmClusterPropertiesSshPublicKeysElement,];
    $exadbVmClusterProperties = (new ExadbVmClusterProperties())
        ->setGridImageId($exadbVmClusterPropertiesGridImageId)
        ->setNodeCount($exadbVmClusterPropertiesNodeCount)
        ->setEnabledEcpuCountPerNode($exadbVmClusterPropertiesEnabledEcpuCountPerNode)
        ->setVmFileSystemStorage($exadbVmClusterPropertiesVmFileSystemStorage)
        ->setExascaleDbStorageVault($formattedExadbVmClusterPropertiesExascaleDbStorageVault)
        ->setHostnamePrefix($exadbVmClusterPropertiesHostnamePrefix)
        ->setSshPublicKeys($exadbVmClusterPropertiesSshPublicKeys)
        ->setShapeAttribute($exadbVmClusterPropertiesShapeAttribute);
    $exadbVmCluster = (new ExadbVmCluster())
        ->setProperties($exadbVmClusterProperties)
        ->setOdbSubnet($formattedExadbVmClusterOdbSubnet)
        ->setBackupOdbSubnet($formattedExadbVmClusterBackupOdbSubnet)
        ->setDisplayName($exadbVmClusterDisplayName);
    $request = (new UpdateExadbVmClusterRequest())
        ->setExadbVmCluster($exadbVmCluster);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $oracleDatabaseClient->updateExadbVmCluster($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ExadbVmCluster $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $exadbVmClusterPropertiesGridImageId = '[GRID_IMAGE_ID]';
    $exadbVmClusterPropertiesNodeCount = 0;
    $exadbVmClusterPropertiesEnabledEcpuCountPerNode = 0;
    $exadbVmClusterPropertiesVmFileSystemStorageSizeInGbsPerNode = 0;
    $formattedExadbVmClusterPropertiesExascaleDbStorageVault = OracleDatabaseClient::exascaleDbStorageVaultName(
        '[PROJECT]',
        '[LOCATION]',
        '[EXASCALE_DB_STORAGE_VAULT]'
    );
    $exadbVmClusterPropertiesHostnamePrefix = '[HOSTNAME_PREFIX]';
    $exadbVmClusterPropertiesSshPublicKeysElement = '[SSH_PUBLIC_KEYS]';
    $exadbVmClusterPropertiesShapeAttribute = ShapeAttribute::SHAPE_ATTRIBUTE_UNSPECIFIED;
    $formattedExadbVmClusterOdbSubnet = OracleDatabaseClient::odbSubnetName(
        '[PROJECT]',
        '[LOCATION]',
        '[ODB_NETWORK]',
        '[ODB_SUBNET]'
    );
    $formattedExadbVmClusterBackupOdbSubnet = OracleDatabaseClient::odbSubnetName(
        '[PROJECT]',
        '[LOCATION]',
        '[ODB_NETWORK]',
        '[ODB_SUBNET]'
    );
    $exadbVmClusterDisplayName = '[DISPLAY_NAME]';

    update_exadb_vm_cluster_sample(
        $exadbVmClusterPropertiesGridImageId,
        $exadbVmClusterPropertiesNodeCount,
        $exadbVmClusterPropertiesEnabledEcpuCountPerNode,
        $exadbVmClusterPropertiesVmFileSystemStorageSizeInGbsPerNode,
        $formattedExadbVmClusterPropertiesExascaleDbStorageVault,
        $exadbVmClusterPropertiesHostnamePrefix,
        $exadbVmClusterPropertiesSshPublicKeysElement,
        $exadbVmClusterPropertiesShapeAttribute,
        $formattedExadbVmClusterOdbSubnet,
        $formattedExadbVmClusterBackupOdbSubnet,
        $exadbVmClusterDisplayName
    );
}

getLocation

Gets information about a location.

The async variant is OracleDatabaseClient::getLocationAsync() .

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\Cloud\Location\Location
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;

/**
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function get_location_sample(): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $oracleDatabaseClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

The async variant is OracleDatabaseClient::listLocationsAsync() .

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type Description
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\OracleDatabase\V1\Client\OracleDatabaseClient;

/**
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_locations_sample(): void
{
    // Create a client.
    $oracleDatabaseClient = new OracleDatabaseClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $oracleDatabaseClient->listLocations($request);

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

createAutonomousDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateAutonomousDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

createCloudExadataInfrastructureAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateCloudExadataInfrastructureRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

createCloudVmClusterAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateCloudVmClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

createDbSystemAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateDbSystemRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

createExadbVmClusterAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateExadbVmClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

createExascaleDbStorageVaultAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateExascaleDbStorageVaultRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

createOdbNetworkAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateOdbNetworkRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

createOdbSubnetAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\CreateOdbSubnetRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteAutonomousDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteAutonomousDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteCloudExadataInfrastructureAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteCloudExadataInfrastructureRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteCloudVmClusterAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteCloudVmClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteDbSystemAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteDbSystemRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteExadbVmClusterAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteExadbVmClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteExascaleDbStorageVaultAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteExascaleDbStorageVaultRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteOdbNetworkAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteOdbNetworkRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteOdbSubnetAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\DeleteOdbSubnetRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

failoverAutonomousDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\FailoverAutonomousDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

generateAutonomousDatabaseWalletAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GenerateAutonomousDatabaseWalletRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\GenerateAutonomousDatabaseWalletResponse>

getAutonomousDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetAutonomousDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\AutonomousDatabase>

getCloudExadataInfrastructureAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetCloudExadataInfrastructureRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\CloudExadataInfrastructure>

getCloudVmClusterAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetCloudVmClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\CloudVmCluster>

getDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\Database>

getDbSystemAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetDbSystemRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\DbSystem>

getExadbVmClusterAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetExadbVmClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\ExadbVmCluster>

getExascaleDbStorageVaultAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetExascaleDbStorageVaultRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\ExascaleDbStorageVault>

getOdbNetworkAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetOdbNetworkRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\OdbNetwork>

getOdbSubnetAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetOdbSubnetRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\OdbSubnet>

getPluggableDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\GetPluggableDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\OracleDatabase\V1\PluggableDatabase>

listAutonomousDatabaseBackupsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListAutonomousDatabaseBackupsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listAutonomousDatabaseCharacterSetsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListAutonomousDatabaseCharacterSetsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listAutonomousDatabasesAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListAutonomousDatabasesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listAutonomousDbVersionsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListAutonomousDbVersionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listCloudExadataInfrastructuresAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListCloudExadataInfrastructuresRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listCloudVmClustersAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListCloudVmClustersRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listDatabaseCharacterSetsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDatabaseCharacterSetsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listDatabasesAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDatabasesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listDbNodesAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbNodesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listDbServersAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbServersRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listDbSystemInitialStorageSizesAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbSystemInitialStorageSizesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listDbSystemShapesAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbSystemShapesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listDbSystemsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbSystemsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listDbVersionsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListDbVersionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listEntitlementsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListEntitlementsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listExadbVmClustersAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListExadbVmClustersRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listExascaleDbStorageVaultsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListExascaleDbStorageVaultsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listGiVersionsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListGiVersionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listMinorVersionsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListMinorVersionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listOdbNetworksAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListOdbNetworksRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listOdbSubnetsAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListOdbSubnetsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listPluggableDatabasesAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\ListPluggableDatabasesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

removeVirtualMachineExadbVmClusterAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\RemoveVirtualMachineExadbVmClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

restartAutonomousDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\RestartAutonomousDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

restoreAutonomousDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\RestoreAutonomousDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

startAutonomousDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\StartAutonomousDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

stopAutonomousDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\StopAutonomousDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

switchoverAutonomousDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\SwitchoverAutonomousDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

updateAutonomousDatabaseAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\UpdateAutonomousDatabaseRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

updateExadbVmClusterAsync

Parameters
Name Description
request Google\Cloud\OracleDatabase\V1\UpdateExadbVmClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getLocationAsync

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>

listLocationsAsync

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type Description
Google\LongRunning\Client\OperationsClient

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name Description
operationName string

The name of the long running operation

methodName string

The name of the method used to start the operation

Returns
Type Description
Google\ApiCore\OperationResponse

static::autonomousDatabaseName

Formats a string containing the fully-qualified path to represent a autonomous_database resource.

Parameters
Name Description
project string
location string
autonomousDatabase string
Returns
Type Description
string The formatted autonomous_database resource.

static::cloudExadataInfrastructureName

Formats a string containing the fully-qualified path to represent a cloud_exadata_infrastructure resource.

Parameters
Name Description
project string
location string
cloudExadataInfrastructure string
Returns
Type Description
string The formatted cloud_exadata_infrastructure resource.

static::cloudVmClusterName

Formats a string containing the fully-qualified path to represent a cloud_vm_cluster resource.

Parameters
Name Description
project string
location string
cloudVmCluster string
Returns
Type Description
string The formatted cloud_vm_cluster resource.

static::cryptoKeyName

Formats a string containing the fully-qualified path to represent a crypto_key resource.

Parameters
Name Description
project string
location string
keyRing string
cryptoKey string
Returns
Type Description
string The formatted crypto_key resource.

static::databaseName

Formats a string containing the fully-qualified path to represent a database resource.

Parameters
Name Description
project string
location string
database string
Returns
Type Description
string The formatted database resource.

static::dbSystemName

Formats a string containing the fully-qualified path to represent a db_system resource.

Parameters
Name Description
project string
location string
dbSystem string
Returns
Type Description
string The formatted db_system resource.

static::exadbVmClusterName

Formats a string containing the fully-qualified path to represent a exadb_vm_cluster resource.

Parameters
Name Description
project string
location string
exadbVmCluster string
Returns
Type Description
string The formatted exadb_vm_cluster resource.

static::exascaleDbStorageVaultName

Formats a string containing the fully-qualified path to represent a exascale_db_storage_vault resource.

Parameters
Name Description
project string
location string
exascaleDbStorageVault string
Returns
Type Description
string The formatted exascale_db_storage_vault resource.

static::giVersionName

Formats a string containing the fully-qualified path to represent a gi_version resource.

Parameters
Name Description
project string
location string
giVersion string
Returns
Type Description
string The formatted gi_version resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name Description
project string
location string
Returns
Type Description
string The formatted location resource.

static::networkName

Formats a string containing the fully-qualified path to represent a network resource.

Parameters
Name Description
project string
network string
Returns
Type Description
string The formatted network resource.

static::odbNetworkName

Formats a string containing the fully-qualified path to represent a odb_network resource.

Parameters
Name Description
project string
location string
odbNetwork string
Returns
Type Description
string The formatted odb_network resource.

static::odbSubnetName

Formats a string containing the fully-qualified path to represent a odb_subnet resource.

Parameters
Name Description
project string
location string
odbNetwork string
odbSubnet string
Returns
Type Description
string The formatted odb_subnet resource.

static::pluggableDatabaseName

Formats a string containing the fully-qualified path to represent a pluggable_database resource.

Parameters
Name Description
project string
location string
pluggableDatabase string
Returns
Type Description
string The formatted pluggable_database resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • autonomousDatabase: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}
  • cloudExadataInfrastructure: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}
  • cloudVmCluster: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}
  • cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
  • database: projects/{project}/locations/{location}/databases/{database}
  • dbSystem: projects/{project}/locations/{location}/dbSystems/{db_system}
  • exadbVmCluster: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}
  • exascaleDbStorageVault: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
  • giVersion: projects/{project}/locations/{location}/giVersions/{gi_version}
  • location: projects/{project}/locations/{location}
  • network: projects/{project}/global/networks/{network}
  • odbNetwork: projects/{project}/locations/{location}/odbNetworks/{odb_network}
  • odbSubnet: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
  • pluggableDatabase: projects/{project}/locations/{location}/pluggableDatabases/{pluggable_database}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name Description
formattedName string

The formatted name string

template ?string

Optional name of template to match

Returns
Type Description
array An associative array from name component IDs to component values.