Class MetadataServiceClient (2.23.0-rc)

Service for reading and writing metadata entries.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

MetadataServiceClient(MetadataServiceClient const &)

Copy and move support

Parameter
Name	Description
	`MetadataServiceClient const &`

MetadataServiceClient(MetadataServiceClient &&)

Copy and move support

Parameter
Name	Description
	`MetadataServiceClient &&`

MetadataServiceClient(std::shared_ptr< MetadataServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< MetadataServiceConnection >`
`opts`	`Options`

Operators

operator=(MetadataServiceClient const &)

Copy and move support

Parameter
Name	Description
	`MetadataServiceClient const &`

Returns
Type	Description
`MetadataServiceClient &`

operator=(MetadataServiceClient &&)

Copy and move support

Parameter
Name	Description
	`MetadataServiceClient &&`

Returns
Type	Description
`MetadataServiceClient &`

Functions

CreateMetadataStore(std::string const &, google::cloud::aiplatform::v1::MetadataStore const &, std::string const &, Options)

Initializes a MetadataStore, including allocation of resources.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`
`metadata_store`	`google::cloud::aiplatform::v1::MetadataStore const &` Required. The MetadataStore to create.
`metadata_store_id`	`std::string const &` The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::MetadataStore > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.MetadataStore proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateMetadataStore(google::cloud::aiplatform::v1::CreateMetadataStoreRequest const &, Options)

Initializes a MetadataStore, including allocation of resources.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::CreateMetadataStoreRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateMetadataStoreRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::MetadataStore > >

GetMetadataStore(std::string const &, Options)

Retrieves a specific MetadataStore.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::MetadataStore >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.MetadataStore) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetMetadataStore(google::cloud::aiplatform::v1::GetMetadataStoreRequest const &, Options)

Retrieves a specific MetadataStore.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::GetMetadataStoreRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetMetadataStoreRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::MetadataStore >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.MetadataStore) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListMetadataStores(std::string const &, Options)

Lists MetadataStores for a Location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::MetadataStore >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.MetadataStore, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMetadataStores(google::cloud::aiplatform::v1::ListMetadataStoresRequest, Options)

Lists MetadataStores for a Location.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::ListMetadataStoresRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListMetadataStoresRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::MetadataStore >

DeleteMetadataStore(std::string const &, Options)

Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteMetadataStoreOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteMetadataStoreOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteMetadataStore(google::cloud::aiplatform::v1::DeleteMetadataStoreRequest const &, Options)

Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::DeleteMetadataStoreRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteMetadataStoreRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteMetadataStoreOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteMetadataStoreOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateArtifact(std::string const &, google::cloud::aiplatform::v1::Artifact const &, std::string const &, Options)

Creates an Artifact associated with a MetadataStore.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`artifact`	`google::cloud::aiplatform::v1::Artifact const &` Required. The Artifact to create.
`artifact_id`	`std::string const &` The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Artifact >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Artifact) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateArtifact(google::cloud::aiplatform::v1::CreateArtifactRequest const &, Options)

Creates an Artifact associated with a MetadataStore.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::CreateArtifactRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateArtifactRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Artifact >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Artifact) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetArtifact(std::string const &, Options)

Retrieves a specific Artifact.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Artifact >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Artifact) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetArtifact(google::cloud::aiplatform::v1::GetArtifactRequest const &, Options)

Retrieves a specific Artifact.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::GetArtifactRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetArtifactRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Artifact >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Artifact) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListArtifacts(std::string const &, Options)

Lists Artifacts in the MetadataStore.

Parameters
Name	Description
`parent`	`std::string const &` Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::Artifact >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.Artifact, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListArtifacts(google::cloud::aiplatform::v1::ListArtifactsRequest, Options)

Lists Artifacts in the MetadataStore.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::ListArtifactsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListArtifactsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::Artifact >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.Artifact, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateArtifact(google::cloud::aiplatform::v1::Artifact const &, google::protobuf::FieldMask const &, Options)

