1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Aiplatform
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsMetadataStoresContexts

ProjectsLocationsMetadataStoresContexts

class ProjectsLocationsMetadataStoresContexts extends Resource (View source)

The "contexts" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $contexts = $aiplatformService->projects_locations_metadataStores_contexts;

Methods

GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse
addContextArtifactsAndExecutions(string $context, GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest $postBody, array $optParams = [])

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.

GoogleCloudAiplatformV1AddContextChildrenResponse
addContextChildren(string $context, GoogleCloudAiplatformV1AddContextChildrenRequest $postBody, array $optParams = [])

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.

GoogleCloudAiplatformV1Context
create(string $parent, GoogleCloudAiplatformV1Context $postBody, array $optParams = [])

Creates a Context associated with a MetadataStore. (contexts.create)

GoogleLongrunningOperation
delete(string $name, array $optParams = [])

Deletes a stored Context. (contexts.delete)

GoogleCloudAiplatformV1Context
get(string $name, array $optParams = [])

Retrieves a specific Context. (contexts.get)

GoogleCloudAiplatformV1ListContextsResponse
listProjectsLocationsMetadataStoresContexts(string $parent, array $optParams = [])

Lists Contexts on the MetadataStore.

GoogleCloudAiplatformV1Context
patch(string $name, GoogleCloudAiplatformV1Context $postBody, array $optParams = [])

Updates a stored Context. (contexts.patch)

GoogleLongrunningOperation
purge(string $parent, GoogleCloudAiplatformV1PurgeContextsRequest $postBody, array $optParams = [])

Purges Contexts. (contexts.purge)

GoogleCloudAiplatformV1LineageSubgraph
queryContextLineageSubgraph(string $context, array $optParams = [])

Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.

GoogleCloudAiplatformV1RemoveContextChildrenResponse
removeContextChildren(string $context, GoogleCloudAiplatformV1RemoveContextChildrenRequest $postBody, array $optParams = [])

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.

Details

at line 55
GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse addContextArtifactsAndExecutions(string $context, GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest $postBody, array $optParams = [])

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.

(contexts.addContextArtifactsAndExecutions)

Parameters

string $context

Required. The resource name of the Context that the Artifacts and Executions belong to. Format: projects/{project}/locations/{lo cation}/metadataStores/{metadatastore}/contexts/{context}
GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse

Exceptions

Exception

at line 76
GoogleCloudAiplatformV1AddContextChildrenResponse addContextChildren(string $context, GoogleCloudAiplatformV1AddContextChildrenRequest $postBody, array $optParams = [])

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.

(contexts.addContextChildren)

Parameters

string $context

Required. The resource name of the parent Context. Format: projects/{project}/locations/{location}/metadataStores/{metadatastor e}/contexts/{context}
GoogleCloudAiplatformV1AddContextChildrenRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1AddContextChildrenResponse

Exceptions

Exception

at line 101
GoogleCloudAiplatformV1Context create(string $parent, GoogleCloudAiplatformV1Context $postBody, array $optParams = [])

Creates a Context associated with a MetadataStore. (contexts.create)

Parameters

string $parent

Required. The resource name of the MetadataStore where the Context should be created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
GoogleCloudAiplatformV1Context $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Context

Exceptions

Exception

at line 123
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a stored Context. (contexts.delete)

Parameters

string $name

Required. The resource name of the Context to delete. Format: projects/{project}/locations/{location}/metadataStores/{metadatastor e}/contexts/{context}
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 139
GoogleCloudAiplatformV1Context get(string $name, array $optParams = [])

Retrieves a specific Context. (contexts.get)

Parameters

string $name

Required. The resource name of the Context to retrieve. Format: projects/{project}/locations/{location}/metadataStores/{metadatastor e}/contexts/{context}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Context

Exceptions

Exception

at line 189
GoogleCloudAiplatformV1ListContextsResponse listProjectsLocationsMetadataStoresContexts(string $parent, array $optParams = [])

Lists Contexts on the MetadataStore.

(contexts.listProjectsLocationsMetadataStoresContexts)

Parameters

string $parent

Required. The MetadataStore whose Contexts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListContextsResponse

Exceptions

Exception

at line 209
GoogleCloudAiplatformV1Context patch(string $name, GoogleCloudAiplatformV1Context $postBody, array $optParams = [])

Updates a stored Context. (contexts.patch)

Parameters

string $name

Immutable. The resource name of the Context.
GoogleCloudAiplatformV1Context $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Context

Exceptions

Exception

at line 226
GoogleLongrunningOperation purge(string $parent, GoogleCloudAiplatformV1PurgeContextsRequest $postBody, array $optParams = [])

Purges Contexts. (contexts.purge)

Parameters

string $parent

Required. The metadata store to purge Contexts from. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
GoogleCloudAiplatformV1PurgeContextsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 247
GoogleCloudAiplatformV1LineageSubgraph queryContextLineageSubgraph(string $context, array $optParams = [])

Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.

(contexts.queryContextLineageSubgraph)

Parameters

string $context

Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: p rojects/{project}/locations/{location}/metadataStores/{metadatastore}/context s/{context} The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1LineageSubgraph

Exceptions

Exception

at line 266
GoogleCloudAiplatformV1RemoveContextChildrenResponse removeContextChildren(string $context, GoogleCloudAiplatformV1RemoveContextChildrenRequest $postBody, array $optParams = [])

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.

(contexts.removeContextChildren)

Parameters

string $context

Required. The resource name of the parent Context. Format: projects/{project}/locations/{location}/metadataStores/{metadatastor e}/contexts/{context}
GoogleCloudAiplatformV1RemoveContextChildrenRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1RemoveContextChildrenResponse

Exceptions

Exception