Google Cloud Ai Platform V1 Client - Class DatasetServiceClient (0.31.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class DatasetServiceClient.

Service Description: The service that manages Vertex AI Dataset and its child 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 \ AIPlatform \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` 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`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ 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.

createDataset

Creates a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::createDatasetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateDatasetRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\CreateDatasetRequest;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Protobuf\Value;
use Google\Rpc\Status;

/**
 * @param string $formattedParent          The resource name of the Location to create the Dataset in.
 *                                         Format: `projects/{project}/locations/{location}`
 *                                         Please see {@see DatasetServiceClient::locationName()} for help formatting this field.
 * @param string $datasetDisplayName       The user-defined name of the Dataset.
 *                                         The name can be up to 128 characters long and can consist of any UTF-8
 *                                         characters.
 * @param string $datasetMetadataSchemaUri Points to a YAML file stored on Google Cloud Storage describing
 *                                         additional information about the Dataset. The schema is defined as an
 *                                         OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
 *                                         found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
 */
function create_dataset_sample(
    string $formattedParent,
    string $datasetDisplayName,
    string $datasetMetadataSchemaUri
): void {
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

    // Prepare the request message.
    $datasetMetadata = new Value();
    $dataset = (new Dataset())
        ->setDisplayName($datasetDisplayName)
        ->setMetadataSchemaUri($datasetMetadataSchemaUri)
        ->setMetadata($datasetMetadata);
    $request = (new CreateDatasetRequest())
        ->setParent($formattedParent)
        ->setDataset($dataset);

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

        if ($response->operationSucceeded()) {
            /** @var Dataset $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 = DatasetServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $datasetDisplayName = '[DISPLAY_NAME]';
    $datasetMetadataSchemaUri = '[METADATA_SCHEMA_URI]';

    create_dataset_sample($formattedParent, $datasetDisplayName, $datasetMetadataSchemaUri);
}

createDatasetVersion

Create a version from a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::createDatasetVersionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateDatasetVersionRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\CreateDatasetVersionRequest;
use Google\Cloud\AIPlatform\V1\DatasetVersion;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The name of the Dataset resource.
 *                                Format:
 *                                `projects/{project}/locations/{location}/datasets/{dataset}`
 *                                Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
 */
function create_dataset_version_sample(string $formattedParent): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

    // Prepare the request message.
    $datasetVersion = new DatasetVersion();
    $request = (new CreateDatasetVersionRequest())
        ->setParent($formattedParent)
        ->setDatasetVersion($datasetVersion);

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

        if ($response->operationSucceeded()) {
            /** @var DatasetVersion $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 = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');

    create_dataset_version_sample($formattedParent);
}

deleteDataset

Deletes a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::deleteDatasetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteDatasetRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteDatasetRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the Dataset to delete.
 *                              Format:
 *                              `projects/{project}/locations/{location}/datasets/{dataset}`
 *                              Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
 */
function delete_dataset_sample(string $formattedName): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $datasetServiceClient->deleteDataset($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 = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');

    delete_dataset_sample($formattedName);
}

deleteDatasetVersion

Deletes a Dataset version.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::deleteDatasetVersionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteDatasetVersionRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteDatasetVersionRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the Dataset version to delete.
 *                              Format:
 *                              `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
 *                              Please see {@see DatasetServiceClient::datasetVersionName()} for help formatting this field.
 */
function delete_dataset_version_sample(string $formattedName): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $datasetServiceClient->deleteDatasetVersion($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 = DatasetServiceClient::datasetVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASET]',
        '[DATASET_VERSION]'
    );

    delete_dataset_version_sample($formattedName);
}

deleteSavedQuery

Deletes a SavedQuery.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::deleteSavedQueryAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteSavedQueryRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteSavedQueryRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the SavedQuery to delete.
 *                              Format:
 *                              `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`
 *                              Please see {@see DatasetServiceClient::savedQueryName()} for help formatting this field.
 */
function delete_saved_query_sample(string $formattedName): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $datasetServiceClient->deleteSavedQuery($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 = DatasetServiceClient::savedQueryName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASET]',
        '[SAVED_QUERY]'
    );

    delete_saved_query_sample($formattedName);
}

exportData

Exports data from a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::exportDataAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ExportDataRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\ExportDataConfig;
use Google\Cloud\AIPlatform\V1\ExportDataRequest;
use Google\Cloud\AIPlatform\V1\ExportDataResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Dataset resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/datasets/{dataset}`
 *                              Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
 */
function export_data_sample(string $formattedName): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

    // Prepare the request message.
    $exportConfig = new ExportDataConfig();
    $request = (new ExportDataRequest())
        ->setName($formattedName)
        ->setExportConfig($exportConfig);

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

        if ($response->operationSucceeded()) {
            /** @var ExportDataResponse $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 = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');

    export_data_sample($formattedName);
}

getAnnotationSpec

Gets an AnnotationSpec.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::getAnnotationSpecAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetAnnotationSpecRequest` 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\AIPlatform\V1\AnnotationSpec`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\AnnotationSpec;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\GetAnnotationSpecRequest;

/**
 * @param string $formattedName The name of the AnnotationSpec resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
 *                              Please see {@see DatasetServiceClient::annotationSpecName()} for help formatting this field.
 */
function get_annotation_spec_sample(string $formattedName): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var AnnotationSpec $response */
        $response = $datasetServiceClient->getAnnotationSpec($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 = DatasetServiceClient::annotationSpecName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASET]',
        '[ANNOTATION_SPEC]'
    );

    get_annotation_spec_sample($formattedName);
}

getDataset

Gets a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::getDatasetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetDatasetRequest` 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\AIPlatform\V1\Dataset`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Cloud\AIPlatform\V1\GetDatasetRequest;

/**
 * @param string $formattedName The name of the Dataset resource. Please see
 *                              {@see DatasetServiceClient::datasetName()} for help formatting this field.
 */
function get_dataset_sample(string $formattedName): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Dataset $response */
        $response = $datasetServiceClient->getDataset($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 = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');

    get_dataset_sample($formattedName);
}

getDatasetVersion

Gets a Dataset version.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::getDatasetVersionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetDatasetVersionRequest` 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\AIPlatform\V1\DatasetVersion`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DatasetVersion;
use Google\Cloud\AIPlatform\V1\GetDatasetVersionRequest;

/**
 * @param string $formattedName The resource name of the Dataset version to delete.
 *                              Format:
 *                              `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
 *                              Please see {@see DatasetServiceClient::datasetVersionName()} for help formatting this field.
 */
function get_dataset_version_sample(string $formattedName): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DatasetVersion $response */
        $response = $datasetServiceClient->getDatasetVersion($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 = DatasetServiceClient::datasetVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASET]',
        '[DATASET_VERSION]'
    );

    get_dataset_version_sample($formattedName);
}

importData

Imports data into a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::importDataAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ImportDataRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\ImportDataConfig;
use Google\Cloud\AIPlatform\V1\ImportDataRequest;
use Google\Cloud\AIPlatform\V1\ImportDataResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName                The name of the Dataset resource.
 *                                             Format:
 *                                             `projects/{project}/locations/{location}/datasets/{dataset}`
 *                                             Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
 * @param string $importConfigsImportSchemaUri Points to a YAML file stored on Google Cloud Storage describing
 *                                             the import format. Validation will be done against the schema. The schema
 *                                             is defined as an [OpenAPI 3.0.2 Schema
 *                                             Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 */
function import_data_sample(string $formattedName, string $importConfigsImportSchemaUri): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

    // Prepare the request message.
    $importDataConfig = (new ImportDataConfig())
        ->setImportSchemaUri($importConfigsImportSchemaUri);
    $importConfigs = [$importDataConfig,];
    $request = (new ImportDataRequest())
        ->setName($formattedName)
        ->setImportConfigs($importConfigs);

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

        if ($response->operationSucceeded()) {
            /** @var ImportDataResponse $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 = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');
    $importConfigsImportSchemaUri = '[IMPORT_SCHEMA_URI]';

    import_data_sample($formattedName, $importConfigsImportSchemaUri);
}

listAnnotations

Lists Annotations belongs to a dataitem

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::listAnnotationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListAnnotationsRequest` 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\AIPlatform\V1\Annotation;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\ListAnnotationsRequest;

/**
 * @param string $formattedParent The resource name of the DataItem to list Annotations from.
 *                                Format:
 *                                `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
 *                                Please see {@see DatasetServiceClient::dataItemName()} for help formatting this field.
 */
function list_annotations_sample(string $formattedParent): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

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

        /** @var Annotation $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 = DatasetServiceClient::dataItemName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASET]',
        '[DATA_ITEM]'
    );

    list_annotations_sample($formattedParent);
}

listDataItems

Lists DataItems in a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::listDataItemsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListDataItemsRequest` 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\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DataItem;
use Google\Cloud\AIPlatform\V1\ListDataItemsRequest;

/**
 * @param string $formattedParent The resource name of the Dataset to list DataItems from.
 *                                Format:
 *                                `projects/{project}/locations/{location}/datasets/{dataset}`
 *                                Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
 */
function list_data_items_sample(string $formattedParent): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

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

        /** @var DataItem $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 = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');

    list_data_items_sample($formattedParent);
}

listDatasetVersions

Lists DatasetVersions in a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::listDatasetVersionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListDatasetVersionsRequest` 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\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DatasetVersion;
use Google\Cloud\AIPlatform\V1\ListDatasetVersionsRequest;

/**
 * @param string $formattedParent The resource name of the Dataset to list DatasetVersions from.
 *                                Format:
 *                                `projects/{project}/locations/{location}/datasets/{dataset}`
 *                                Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
 */
function list_dataset_versions_sample(string $formattedParent): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

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

        /** @var DatasetVersion $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 = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');

    list_dataset_versions_sample($formattedParent);
}

listDatasets

Lists Datasets in a Location.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::listDatasetsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListDatasetsRequest` 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\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Cloud\AIPlatform\V1\ListDatasetsRequest;

/**
 * @param string $formattedParent The name of the Dataset's parent resource.
 *                                Format: `projects/{project}/locations/{location}`
 *                                Please see {@see DatasetServiceClient::locationName()} for help formatting this field.
 */
function list_datasets_sample(string $formattedParent): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

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

        /** @var Dataset $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 = DatasetServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_datasets_sample($formattedParent);
}

listSavedQueries

Lists SavedQueries in a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::listSavedQueriesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListSavedQueriesRequest` 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\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\ListSavedQueriesRequest;
use Google\Cloud\AIPlatform\V1\SavedQuery;

/**
 * @param string $formattedParent The resource name of the Dataset to list SavedQueries from.
 *                                Format:
 *                                `projects/{project}/locations/{location}/datasets/{dataset}`
 *                                Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
 */
function list_saved_queries_sample(string $formattedParent): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

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

        /** @var SavedQuery $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 = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');

    list_saved_queries_sample($formattedParent);
}

restoreDatasetVersion

Restores a dataset version.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::restoreDatasetVersionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\RestoreDatasetVersionRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DatasetVersion;
use Google\Cloud\AIPlatform\V1\RestoreDatasetVersionRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the DatasetVersion resource.
 *                              Format:
 *                              `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
 *                              Please see {@see DatasetServiceClient::datasetVersionName()} for help formatting this field.
 */
function restore_dataset_version_sample(string $formattedName): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var DatasetVersion $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 = DatasetServiceClient::datasetVersionName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASET]',
        '[DATASET_VERSION]'
    );

    restore_dataset_version_sample($formattedName);
}