Updates a stored Artifact.

Parameters
Name	Description
`artifact`	`google::cloud::aiplatform::v1::Artifact const &` Required. The Artifact containing updates. The Artifact's Artifact.name field is used to identify the Artifact to be updated. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
`update_mask`	`google::protobuf::FieldMask const &` Optional. A FieldMask indicating which fields should be updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Artifact >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Artifact) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateArtifact(google::cloud::aiplatform::v1::UpdateArtifactRequest const &, Options)

Updates a stored Artifact.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::UpdateArtifactRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateArtifactRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Artifact >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Artifact) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteArtifact(std::string const &, Options)

Deletes an Artifact.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteArtifact(google::cloud::aiplatform::v1::DeleteArtifactRequest const &, Options)

Deletes an Artifact.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::DeleteArtifactRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteArtifactRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PurgeArtifacts(std::string const &, Options)

Purges Artifacts.

Parameters
Name	Description
`parent`	`std::string const &` Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::PurgeArtifactsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PurgeArtifactsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PurgeArtifacts(google::cloud::aiplatform::v1::PurgeArtifactsRequest const &, Options)

Purges Artifacts.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::PurgeArtifactsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.PurgeArtifactsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::PurgeArtifactsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PurgeArtifactsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateContext(std::string const &, google::cloud::aiplatform::v1::Context const &, std::string const &, Options)

Creates a Context associated with a MetadataStore.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`context`	`google::cloud::aiplatform::v1::Context const &` Required. The Context to create.
`context_id`	`std::string const &` The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Context >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateContext(google::cloud::aiplatform::v1::CreateContextRequest const &, Options)

Creates a Context associated with a MetadataStore.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::CreateContextRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateContextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Context >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetContext(std::string const &, Options)

Retrieves a specific Context.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Context >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetContext(google::cloud::aiplatform::v1::GetContextRequest const &, Options)

Retrieves a specific Context.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::GetContextRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetContextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Context >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListContexts(std::string const &, Options)

Lists Contexts on the MetadataStore.

Parameters
Name	Description
`parent`	`std::string const &` Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::Context >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.Context, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListContexts(google::cloud::aiplatform::v1::ListContextsRequest, Options)

Lists Contexts on the MetadataStore.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::ListContextsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListContextsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::Context >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.Context, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateContext(google::cloud::aiplatform::v1::Context const &, google::protobuf::FieldMask const &, Options)

Updates a stored Context.

Parameters
Name	Description
`context`	`google::cloud::aiplatform::v1::Context const &` Required. The Context containing updates. The Context's Context.name field is used to identify the Context to be updated. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
`update_mask`	`google::protobuf::FieldMask const &` Optional. A FieldMask indicating which fields should be updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Context >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateContext(google::cloud::aiplatform::v1::UpdateContextRequest const &, Options)

Updates a stored Context.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::UpdateContextRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateContextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Context >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Context) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteContext(std::string const &, Options)

Deletes a stored Context.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteContext(google::cloud::aiplatform::v1::DeleteContextRequest const &, Options)

Deletes a stored Context.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::DeleteContextRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteContextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PurgeContexts(std::string const &, Options)

Purges Contexts.

Parameters
Name	Description
`parent`	`std::string const &` Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::PurgeContextsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PurgeContextsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PurgeContexts(google::cloud::aiplatform::v1::PurgeContextsRequest const &, Options)

Purges Contexts.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::PurgeContextsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.PurgeContextsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::PurgeContextsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PurgeContextsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AddContextArtifactsAndExecutions(std::string const &, std::vector< std::string > const &, std::vector< std::string > const &, Options)

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.

