Vertex AI v1 API - Class MetadataServiceClientImpl (3.50.0) 

public sealed class MetadataServiceClientImpl : MetadataServiceClient

Reference documentation and code samples for the Vertex AI v1 API class MetadataServiceClientImpl.

MetadataService client wrapper implementation, for convenient use.

Inheritance

object > MetadataServiceClient > MetadataServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

Service for reading and writing metadata entries.

Constructors

MetadataServiceClientImpl(MetadataServiceClient, MetadataServiceSettings, ILogger)

public MetadataServiceClientImpl(MetadataService.MetadataServiceClient grpcClient, MetadataServiceSettings settings, ILogger logger)

Constructs a client wrapper for the MetadataService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient MetadataServiceMetadataServiceClient

The underlying gRPC client.
settings MetadataServiceSettings

The base MetadataServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateMetadataStoreOperationsClient

public override OperationsClient CreateMetadataStoreOperationsClient { get; }

The long-running operations client for CreateMetadataStore.

Property Value
Type Description
OperationsClient
Overrides

DeleteArtifactOperationsClient

public override OperationsClient DeleteArtifactOperationsClient { get; }

The long-running operations client for DeleteArtifact.

Property Value
Type Description
OperationsClient
Overrides

DeleteContextOperationsClient

public override OperationsClient DeleteContextOperationsClient { get; }

The long-running operations client for DeleteContext.

Property Value
Type Description
OperationsClient
Overrides

DeleteExecutionOperationsClient

public override OperationsClient DeleteExecutionOperationsClient { get; }

The long-running operations client for DeleteExecution.

Property Value
Type Description
OperationsClient
Overrides

DeleteMetadataStoreOperationsClient

public override OperationsClient DeleteMetadataStoreOperationsClient { get; }

The long-running operations client for DeleteMetadataStore.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override MetadataService.MetadataServiceClient GrpcClient { get; }

The underlying gRPC MetadataService client

Property Value
Type Description
MetadataServiceMetadataServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

PurgeArtifactsOperationsClient

public override OperationsClient PurgeArtifactsOperationsClient { get; }

The long-running operations client for PurgeArtifacts.

Property Value
Type Description
OperationsClient
Overrides

PurgeContextsOperationsClient

public override OperationsClient PurgeContextsOperationsClient { get; }

The long-running operations client for PurgeContexts.

Property Value
Type Description
OperationsClient
Overrides

PurgeExecutionsOperationsClient

public override OperationsClient PurgeExecutionsOperationsClient { get; }

The long-running operations client for PurgeExecutions.

Property Value
Type Description
OperationsClient
Overrides

Methods

AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest, CallSettings)

public override AddContextArtifactsAndExecutionsResponse AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest request, CallSettings callSettings = null)

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 AddContextArtifactsAndExecutionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AddContextArtifactsAndExecutionsResponse

The RPC response.
Overrides

AddContextArtifactsAndExecutionsAsync(AddContextArtifactsAndExecutionsRequest, CallSettings)

public override Task<AddContextArtifactsAndExecutionsResponse> AddContextArtifactsAndExecutionsAsync(AddContextArtifactsAndExecutionsRequest request, CallSettings callSettings = null)

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 AddContextArtifactsAndExecutionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAddContextArtifactsAndExecutionsResponse

A Task containing the RPC response.
Overrides

AddContextChildren(AddContextChildrenRequest, CallSettings)

public override AddContextChildrenResponse AddContextChildren(AddContextChildrenRequest request, CallSettings callSettings = null)

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 AddContextChildrenRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AddContextChildrenResponse

The RPC response.
Overrides

AddContextChildrenAsync(AddContextChildrenRequest, CallSettings)

public override Task<AddContextChildrenResponse> AddContextChildrenAsync(AddContextChildrenRequest request, CallSettings callSettings = null)

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 AddContextChildrenRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAddContextChildrenResponse

A Task containing the RPC response.
Overrides

AddExecutionEvents(AddExecutionEventsRequest, CallSettings)

