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: |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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][google.cloud.aiplatform.v1.Artifact.name] field is used to identify the Artifact to be updated. Format: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
PurgeArtifacts(std::string const &, Options)
Purges Artifacts.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The metadata store to purge Artifacts from. Format: |
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 |
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 |
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 |
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: |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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][google.cloud.aiplatform.v1.Context.name] field is used to identify the Context to be updated. Format: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
PurgeContexts(std::string const &, Options)
Purges Contexts.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The metadata store to purge Contexts from. Format: |
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 |
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 |
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 |
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: |
artifacts |
std::vector< std::string > const &
The resource names of the Artifacts to attribute to the Context. |
executions |
std::vector< std::string > const &
The resource names of the Executions to associate with the Context. |
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 |
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 |
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 |
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. |
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 |
AddContextChildren(google::cloud::aiplatform::v1::AddContextChildrenRequest 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 |
request |
google::cloud::aiplatform::v1::AddContextChildrenRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
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. |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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][google.cloud.aiplatform.v1.Execution.name] field is used to identify the Execution to be updated. Format: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
PurgeExecutions(std::string const &, Options)
Purges Executions.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The metadata store to purge Executions from. Format: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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: |
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: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
ListMetadataSchemas(std::string const &, Options)
Lists MetadataSchemas.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The MetadataStore whose MetadataSchemas should be listed. Format: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |