Cloud AI Platform v1 API - Class MetadataService.MetadataServiceBase (3.12.0)

Version 3.12.0

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(MetadataService), "BindService")]
public abstract class MetadataService.MetadataServiceBase

Reference documentation and code samples for the Cloud AI Platform v1 API class MetadataService.MetadataServiceBase.

Base class for server-side implementations of MetadataService

Inheritance

object > MetadataService.MetadataServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Methods

AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest, ServerCallContext)

public virtual Task<AddContextArtifactsAndExecutionsResponse> AddContextArtifactsAndExecutions(AddContextArtifactsAndExecutionsRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAddContextArtifactsAndExecutionsResponse	The response to send back to the client (wrapped by a task).

AddContextChildren(AddContextChildrenRequest, ServerCallContext)

public virtual Task<AddContextChildrenResponse> AddContextChildren(AddContextChildrenRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAddContextChildrenResponse	The response to send back to the client (wrapped by a task).

AddExecutionEvents(AddExecutionEventsRequest, ServerCallContext)

public virtual Task<AddExecutionEventsResponse> AddExecutionEvents(AddExecutionEventsRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAddExecutionEventsResponse	The response to send back to the client (wrapped by a task).

CreateArtifact(CreateArtifactRequest, ServerCallContext)

public virtual Task<Artifact> CreateArtifact(CreateArtifactRequest request, ServerCallContext context)

Creates an Artifact associated with a MetadataStore.

Parameters
Name	Description
request	CreateArtifactRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskArtifact	The response to send back to the client (wrapped by a task).

CreateContext(CreateContextRequest, ServerCallContext)

public virtual Task<Context> CreateContext(CreateContextRequest request, ServerCallContext context)

Creates a Context associated with a MetadataStore.

Parameters
Name	Description
request	CreateContextRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskContext	The response to send back to the client (wrapped by a task).

CreateExecution(CreateExecutionRequest, ServerCallContext)

public virtual Task<Execution> CreateExecution(CreateExecutionRequest request, ServerCallContext context)

Creates an Execution associated with a MetadataStore.

Parameters
Name	Description
request	CreateExecutionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskExecution	The response to send back to the client (wrapped by a task).

CreateMetadataSchema(CreateMetadataSchemaRequest, ServerCallContext)

public virtual Task<MetadataSchema> CreateMetadataSchema(CreateMetadataSchemaRequest request, ServerCallContext context)

Creates a MetadataSchema.

Parameters
Name	Description
request	CreateMetadataSchemaRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskMetadataSchema	The response to send back to the client (wrapped by a task).

CreateMetadataStore(CreateMetadataStoreRequest, ServerCallContext)

public virtual Task<Operation> CreateMetadataStore(CreateMetadataStoreRequest request, ServerCallContext context)

Initializes a MetadataStore, including allocation of resources.

Parameters
Name	Description
request	CreateMetadataStoreRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteArtifact(DeleteArtifactRequest, ServerCallContext)

public virtual Task<Operation> DeleteArtifact(DeleteArtifactRequest request, ServerCallContext context)

Deletes an Artifact.

Parameters
Name	Description
request	DeleteArtifactRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteContext(DeleteContextRequest, ServerCallContext)

public virtual Task<Operation> DeleteContext(DeleteContextRequest request, ServerCallContext context)

Deletes a stored Context.

Parameters
Name	Description
request	DeleteContextRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteExecution(DeleteExecutionRequest, ServerCallContext)

public virtual Task<Operation> DeleteExecution(DeleteExecutionRequest request, ServerCallContext context)

Deletes an Execution.

Parameters
Name	Description
request	DeleteExecutionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteMetadataStore(DeleteMetadataStoreRequest, ServerCallContext)

public virtual Task<Operation> DeleteMetadataStore(DeleteMetadataStoreRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	DeleteMetadataStoreRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetArtifact(GetArtifactRequest, ServerCallContext)

public virtual Task<Artifact> GetArtifact(GetArtifactRequest request, ServerCallContext context)

Retrieves a specific Artifact.

Parameters
Name	Description
request	GetArtifactRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskArtifact	The response to send back to the client (wrapped by a task).

GetContext(GetContextRequest, ServerCallContext)

public virtual Task<Context> GetContext(GetContextRequest request, ServerCallContext context)

Retrieves a specific Context.

Parameters
Name	Description
request	GetContextRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskContext	The response to send back to the client (wrapped by a task).

GetExecution(GetExecutionRequest, ServerCallContext)

public virtual Task<Execution> GetExecution(GetExecutionRequest request, ServerCallContext context)

Retrieves a specific Execution.

Parameters
Name	Description
request	GetExecutionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskExecution	The response to send back to the client (wrapped by a task).

GetMetadataSchema(GetMetadataSchemaRequest, ServerCallContext)

public virtual Task<MetadataSchema> GetMetadataSchema(GetMetadataSchemaRequest request, ServerCallContext context)

Retrieves a specific MetadataSchema.

Parameters
Name	Description
request	GetMetadataSchemaRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskMetadataSchema	The response to send back to the client (wrapped by a task).

GetMetadataStore(GetMetadataStoreRequest, ServerCallContext)

public virtual Task<MetadataStore> GetMetadataStore(GetMetadataStoreRequest request, ServerCallContext context)

Retrieves a specific MetadataStore.

Parameters
Name	Description
request	GetMetadataStoreRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskMetadataStore	The response to send back to the client (wrapped by a task).

ListArtifacts(ListArtifactsRequest, ServerCallContext)

public virtual Task<ListArtifactsResponse> ListArtifacts(ListArtifactsRequest request, ServerCallContext context)

Lists Artifacts in the MetadataStore.

Parameters
Name	Description
request	ListArtifactsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListArtifactsResponse	The response to send back to the client (wrapped by a task).

ListContexts(ListContextsRequest, ServerCallContext)

public virtual Task<ListContextsResponse> ListContexts(ListContextsRequest request, ServerCallContext context)

Lists Contexts on the MetadataStore.

Parameters
Name	Description
request	ListContextsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListContextsResponse	The response to send back to the client (wrapped by a task).

ListExecutions(ListExecutionsRequest, ServerCallContext)

public virtual Task<ListExecutionsResponse> ListExecutions(ListExecutionsRequest request, ServerCallContext context)

Lists Executions in the MetadataStore.

Parameters
Name	Description
request	ListExecutionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListExecutionsResponse	The response to send back to the client (wrapped by a task).

ListMetadataSchemas(ListMetadataSchemasRequest, ServerCallContext)

public virtual Task<ListMetadataSchemasResponse> ListMetadataSchemas(ListMetadataSchemasRequest request, ServerCallContext context)

Lists MetadataSchemas.

Parameters
Name	Description
request	ListMetadataSchemasRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListMetadataSchemasResponse	The response to send back to the client (wrapped by a task).

ListMetadataStores(ListMetadataStoresRequest, ServerCallContext)

public virtual Task<ListMetadataStoresResponse> ListMetadataStores(ListMetadataStoresRequest request, ServerCallContext context)

Lists MetadataStores for a Location.

Parameters
Name	Description
request	ListMetadataStoresRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListMetadataStoresResponse	The response to send back to the client (wrapped by a task).

PurgeArtifacts(PurgeArtifactsRequest, ServerCallContext)

public virtual Task<Operation> PurgeArtifacts(PurgeArtifactsRequest request, ServerCallContext context)

Purges Artifacts.

Parameters
Name	Description
request	PurgeArtifactsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

PurgeContexts(PurgeContextsRequest, ServerCallContext)

public virtual Task<Operation> PurgeContexts(PurgeContextsRequest request, ServerCallContext context)

Purges Contexts.

Parameters
Name	Description
request	PurgeContextsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

PurgeExecutions(PurgeExecutionsRequest, ServerCallContext)

public virtual Task<Operation> PurgeExecutions(PurgeExecutionsRequest request, ServerCallContext context)

Purges Executions.

Parameters
Name	Description
request	PurgeExecutionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest, ServerCallContext)

public virtual Task<LineageSubgraph> QueryArtifactLineageSubgraph(QueryArtifactLineageSubgraphRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskLineageSubgraph	The response to send back to the client (wrapped by a task).

QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest, ServerCallContext)

public virtual Task<LineageSubgraph> QueryContextLineageSubgraph(QueryContextLineageSubgraphRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	QueryContextLineageSubgraphRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskLineageSubgraph	The response to send back to the client (wrapped by a task).

QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest, ServerCallContext)

public virtual Task<LineageSubgraph> QueryExecutionInputsAndOutputs(QueryExecutionInputsAndOutputsRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskLineageSubgraph	The response to send back to the client (wrapped by a task).

RemoveContextChildren(RemoveContextChildrenRequest, ServerCallContext)

public virtual Task<RemoveContextChildrenResponse> RemoveContextChildren(RemoveContextChildrenRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRemoveContextChildrenResponse	The response to send back to the client (wrapped by a task).

UpdateArtifact(UpdateArtifactRequest, ServerCallContext)

public virtual Task<Artifact> UpdateArtifact(UpdateArtifactRequest request, ServerCallContext context)

Updates a stored Artifact.

Parameters
Name	Description
request	UpdateArtifactRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskArtifact	The response to send back to the client (wrapped by a task).

UpdateContext(UpdateContextRequest, ServerCallContext)

public virtual Task<Context> UpdateContext(UpdateContextRequest request, ServerCallContext context)

Updates a stored Context.

Parameters
Name	Description
request	UpdateContextRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskContext	The response to send back to the client (wrapped by a task).

UpdateExecution(UpdateExecutionRequest, ServerCallContext)

public virtual Task<Execution> UpdateExecution(UpdateExecutionRequest request, ServerCallContext context)

Updates a stored Execution.

Parameters
Name	Description
request	UpdateExecutionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskExecution	The response to send back to the client (wrapped by a task).