Parameters
Name	Description
`context`	`std::string const &` Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
`artifacts`	`std::vector< std::string > const &` The resource names of the Artifacts to attribute to the Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`
`executions`	`std::vector< std::string > const &` The resource names of the Executions to associate with the Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::AddContextArtifactsAndExecutionsResponse >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.AddContextArtifactsAndExecutionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

AddContextArtifactsAndExecutions(google::cloud::aiplatform::v1::AddContextArtifactsAndExecutionsRequest const &, Options)

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.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::AddContextArtifactsAndExecutionsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.AddContextArtifactsAndExecutionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::AddContextArtifactsAndExecutionsResponse >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.AddContextArtifactsAndExecutionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

AddContextChildren(std::string const &, std::vector< std::string > const &, Options)

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.

Parameters
Name	Description
`context`	`std::string const &` Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
`child_contexts`	`std::vector< std::string > const &` The resource names of the child Contexts.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::AddContextChildrenResponse >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.AddContextChildrenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

AddContextChildren(google::cloud::aiplatform::v1::AddContextChildrenRequest const &, Options)

Adds a set of Contexts as children to a parent Context.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::AddContextChildrenRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.AddContextChildrenRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::AddContextChildrenResponse >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.AddContextChildrenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RemoveContextChildren(std::string const &, std::vector< std::string > const &, Options)

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.

Parameters
Name	Description
`context`	`std::string const &` Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`
`child_contexts`	`std::vector< std::string > const &` The resource names of the child Contexts.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::RemoveContextChildrenResponse >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.RemoveContextChildrenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RemoveContextChildren(google::cloud::aiplatform::v1::RemoveContextChildrenRequest const &, Options)

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.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::RemoveContextChildrenRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.RemoveContextChildrenRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::RemoveContextChildrenResponse >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.RemoveContextChildrenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

QueryContextLineageSubgraph(std::string const &, Options)

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

Parameters
Name	Description
`context`	`std::string const &` Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::LineageSubgraph >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.LineageSubgraph) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

QueryContextLineageSubgraph(google::cloud::aiplatform::v1::QueryContextLineageSubgraphRequest const &, Options)

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

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::QueryContextLineageSubgraphRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.QueryContextLineageSubgraphRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::LineageSubgraph >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.LineageSubgraph) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateExecution(std::string const &, google::cloud::aiplatform::v1::Execution const &, std::string const &, Options)

Creates an Execution associated with a MetadataStore.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`execution`	`google::cloud::aiplatform::v1::Execution const &` Required. The Execution to create.
`execution_id`	`std::string const &` The {execution} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Execution >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateExecution(google::cloud::aiplatform::v1::CreateExecutionRequest const &, Options)

Creates an Execution associated with a MetadataStore.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::CreateExecutionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateExecutionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Execution >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetExecution(std::string const &, Options)

Retrieves a specific Execution.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Execution >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetExecution(google::cloud::aiplatform::v1::GetExecutionRequest const &, Options)

Retrieves a specific Execution.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::GetExecutionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetExecutionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Execution >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListExecutions(std::string const &, Options)

Lists Executions in the MetadataStore.

Parameters
Name	Description
`parent`	`std::string const &` Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::Execution >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.Execution, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListExecutions(google::cloud::aiplatform::v1::ListExecutionsRequest, Options)

Lists Executions in the MetadataStore.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::ListExecutionsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListExecutionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::Execution >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.Execution, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateExecution(google::cloud::aiplatform::v1::Execution const &, google::protobuf::FieldMask const &, Options)

Updates a stored Execution.

Parameters
Name	Description
`execution`	`google::cloud::aiplatform::v1::Execution const &` Required. The Execution containing updates. The Execution's Execution.name field is used to identify the Execution to be updated. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
`update_mask`	`google::protobuf::FieldMask const &` Optional. A FieldMask indicating which fields should be updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Execution >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateExecution(google::cloud::aiplatform::v1::UpdateExecutionRequest const &, Options)

Updates a stored Execution.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::UpdateExecutionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateExecutionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::Execution >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Execution) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteExecution(std::string const &, Options)