public override AddExecutionEventsResponse AddExecutionEvents(AddExecutionEventsRequest request, CallSettings callSettings = null)

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 AddExecutionEventsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
AddExecutionEventsResponse

The RPC response.
Overrides

AddExecutionEventsAsync(AddExecutionEventsRequest, CallSettings)

public override Task<AddExecutionEventsResponse> AddExecutionEventsAsync(AddExecutionEventsRequest request, CallSettings callSettings = null)

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 AddExecutionEventsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskAddExecutionEventsResponse

A Task containing the RPC response.
Overrides

CreateArtifact(CreateArtifactRequest, CallSettings)

public override Artifact CreateArtifact(CreateArtifactRequest request, CallSettings callSettings = null)

Creates an Artifact associated with a MetadataStore.

Parameters
Name Description
request CreateArtifactRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Artifact

The RPC response.
Overrides

CreateArtifactAsync(CreateArtifactRequest, CallSettings)

public override Task<Artifact> CreateArtifactAsync(CreateArtifactRequest request, CallSettings callSettings = null)

Creates an Artifact associated with a MetadataStore.

Parameters
Name Description
request CreateArtifactRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskArtifact

A Task containing the RPC response.
Overrides

CreateContext(CreateContextRequest, CallSettings)

public override Context CreateContext(CreateContextRequest request, CallSettings callSettings = null)

Creates a Context associated with a MetadataStore.

Parameters
Name Description
request CreateContextRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Context

The RPC response.
Overrides

CreateContextAsync(CreateContextRequest, CallSettings)

public override Task<Context> CreateContextAsync(CreateContextRequest request, CallSettings callSettings = null)

Creates a Context associated with a MetadataStore.

Parameters
Name Description
request CreateContextRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskContext

A Task containing the RPC response.
Overrides

CreateExecution(CreateExecutionRequest, CallSettings)

public override Execution CreateExecution(CreateExecutionRequest request, CallSettings callSettings = null)

Creates an Execution associated with a MetadataStore.

Parameters
Name Description
request CreateExecutionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Execution

The RPC response.
Overrides

CreateExecutionAsync(CreateExecutionRequest, CallSettings)

public override Task<Execution> CreateExecutionAsync(CreateExecutionRequest request, CallSettings callSettings = null)

Creates an Execution associated with a MetadataStore.

Parameters
Name Description
request CreateExecutionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskExecution

A Task containing the RPC response.
Overrides

CreateMetadataSchema(CreateMetadataSchemaRequest, CallSettings)

public override MetadataSchema CreateMetadataSchema(CreateMetadataSchemaRequest request, CallSettings callSettings = null)

Creates a MetadataSchema.

Parameters
Name Description
request CreateMetadataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
MetadataSchema

The RPC response.
Overrides

CreateMetadataSchemaAsync(CreateMetadataSchemaRequest, CallSettings)

public override Task<MetadataSchema> CreateMetadataSchemaAsync(CreateMetadataSchemaRequest request, CallSettings callSettings = null)

Creates a MetadataSchema.

Parameters
Name Description
request CreateMetadataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskMetadataSchema

A Task containing the RPC response.
Overrides

CreateMetadataStore(CreateMetadataStoreRequest, CallSettings)

public override Operation<MetadataStore, CreateMetadataStoreOperationMetadata> CreateMetadataStore(CreateMetadataStoreRequest request, CallSettings callSettings = null)

Initializes a MetadataStore, including allocation of resources.

Parameters
Name Description
request CreateMetadataStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationMetadataStoreCreateMetadataStoreOperationMetadata

The RPC response.
Overrides

CreateMetadataStoreAsync(CreateMetadataStoreRequest, CallSettings)

public override Task<Operation<MetadataStore, CreateMetadataStoreOperationMetadata>> CreateMetadataStoreAsync(CreateMetadataStoreRequest request, CallSettings callSettings = null)

Initializes a MetadataStore, including allocation of resources.

Parameters
Name Description
request CreateMetadataStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationMetadataStoreCreateMetadataStoreOperationMetadata

