Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class DatasetServiceClient.
Service Description: The service that handles the CRUD of 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. Sample code to get started:
$datasetServiceClient = new DatasetServiceClient();
try {
$formattedParent = $datasetServiceClient->locationName('[PROJECT]', '[LOCATION]');
$dataset = new Dataset();
$operationResponse = $datasetServiceClient->createDataset($formattedParent, $dataset);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $datasetServiceClient->createDataset($formattedParent, $dataset);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $datasetServiceClient->resumeOperation($operationName, 'createDataset');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$datasetServiceClient->close();
}
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.
Methods
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. |
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. |
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. |
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. |
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. |
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}
- 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. |
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 |
__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 |
↳ 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 |
↳ 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.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Location to create the Dataset in.
Format: |
dataset |
Google\Cloud\AIPlatform\V1\Dataset
Required. The Dataset to create. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
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 any non-scalar elements to be passed along with the request.
$datasetMetadata = new Value();
$dataset = (new Dataset())
->setDisplayName($datasetDisplayName)
->setMetadataSchemaUri($datasetMetadataSchemaUri)
->setMetadata($datasetMetadata);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->createDataset($formattedParent, $dataset);
$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());
}
}
/**
* 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);
}
deleteDataset
Deletes a Dataset.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The resource name of the Dataset to delete.
Format:
|
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->deleteDataset($formattedName);
$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());
}
}
/**
* 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);
}
exportData
Exports data from a Dataset.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Dataset resource.
Format:
|
exportConfig |
Google\Cloud\AIPlatform\V1\ExportDataConfig
Required. The desired output location. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\ExportDataConfig;
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 any non-scalar elements to be passed along with the request.
$exportConfig = new ExportDataConfig();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->exportData($formattedName, $exportConfig);
$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());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the AnnotationSpec resource.
Format:
|
optionalArgs |
array
Optional. |
↳ readMask |
FieldMask
Mask specifying which fields to read. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\AnnotationSpec;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var AnnotationSpec $response */
$response = $datasetServiceClient->getAnnotationSpec($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Dataset resource. |
optionalArgs |
array
Optional. |
↳ readMask |
FieldMask
Mask specifying which fields to read. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var Dataset $response */
$response = $datasetServiceClient->getDataset($formattedName);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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);
}
importData
Imports data into a Dataset.
Parameters | |
---|---|
Name | Description |
name |
string
Required. The name of the Dataset resource.
Format:
|
importConfigs |
array<Google\Cloud\AIPlatform\V1\ImportDataConfig>
Required. The desired input locations. The contents of all input locations will be imported in one batch. |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
use Google\Cloud\AIPlatform\V1\ImportDataConfig;
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 any non-scalar elements to be passed along with the request.
$importDataConfig = (new ImportDataConfig())
->setImportSchemaUri($importConfigsImportSchemaUri);
$importConfigs = [$importDataConfig,];
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $datasetServiceClient->importData($formattedName, $importConfigs);
$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());
}
}
/**
* 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
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the DataItem to list Annotations from.
Format:
|
optionalArgs |
array
Optional. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ readMask |
FieldMask
Mask specifying which fields to read. |
↳ orderBy |
string
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Annotation;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->listAnnotations($formattedParent);
/** @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());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Dataset to list DataItems from.
Format:
|
optionalArgs |
array
Optional. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ readMask |
FieldMask
Mask specifying which fields to read. |
↳ orderBy |
string
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\DataItem;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->listDataItems($formattedParent);
/** @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());
}
}
/**
* 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);
}
listDatasets
Lists Datasets in a Location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The name of the Dataset's parent resource.
Format: |
optionalArgs |
array
Optional. |
↳ filter |
string
An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ readMask |
FieldMask
Mask specifying which fields to read. |
↳ orderBy |
string
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->listDatasets($formattedParent);
/** @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());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The resource name of the Dataset to list SavedQueries from.
Format:
|
optionalArgs |
array
Optional. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ readMask |
FieldMask
Mask specifying which fields to read. |
↳ orderBy |
string
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->listSavedQueries($formattedParent);
/** @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());
}
}
/**
* 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);
}
searchDataItems
Searches DataItems in a Dataset.
Parameters | |
---|---|
Name | Description |
dataset |
string
Required. The resource name of the Dataset from which to search DataItems.
Format:
|
optionalArgs |
array
Optional. |
↳ orderByDataItem |
string
A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. |
↳ orderByAnnotation |
OrderByAnnotation
Expression that allows ranking results based on annotation's property. |
↳ savedQuery |
string
The resource name of a SavedQuery(annotation set in UI). Format: |
↳ dataLabelingJob |
string
The resource name of a DataLabelingJob. Format: |
↳ dataItemFilter |
string
An expression for filtering the DataItem that will be returned. * |
↳ annotationsFilter |
string
An expression for filtering the Annotations that will be returned per DataItem. * |
↳ annotationFilters |
string[]
An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * |
↳ fieldMask |
FieldMask
Mask specifying which fields of DataItemView to read. |
↳ annotationsLimit |
int
If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ orderBy |
string
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\DataItemView;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
/**
* @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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->searchDataItems($formattedDataset);
/** @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());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
dataset |
Google\Cloud\AIPlatform\V1\Dataset
Required. The Dataset which replaces the resource on the server. |
updateMask |
Google\Protobuf\FieldMask
Required. The update mask applies to the resource.
For the
|
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Dataset;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
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 any non-scalar elements to be passed along with the request.
$datasetMetadata = new Value();
$dataset = (new Dataset())
->setDisplayName($datasetDisplayName)
->setMetadataSchemaUri($datasetMetadataSchemaUri)
->setMetadata($datasetMetadata);
$updateMask = new FieldMask();
// Call the API and handle any network failures.
try {
/** @var Dataset $response */
$response = $datasetServiceClient->updateDataset($dataset, $updateMask);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $datasetServiceClient->getLocation();
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.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $datasetServiceClient->listLocations();
/** @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.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
optionalArgs |
array
Optional. |
↳ options |
GetPolicyOptions
OPTIONAL: A |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
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();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $datasetServiceClient->getIamPolicy($resource);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
Google\Cloud\Iam\V1\Policy
REQUIRED: The complete policy to be applied to the |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: |
↳ 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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
use Google\Cloud\Iam\V1\Policy;
/**
* @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 any non-scalar elements to be passed along with the request.
$policy = new Policy();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $datasetServiceClient->setIamPolicy($resource, $policy);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
string[]
The set of permissions to check for the |
optionalArgs |
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 |
use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\DatasetServiceClient;
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 any non-scalar elements to be passed along with the request.
$permissions = [$permissionsElement,];
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $datasetServiceClient->testIamPermissions($resource, $permissions);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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);
}
Constants
SERVICE_NAME
Value: 'google.cloud.aiplatform.v1.DatasetService'
The name of the service.
SERVICE_ADDRESS
Value: 'aiplatform.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.