Deletes an Execution.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteExecution(google::cloud::aiplatform::v1::DeleteExecutionRequest const &, Options)

Deletes an Execution.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::DeleteExecutionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteExecutionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PurgeExecutions(std::string const &, Options)

Purges Executions.

Parameters
Name	Description
`parent`	`std::string const &` Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::PurgeExecutionsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PurgeExecutionsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

PurgeExecutions(google::cloud::aiplatform::v1::PurgeExecutionsRequest const &, Options)

Purges Executions.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::PurgeExecutionsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.PurgeExecutionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::aiplatform::v1::PurgeExecutionsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.PurgeExecutionsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AddExecutionEvents(std::string const &, std::vector< google::cloud::aiplatform::v1::Event > const &, Options)

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.

Parameters
Name	Description
`execution`	`std::string const &` Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
`events`	`std::vector< google::cloud::aiplatform::v1::Event > const &` The Events to create and add.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::AddExecutionEventsResponse >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.AddExecutionEventsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

AddExecutionEvents(google::cloud::aiplatform::v1::AddExecutionEventsRequest const &, Options)

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.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::AddExecutionEventsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.AddExecutionEventsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::AddExecutionEventsResponse >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.AddExecutionEventsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

QueryExecutionInputsAndOutputs(std::string const &, Options)

Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.

Parameters
Name	Description
`execution`	`std::string const &` Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::LineageSubgraph >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.LineageSubgraph) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

QueryExecutionInputsAndOutputs(google::cloud::aiplatform::v1::QueryExecutionInputsAndOutputsRequest const &, Options)

Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::QueryExecutionInputsAndOutputsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.QueryExecutionInputsAndOutputsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::LineageSubgraph >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.LineageSubgraph) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateMetadataSchema(std::string const &, google::cloud::aiplatform::v1::MetadataSchema const &, std::string const &, Options)

Creates a MetadataSchema.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`metadata_schema`	`google::cloud::aiplatform::v1::MetadataSchema const &` Required. The MetadataSchema to create.
`metadata_schema_id`	`std::string const &` The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/[a-z][0-9]-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::MetadataSchema >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.MetadataSchema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateMetadataSchema(google::cloud::aiplatform::v1::CreateMetadataSchemaRequest const &, Options)

Creates a MetadataSchema.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::CreateMetadataSchemaRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateMetadataSchemaRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::MetadataSchema >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.MetadataSchema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetMetadataSchema(std::string const &, Options)

Retrieves a specific MetadataSchema.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::MetadataSchema >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.MetadataSchema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetMetadataSchema(google::cloud::aiplatform::v1::GetMetadataSchemaRequest const &, Options)

Retrieves a specific MetadataSchema.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::GetMetadataSchemaRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetMetadataSchemaRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::MetadataSchema >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.MetadataSchema) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListMetadataSchemas(std::string const &, Options)

Lists MetadataSchemas.

Parameters
Name	Description
`parent`	`std::string const &` Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::MetadataSchema >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.MetadataSchema, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMetadataSchemas(google::cloud::aiplatform::v1::ListMetadataSchemasRequest, Options)

Lists MetadataSchemas.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::ListMetadataSchemasRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListMetadataSchemasRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::aiplatform::v1::MetadataSchema >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.MetadataSchema, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

QueryArtifactLineageSubgraph(std::string const &, Options)

Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.

Parameters
Name	Description
`artifact`	`std::string const &` Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::LineageSubgraph >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.LineageSubgraph) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

QueryArtifactLineageSubgraph(google::cloud::aiplatform::v1::QueryArtifactLineageSubgraphRequest const &, Options)

Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.

Parameters
Name	Description
`request`	`google::cloud::aiplatform::v1::QueryArtifactLineageSubgraphRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.QueryArtifactLineageSubgraphRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::aiplatform::v1::LineageSubgraph >`	the result of the RPC. The response message type (google.cloud.aiplatform.v1.LineageSubgraph) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.