- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class MetadataServiceClient.
Service Description: Service for reading and writing metadata entries.
This class is currently experimental and may be subject to changes.
Methods
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
artifactName
Formats a string containing the fully-qualified path to represent a artifact resource.
project
string
location
string
metadataStore
string
artifact
string
string
contextName
Formats a string containing the fully-qualified path to represent a context resource.
project
string
location
string
metadataStore
string
context
string
string
executionName
Formats a string containing the fully-qualified path to represent a execution resource.
project
string
location
string
metadataStore
string
execution
string
string
locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
metadataSchemaName
Formats a string containing the fully-qualified path to represent a metadata_schema resource.
project
string
location
string
metadataStore
string
metadataSchema
string
string
metadataStoreName
Formats a string containing the fully-qualified path to represent a metadata_store resource.
project
string
location
string
metadataStore
string
string
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
- artifact: projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}
- context: projects/{project}/locations/{location}/metadataStores/{metadata_store}/contexts/{context}
- execution: projects/{project}/locations/{location}/metadataStores/{metadata_store}/executions/{execution}
- location: projects/{project}/locations/{location}
- metadataSchema: projects/{project}/locations/{location}/metadataStores/{metadata_store}/metadataSchemas/{metadata_schema}
- metadataStore: projects/{project}/locations/{location}/metadataStores/{metadata_store}
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
__construct
Constructor.
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.
__call
Handles execution of the async variants for each documented method.
method
mixed
args
mixed
addContextArtifactsAndExecutions
Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::addContextArtifactsAndExecutionsAsync() .
request
Google\Cloud\AIPlatform\V1\AddContextArtifactsAndExecutionsRequest
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.
addContextChildren
Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::addContextChildrenAsync() .
request
Google\Cloud\AIPlatform\V1\AddContextChildrenRequest
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.
addExecutionEvents
Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::addExecutionEventsAsync() .
request
Google\Cloud\AIPlatform\V1\AddExecutionEventsRequest
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.
createArtifact
Creates an Artifact associated with a MetadataStore.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createArtifactAsync() .
request
Google\Cloud\AIPlatform\V1\CreateArtifactRequest
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.
createContext
Creates a Context associated with a MetadataStore.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createContextAsync() .
request
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.
createExecution
Creates an Execution associated with a MetadataStore.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createExecutionAsync() .
request
Google\Cloud\AIPlatform\V1\CreateExecutionRequest
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.
createMetadataSchema
Creates a MetadataSchema.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createMetadataSchemaAsync() .
request
Google\Cloud\AIPlatform\V1\CreateMetadataSchemaRequest
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.
createMetadataStore
Initializes a MetadataStore, including allocation of resources.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::createMetadataStoreAsync() .
request
Google\Cloud\AIPlatform\V1\CreateMetadataStoreRequest
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.
deleteArtifact
Deletes an Artifact.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteArtifactAsync() .
request
Google\Cloud\AIPlatform\V1\DeleteArtifactRequest
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.
deleteContext
Deletes a stored Context.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteContextAsync() .
request
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.
deleteExecution
Deletes an Execution.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteExecutionAsync() .
request
Google\Cloud\AIPlatform\V1\DeleteExecutionRequest
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.
deleteMetadataStore
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::deleteMetadataStoreAsync() .
request
Google\Cloud\AIPlatform\V1\DeleteMetadataStoreRequest
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.
getArtifact
Retrieves a specific Artifact.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getArtifactAsync() .
request
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.
getContext
Retrieves a specific Context.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getContextAsync() .
request
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.
getExecution
Retrieves a specific Execution.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getExecutionAsync() .
request
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.
getMetadataSchema
Retrieves a specific MetadataSchema.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getMetadataSchemaAsync() .
request
Google\Cloud\AIPlatform\V1\GetMetadataSchemaRequest
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.
getMetadataStore
Retrieves a specific MetadataStore.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getMetadataStoreAsync() .
request
Google\Cloud\AIPlatform\V1\GetMetadataStoreRequest
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.
listArtifacts
Lists Artifacts in the MetadataStore.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listArtifactsAsync() .
request
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.
listContexts
Lists Contexts on the MetadataStore.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listContextsAsync() .
request
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.
listExecutions
Lists Executions in the MetadataStore.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listExecutionsAsync() .
request
Google\Cloud\AIPlatform\V1\ListExecutionsRequest
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.
listMetadataSchemas
Lists MetadataSchemas.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listMetadataSchemasAsync() .
request
Google\Cloud\AIPlatform\V1\ListMetadataSchemasRequest
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.
listMetadataStores
Lists MetadataStores for a Location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listMetadataStoresAsync() .
request
Google\Cloud\AIPlatform\V1\ListMetadataStoresRequest
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.
purgeArtifacts
Purges Artifacts.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::purgeArtifactsAsync() .
request
Google\Cloud\AIPlatform\V1\PurgeArtifactsRequest
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.
purgeContexts
Purges Contexts.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::purgeContextsAsync() .
request
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.
purgeExecutions
Purges Executions.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::purgeExecutionsAsync() .
request
Google\Cloud\AIPlatform\V1\PurgeExecutionsRequest
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.
queryArtifactLineageSubgraph
Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::queryArtifactLineageSubgraphAsync() .
request
Google\Cloud\AIPlatform\V1\QueryArtifactLineageSubgraphRequest
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.
queryContextLineageSubgraph
Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::queryContextLineageSubgraphAsync() .
request
Google\Cloud\AIPlatform\V1\QueryContextLineageSubgraphRequest
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.
queryExecutionInputsAndOutputs
Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::queryExecutionInputsAndOutputsAsync() .
request
Google\Cloud\AIPlatform\V1\QueryExecutionInputsAndOutputsRequest
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.
removeContextChildren
Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::removeContextChildrenAsync() .
request
Google\Cloud\AIPlatform\V1\RemoveContextChildrenRequest
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.
updateArtifact
Updates a stored Artifact.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::updateArtifactAsync() .
request
Google\Cloud\AIPlatform\V1\UpdateArtifactRequest
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.
updateContext
Updates a stored Context.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::updateContextAsync() .
request
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.
updateExecution
Updates a stored Execution.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::updateExecutionAsync() .
request
Google\Cloud\AIPlatform\V1\UpdateExecutionRequest
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.
getLocation
Gets information about a location.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::getLocationAsync() .
request
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.
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\AIPlatform\V1\Client\BaseClient\self::listLocationsAsync() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