searchDataItems

Searches DataItems in a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::searchDataItemsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\SearchDataItemsRequest` 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\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\DataItemView;
use Google\Cloud\AIPlatform\V1\SearchDataItemsRequest;

/**
 * @param string $formattedDataset The resource name of the Dataset from which to search DataItems.
 *                                 Format:
 *                                 `projects/{project}/locations/{location}/datasets/{dataset}`
 *                                 Please see {@see DatasetServiceClient::datasetName()} for help formatting this field.
 */
function search_data_items_sample(string $formattedDataset): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

    // Prepare the request message.
    $request = (new SearchDataItemsRequest())
        ->setDataset($formattedDataset);

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

        /** @var DataItemView $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
{
    $formattedDataset = DatasetServiceClient::datasetName('[PROJECT]', '[LOCATION]', '[DATASET]');

    search_data_items_sample($formattedDataset);
}

updateDataset

Updates a Dataset.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::updateDatasetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\UpdateDatasetRequest` 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\AIPlatform\V1\Dataset`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Cloud\AIPlatform\V1\UpdateDatasetRequest;
use Google\Protobuf\FieldMask;
use Google\Protobuf\Value;

/**
 * @param string $datasetDisplayName       The user-defined name of the Dataset.
 *                                         The name can be up to 128 characters long and can consist of any UTF-8
 *                                         characters.
 * @param string $datasetMetadataSchemaUri Points to a YAML file stored on Google Cloud Storage describing
 *                                         additional information about the Dataset. The schema is defined as an
 *                                         OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
 *                                         found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
 */
function update_dataset_sample(string $datasetDisplayName, string $datasetMetadataSchemaUri): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

    // Prepare the request message.
    $datasetMetadata = new Value();
    $dataset = (new Dataset())
        ->setDisplayName($datasetDisplayName)
        ->setMetadataSchemaUri($datasetMetadataSchemaUri)
        ->setMetadata($datasetMetadata);
    $updateMask = new FieldMask();
    $request = (new UpdateDatasetRequest())
        ->setDataset($dataset)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Dataset $response */
        $response = $datasetServiceClient->updateDataset($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
{
    $datasetDisplayName = '[DISPLAY_NAME]';
    $datasetMetadataSchemaUri = '[METADATA_SCHEMA_URI]';

    update_dataset_sample($datasetDisplayName, $datasetMetadataSchemaUri);
}

getLocation

Gets information about a location.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::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\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * 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.
    $datasetServiceClient = new DatasetServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $datasetServiceClient->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 Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::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\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * 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.
    $datasetServiceClient = new DatasetServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $datasetServiceClient->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());
    }
}

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::getIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest` 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\Iam\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $datasetServiceClient->getIamPolicy($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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::setIamPolicyAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest` 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\Iam\V1\Policy`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $datasetServiceClient->setIamPolicy($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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest` 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\Iam\V1\TestIamPermissionsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DatasetServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $datasetServiceClient = new DatasetServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $datasetServiceClient->testIamPermissions($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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}

createDatasetAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateDatasetRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createDatasetVersionAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\CreateDatasetVersionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteDatasetAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteDatasetRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteDatasetVersionAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteDatasetVersionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteSavedQueryAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\DeleteSavedQueryRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

exportDataAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ExportDataRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAnnotationSpecAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetAnnotationSpecRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDatasetAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetDatasetRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDatasetVersionAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\GetDatasetVersionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

importDataAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ImportDataRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listAnnotationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListAnnotationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDataItemsAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListDataItemsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDatasetVersionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListDatasetVersionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDatasetsAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListDatasetsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listSavedQueriesAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\ListSavedQueriesRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

restoreDatasetVersionAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\RestoreDatasetVersionRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

searchDataItemsAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\SearchDataItemsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateDatasetAsync

Parameters
Name	Description
`request`	`Google\Cloud\AIPlatform\V1\UpdateDatasetRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\GetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

setIamPolicyAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\SetIamPolicyRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

testIamPermissionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Iam\V1\TestIamPermissionsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

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

Returns
Type	Description
`Google\ApiCore\LongRunning\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::annotationSpecName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataset`	`string`
`annotationSpec`	`string`

Returns
Type	Description
`string`	The formatted annotation_spec resource.

static::dataItemName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataset`	`string`
`dataItem`	`string`

Returns
Type	Description
`string`	The formatted data_item resource.

static::datasetName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataset`	`string`

Returns
Type	Description
`string`	The formatted dataset resource.

static::datasetVersionName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataset`	`string`
`datasetVersion`	`string`

Returns
Type	Description
`string`	The formatted dataset_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::savedQueryName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataset`	`string`
`savedQuery`	`string`

Returns
Type	Description
`string`	The formatted saved_query 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

annotationSpec: projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}
dataItem: projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}
dataset: projects/{project}/locations/{location}/datasets/{dataset}
datasetVersion: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
location: projects/{project}/locations/{location}
savedQuery: projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}

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.