Google Cloud Ai Platform V1 Client - Class ModelServiceClient (0.18.0)

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

Service Description: A service for managing Vertex AI's machine learning Models.

This class is currently experimental and may be subject to changes.

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.

batchImportEvaluatedAnnotations

Imports a list of externally generated EvaluatedAnnotations.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::batchImportEvaluatedAnnotationsAsync() .

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

batchImportModelEvaluationSlices

Imports a list of externally generated ModelEvaluationSlice.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::batchImportModelEvaluationSlicesAsync() .

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

copyModel

Copies an already existing Vertex AI Model into the specified Location.

The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::copyModelAsync() .

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

deleteModel

Deletes a Model.

A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteModelAsync() .

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

deleteModelVersion

Deletes a Model version.

Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteModelVersionAsync() .

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

exportModel

Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::exportModelAsync() .

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

getModel

Gets a Model.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getModelAsync() .

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

getModelEvaluation

Gets a ModelEvaluation.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getModelEvaluationAsync() .

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

getModelEvaluationSlice

Gets a ModelEvaluationSlice.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getModelEvaluationSliceAsync() .

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

importModelEvaluation

Imports an externally generated ModelEvaluation.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::importModelEvaluationAsync() .

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

listModelEvaluationSlices

Lists ModelEvaluationSlices in a ModelEvaluation.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listModelEvaluationSlicesAsync() .

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

listModelEvaluations

Lists ModelEvaluations in a Model.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listModelEvaluationsAsync() .

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

listModelVersions

Lists versions of the specified model.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listModelVersionsAsync() .

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

listModels

Lists Models in a Location.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listModelsAsync() .

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

mergeVersionAliases

Merges a set of aliases for a Model version.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::mergeVersionAliasesAsync() .

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

updateModel

Updates a Model.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::updateModelAsync() .

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

uploadModel

Uploads a Model artifact into Vertex AI.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::uploadModelAsync() .

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

getLocation

Gets information about a location.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::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`

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::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`

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\BaseClient\self::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`

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\BaseClient\self::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`

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\BaseClient\self::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`

batchImportEvaluatedAnnotationsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

batchImportModelEvaluationSlicesAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

copyModelAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteModelAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteModelVersionAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

exportModelAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getModelAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getModelEvaluationAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getModelEvaluationSliceAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

importModelEvaluationAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listModelEvaluationSlicesAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listModelEvaluationsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listModelVersionsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listModelsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

mergeVersionAliasesAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateModelAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

uploadModelAsync

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

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`endpoint`	`string`

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

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`model`	`string`

Returns
Type	Description
`string`	The formatted model resource.

static::modelEvaluationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`model`	`string`
`evaluation`	`string`

Returns
Type	Description
`string`	The formatted model_evaluation resource.

static::modelEvaluationSliceName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`model`	`string`
`evaluation`	`string`
`slice`	`string`

Returns
Type	Description
`string`	The formatted model_evaluation_slice resource.

static::pipelineJobName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`pipelineJob`	`string`

Returns
Type	Description
`string`	The formatted pipeline_job resource.

static::projectLocationEndpointName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`endpoint`	`string`

Returns
Type	Description
`string`	The formatted project_location_endpoint resource.

static::projectLocationPublisherModelName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`publisher`	`string`
`model`	`string`

Returns
Type	Description
`string`	The formatted project_location_publisher_model resource.

static::trainingPipelineName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`trainingPipeline`	`string`

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

endpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
location: projects/{project}/locations/{location}
model: projects/{project}/locations/{location}/models/{model}
modelEvaluation: projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}
modelEvaluationSlice: projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}
pipelineJob: projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}
projectLocationEndpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
projectLocationPublisherModel: projects/{project}/locations/{location}/publishers/{publisher}/models/{model}
trainingPipeline: projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}

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.