A Task containing the RPC response.
Overrides

DeleteArtifact(DeleteArtifactRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteArtifact(DeleteArtifactRequest request, CallSettings callSettings = null)

Deletes an Artifact.

Parameters
Name Description
request DeleteArtifactRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteArtifactAsync(DeleteArtifactRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteArtifactAsync(DeleteArtifactRequest request, CallSettings callSettings = null)

Deletes an Artifact.

Parameters
Name Description
request DeleteArtifactRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteContext(DeleteContextRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteContext(DeleteContextRequest request, CallSettings callSettings = null)

Deletes a stored Context.

Parameters
Name Description
request DeleteContextRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteContextAsync(DeleteContextRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteContextAsync(DeleteContextRequest request, CallSettings callSettings = null)

Deletes a stored Context.

Parameters
Name Description
request DeleteContextRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteExecution(DeleteExecutionRequest, CallSettings)

public override Operation<Empty, DeleteOperationMetadata> DeleteExecution(DeleteExecutionRequest request, CallSettings callSettings = null)

Deletes an Execution.

Parameters
Name Description
request DeleteExecutionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteExecutionAsync(DeleteExecutionRequest, CallSettings)

public override Task<Operation<Empty, DeleteOperationMetadata>> DeleteExecutionAsync(DeleteExecutionRequest request, CallSettings callSettings = null)

Deletes an Execution.

Parameters
Name Description
request DeleteExecutionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

DeleteMetadataStore(DeleteMetadataStoreRequest, CallSettings)

public override Operation<Empty, DeleteMetadataStoreOperationMetadata> DeleteMetadataStore(DeleteMetadataStoreRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteMetadataStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteMetadataStoreOperationMetadata

The RPC response.
Overrides

DeleteMetadataStoreAsync(DeleteMetadataStoreRequest, CallSettings)

public override Task<Operation<Empty, DeleteMetadataStoreOperationMetadata>> DeleteMetadataStoreAsync(DeleteMetadataStoreRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteMetadataStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteMetadataStoreOperationMetadata

A Task containing the RPC response.
Overrides

GetArtifact(GetArtifactRequest, CallSettings)

public override Artifact GetArtifact(GetArtifactRequest request, CallSettings callSettings = null)

Retrieves a specific Artifact.

Parameters
Name Description
request GetArtifactRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Artifact

The RPC response.
Overrides

GetArtifactAsync(GetArtifactRequest, CallSettings)

public override Task<Artifact> GetArtifactAsync(GetArtifactRequest request, CallSettings callSettings = null)

Retrieves a specific Artifact.

Parameters
Name Description
request GetArtifactRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskArtifact

A Task containing the RPC response.
Overrides

GetContext(GetContextRequest, CallSettings)

public override Context GetContext(GetContextRequest request, CallSettings callSettings = null)

Retrieves a specific Context.

Parameters
Name Description
request GetContextRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Context

The RPC response.
Overrides

GetContextAsync(GetContextRequest, CallSettings)

public override Task<Context> GetContextAsync(GetContextRequest request, CallSettings callSettings = null)

Retrieves a specific Context.

Parameters
Name Description
request GetContextRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskContext

A Task containing the RPC response.
Overrides

GetExecution(GetExecutionRequest, CallSettings)

public override Execution GetExecution(GetExecutionRequest request, CallSettings callSettings = null)

Retrieves a specific Execution.

Parameters
Name Description
request GetExecutionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Execution

The RPC response.
Overrides

GetExecutionAsync(GetExecutionRequest, CallSettings)

public override Task<Execution> GetExecutionAsync(GetExecutionRequest request, CallSettings callSettings = null)

Retrieves a specific Execution.

Parameters
Name Description
request GetExecutionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskExecution

A Task containing the RPC response.
Overrides

GetMetadataSchema(GetMetadataSchemaRequest, CallSettings)

public override MetadataSchema GetMetadataSchema(GetMetadataSchemaRequest request, CallSettings callSettings = null)

Retrieves a specific MetadataSchema.

Parameters
Name Description
request GetMetadataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
MetadataSchema

The RPC response.
Overrides

GetMetadataSchemaAsync(GetMetadataSchemaRequest, CallSettings)

public override Task<MetadataSchema> GetMetadataSchemaAsync(GetMetadataSchemaRequest request, CallSettings callSettings = null)

Retrieves a specific MetadataSchema.

Parameters
Name Description
request GetMetadataSchemaRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskMetadataSchema

A Task containing the RPC response.
Overrides

GetMetadataStore(GetMetadataStoreRequest, CallSettings)

public override MetadataStore GetMetadataStore(GetMetadataStoreRequest request, CallSettings callSettings = null)

Retrieves a specific MetadataStore.

Parameters
Name Description
request GetMetadataStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
MetadataStore

The RPC response.
Overrides

GetMetadataStoreAsync(GetMetadataStoreRequest, CallSettings)

public override Task<MetadataStore> GetMetadataStoreAsync(GetMetadataStoreRequest request, CallSettings callSettings = null)

Retrieves a specific MetadataStore.

Parameters
Name Description
request GetMetadataStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskMetadataStore

A Task containing the RPC response.
Overrides

ListArtifacts(ListArtifactsRequest, CallSettings)

public override PagedEnumerable<ListArtifactsResponse, Artifact> ListArtifacts(ListArtifactsRequest request, CallSettings callSettings = null)

Lists Artifacts in the MetadataStore.

Parameters
Name Description
request ListArtifactsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListArtifactsResponseArtifact

A pageable sequence of Artifact resources.
Overrides

ListArtifactsAsync(ListArtifactsRequest, CallSettings)

public override PagedAsyncEnumerable<ListArtifactsResponse, Artifact> ListArtifactsAsync(ListArtifactsRequest request, CallSettings callSettings = null)

Lists Artifacts in the MetadataStore.

Parameters
Name Description
request ListArtifactsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListArtifactsResponseArtifact

A pageable asynchronous sequence of Artifact resources.
Overrides

ListContexts(ListContextsRequest, CallSettings)

public override PagedEnumerable<ListContextsResponse, Context> ListContexts(ListContextsRequest request, CallSettings callSettings = null)

Lists Contexts on the MetadataStore.

Parameters
Name Description
request ListContextsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListContextsResponseContext

A pageable sequence of Context resources.
Overrides

ListContextsAsync(ListContextsRequest, CallSettings)

public override PagedAsyncEnumerable<ListContextsResponse, Context> ListContextsAsync(ListContextsRequest request, CallSettings callSettings = null)

Lists Contexts on the MetadataStore.

Parameters
Name Description
request ListContextsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListContextsResponseContext

A pageable asynchronous sequence of Context resources.
Overrides

ListExecutions(ListExecutionsRequest, CallSettings)

public override PagedEnumerable<ListExecutionsResponse, Execution> ListExecutions(ListExecutionsRequest request, CallSettings callSettings = null)

Lists Executions in the MetadataStore.

Parameters
Name Description
request ListExecutionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListExecutionsResponseExecution

A pageable sequence of Execution resources.
Overrides

ListExecutionsAsync(ListExecutionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListExecutionsResponse, Execution> ListExecutionsAsync(ListExecutionsRequest request, CallSettings callSettings = null)

Lists Executions in the MetadataStore.

Parameters
Name Description
request ListExecutionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListExecutionsResponseExecution

A pageable asynchronous sequence of Execution resources.
Overrides

ListMetadataSchemas(ListMetadataSchemasRequest, CallSettings)

public override PagedEnumerable<ListMetadataSchemasResponse, MetadataSchema> ListMetadataSchemas(ListMetadataSchemasRequest request, CallSettings callSettings = null)

Lists MetadataSchemas.

Parameters
Name Description
request ListMetadataSchemasRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListMetadataSchemasResponseMetadataSchema

A pageable sequence of MetadataSchema resources.
Overrides

ListMetadataSchemasAsync(ListMetadataSchemasRequest, CallSettings)

public override PagedAsyncEnumerable<ListMetadataSchemasResponse, MetadataSchema> ListMetadataSchemasAsync(ListMetadataSchemasRequest request, CallSettings callSettings = null)

Lists MetadataSchemas.

Parameters
Name Description
request ListMetadataSchemasRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListMetadataSchemasResponseMetadataSchema

A pageable asynchronous sequence of MetadataSchema resources.
Overrides

ListMetadataStores(ListMetadataStoresRequest, CallSettings)

public override PagedEnumerable<ListMetadataStoresResponse, MetadataStore> ListMetadataStores(ListMetadataStoresRequest request, CallSettings callSettings = null)

Lists MetadataStores for a Location.

Parameters
Name Description
request ListMetadataStoresRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListMetadataStoresResponseMetadataStore

A pageable sequence of MetadataStore resources.
Overrides

ListMetadataStoresAsync(ListMetadataStoresRequest, CallSettings)

public override PagedAsyncEnumerable<ListMetadataStoresResponse, MetadataStore> ListMetadataStoresAsync(ListMetadataStoresRequest request, CallSettings callSettings = null)

Lists MetadataStores for a Location.

Parameters
Name Description
request ListMetadataStoresRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListMetadataStoresResponseMetadataStore

A pageable asynchronous sequence of MetadataStore resources.
Overrides

PurgeArtifacts(PurgeArtifactsRequest, CallSettings)

public override Operation<PurgeArtifactsResponse, PurgeArtifactsMetadata> PurgeArtifacts(PurgeArtifactsRequest request, CallSettings callSettings = null)

Purges Artifacts.

Parameters
Name Description
request PurgeArtifactsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationPurgeArtifactsResponsePurgeArtifactsMetadata

The RPC response.
Overrides

PurgeArtifactsAsync(PurgeArtifactsRequest, CallSettings)

public override Task<Operation<PurgeArtifactsResponse, PurgeArtifactsMetadata>> PurgeArtifactsAsync(PurgeArtifactsRequest request, CallSettings callSettings = null)

Purges Artifacts.

Parameters
Name Description
request PurgeArtifactsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationPurgeArtifactsResponsePurgeArtifactsMetadata

A Task containing the RPC response.
Overrides

PurgeContexts(PurgeContextsRequest, CallSettings)

public override Operation<PurgeContextsResponse, PurgeContextsMetadata> PurgeContexts(PurgeContextsRequest request, CallSettings callSettings = null)

Purges Contexts.

Parameters
Name Description
request PurgeContextsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationPurgeContextsResponsePurgeContextsMetadata

The RPC response.
Overrides

PurgeContextsAsync(PurgeContextsRequest, CallSettings)

public override Task<Operation<PurgeContextsResponse, PurgeContextsMetadata>> PurgeContextsAsync(PurgeContextsRequest request, CallSettings callSettings = null)

Purges Contexts.

Parameters
Name Description
request PurgeContextsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationPurgeContextsResponsePurgeContextsMetadata

A Task containing the RPC response.
Overrides

PurgeExecutions(PurgeExecutionsRequest, CallSettings)

public override Operation<PurgeExecutionsResponse, PurgeExecutionsMetadata> PurgeExecutions(PurgeExecutionsRequest request, CallSettings callSettings = null)

Purges Executions.

Parameters
Name Description
request PurgeExecutionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationPurgeExecutionsResponsePurgeExecutionsMetadata

The RPC response.
Overrides

PurgeExecutionsAsync(PurgeExecutionsRequest, CallSettings)

public override Task<Operation<PurgeExecutionsResponse, PurgeExecutionsMetadata>> PurgeExecutionsAsync(PurgeExecutionsRequest request, CallSettings callSettings = null)

Purges Executions.

Parameters
Name Description
request PurgeExecutionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationPurgeExecutionsResponsePurgeExecutionsMetadata

A Task containing the RPC response.
Overrides

QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest, CallSettings)

public override LineageSubgraph QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request QueryArtifactLineageSubgraphRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
LineageSubgraph

The RPC response.
Overrides

QueryArtifactLineageSubgraphAsync(QueryArtifactLineageSubgraphRequest, CallSettings)

public override Task<LineageSubgraph> QueryArtifactLineageSubgraphAsync(QueryArtifactLineageSubgraphRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request QueryArtifactLineageSubgraphRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskLineageSubgraph

A Task containing the RPC response.
Overrides

QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest, CallSettings)

public override LineageSubgraph QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request QueryContextLineageSubgraphRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
LineageSubgraph

The RPC response.
Overrides

QueryContextLineageSubgraphAsync(QueryContextLineageSubgraphRequest, CallSettings)

public override Task<LineageSubgraph> QueryContextLineageSubgraphAsync(QueryContextLineageSubgraphRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request QueryContextLineageSubgraphRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskLineageSubgraph

A Task containing the RPC response.
Overrides

QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest, CallSettings)

public override LineageSubgraph QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest request, CallSettings callSettings = null)

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 QueryExecutionInputsAndOutputsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
LineageSubgraph

The RPC response.
Overrides

QueryExecutionInputsAndOutputsAsync(QueryExecutionInputsAndOutputsRequest, CallSettings)

public override Task<LineageSubgraph> QueryExecutionInputsAndOutputsAsync(QueryExecutionInputsAndOutputsRequest request, CallSettings callSettings = null)

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 QueryExecutionInputsAndOutputsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskLineageSubgraph

A Task containing the RPC response.
Overrides

RemoveContextChildren(RemoveContextChildrenRequest, CallSettings)

public override RemoveContextChildrenResponse RemoveContextChildren(RemoveContextChildrenRequest request, CallSettings callSettings = null)

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 RemoveContextChildrenRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RemoveContextChildrenResponse

The RPC response.
Overrides

RemoveContextChildrenAsync(RemoveContextChildrenRequest, CallSettings)

public override Task<RemoveContextChildrenResponse> RemoveContextChildrenAsync(RemoveContextChildrenRequest request, CallSettings callSettings = null)

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 RemoveContextChildrenRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRemoveContextChildrenResponse

A Task containing the RPC response.
Overrides

UpdateArtifact(UpdateArtifactRequest, CallSettings)

public override Artifact UpdateArtifact(UpdateArtifactRequest request, CallSettings callSettings = null)

Updates a stored Artifact.

Parameters
Name Description
request UpdateArtifactRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Artifact

The RPC response.
Overrides

UpdateArtifactAsync(UpdateArtifactRequest, CallSettings)

public override Task<Artifact> UpdateArtifactAsync(UpdateArtifactRequest request, CallSettings callSettings = null)

Updates a stored Artifact.

Parameters
Name Description
request UpdateArtifactRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskArtifact

A Task containing the RPC response.
Overrides

UpdateContext(UpdateContextRequest, CallSettings)

public override Context UpdateContext(UpdateContextRequest request, CallSettings callSettings = null)

Updates a stored Context.

Parameters
Name Description
request UpdateContextRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Context

The RPC response.
Overrides

UpdateContextAsync(UpdateContextRequest, CallSettings)

public override Task<Context> UpdateContextAsync(UpdateContextRequest request, CallSettings callSettings = null)

Updates a stored Context.

Parameters
Name Description
request UpdateContextRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskContext

A Task containing the RPC response.
Overrides

UpdateExecution(UpdateExecutionRequest, CallSettings)

public override Execution UpdateExecution(UpdateExecutionRequest request, CallSettings callSettings = null)

Updates a stored Execution.

Parameters
Name Description
request UpdateExecutionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Execution

The RPC response.
Overrides

UpdateExecutionAsync(UpdateExecutionRequest, CallSettings)

public override Task<Execution> UpdateExecutionAsync(UpdateExecutionRequest request, CallSettings callSettings = null)

Updates a stored Execution.

Parameters
Name Description
request UpdateExecutionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskExecution

A Task containing the RPC response.
Overrides