|
|
|
|
@ -176,7 +176,7 @@ service MetadataService { |
|
|
|
|
// 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 INVALID_ARGUMENT |
|
|
|
|
// have more than 10 parents, the request will fail with an INVALID_ARGUMENT |
|
|
|
|
// error. |
|
|
|
|
rpc AddContextChildren(AddContextChildrenRequest) returns (AddContextChildrenResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
@ -229,9 +229,10 @@ service MetadataService { |
|
|
|
|
option (google.api.method_signature) = "execution,update_mask"; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Adds Events for denoting whether each Artifact was an input or output for a |
|
|
|
|
// given Execution. If any Events already exist between the Execution and any |
|
|
|
|
// of the specified Artifacts they are simply skipped. |
|
|
|
|
// 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. |
|
|
|
|
rpc AddExecutionEvents(AddExecutionEventsRequest) returns (AddExecutionEventsResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1beta1/{execution=projects/*/locations/*/metadataStores/*/executions/*}:addExecutionEvents" |
|
|
|
|
@ -250,7 +251,7 @@ service MetadataService { |
|
|
|
|
option (google.api.method_signature) = "execution"; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Creates an MetadataSchema. |
|
|
|
|
// Creates a MetadataSchema. |
|
|
|
|
rpc CreateMetadataSchema(CreateMetadataSchemaRequest) returns (MetadataSchema) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1beta1/{parent=projects/*/locations/*/metadataStores/*}/metadataSchemas" |
|
|
|
|
@ -459,28 +460,29 @@ message ListArtifactsRequest { |
|
|
|
|
// order to be part of the result set. |
|
|
|
|
// The syntax to define filter query is based on https://google.aip.dev/160. |
|
|
|
|
// The supported set of filters include the following: |
|
|
|
|
// 1. Attributes filtering |
|
|
|
|
// e.g. display_name = "test" |
|
|
|
|
// |
|
|
|
|
// Supported fields include: name, display_name, uri, state, |
|
|
|
|
// schema_title, create_time and update_time. |
|
|
|
|
// Time fields, i.e. create_time and update_time, require values to |
|
|
|
|
// specified in RFC-3339 format. |
|
|
|
|
// e.g. create_time = "2020-11-19T11:30:00-04:00" |
|
|
|
|
// 2. Metadata field |
|
|
|
|
// To filter on metadata fields use traversal operation as follows: |
|
|
|
|
// metadata.<field_name>.<type_value> |
|
|
|
|
// e.g. metadata.field_1.number_value = 10.0 |
|
|
|
|
// 3. Context based filtering |
|
|
|
|
// To filter Artifacts based on the contexts to which they belong use the |
|
|
|
|
// function operator with the full resource name |
|
|
|
|
// "in_context(<context-name>)" |
|
|
|
|
// e.g. |
|
|
|
|
// in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>") |
|
|
|
|
// * **Attribute filtering**: |
|
|
|
|
// For example: `display_name = "test"`. |
|
|
|
|
// Supported fields include: `name`, `display_name`, `uri`, `state`, |
|
|
|
|
// `schema_title`, `create_time`, and `update_time`. |
|
|
|
|
// Time fields, such as `create_time` and `update_time`, require values |
|
|
|
|
// specified in RFC-3339 format. |
|
|
|
|
// For example: `create_time = "2020-11-19T11:30:00-04:00"` |
|
|
|
|
// * **Metadata field**: |
|
|
|
|
// To filter on metadata fields use traversal operation as follows: |
|
|
|
|
// `metadata.<field_name>.<type_value>`. |
|
|
|
|
// For example: `metadata.field_1.number_value = 10.0` |
|
|
|
|
// * **Context based filtering**: |
|
|
|
|
// To filter Artifacts based on the contexts to which they belong, use the |
|
|
|
|
// function operator with the full resource name |
|
|
|
|
// `in_context(<context-name>)`. |
|
|
|
|
// For example: |
|
|
|
|
// `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")` |
|
|
|
|
// |
|
|
|
|
// Each of the above supported filter types can be combined together using |
|
|
|
|
// Logical operators (AND & OR). |
|
|
|
|
// e.g. display_name = "test" AND metadata.field1.bool_value = true. |
|
|
|
|
// logical operators (`AND` & `OR`). |
|
|
|
|
// |
|
|
|
|
// For example: `display_name = "test" AND metadata.field1.bool_value = true`. |
|
|
|
|
string filter = 4; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
@ -529,7 +531,7 @@ message CreateContextRequest { |
|
|
|
|
Context context = 2 [(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
|
|
|
|
|
// The {context} portion of the resource name with the format: |
|
|
|
|
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context} |
|
|
|
|
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}. |
|
|
|
|
// If not provided, the Context's ID will be a UUID generated by the service. |
|
|
|
|
// Must be 4-128 characters in length. Valid characters are /[a-z][0-9]-/. |
|
|
|
|
// Must be unique across all Contexts in the parent MetadataStore. (Otherwise |
|
|
|
|
@ -575,6 +577,37 @@ message ListContextsRequest { |
|
|
|
|
// INVALID_ARGUMENT error.) |
|
|
|
|
string page_token = 3; |
|
|
|
|
|
|
|
|
|
// Filter specifying the boolean condition for the Contexts to satisfy in |
|
|
|
|
// order to be part of the result set. |
|
|
|
|
// The syntax to define filter query is based on https://google.aip.dev/160. |
|
|
|
|
// Following are the supported set of filters: |
|
|
|
|
// |
|
|
|
|
// * **Attribute filtering**: |
|
|
|
|
// For example: `display_name = "test"`. |
|
|
|
|
// Supported fields include: `name`, `display_name`, `schema_title`, |
|
|
|
|
// `create_time`, and `update_time`. |
|
|
|
|
// Time fields, such as `create_time` and `update_time`, require values |
|
|
|
|
// specified in RFC-3339 format. |
|
|
|
|
// For example: `create_time = "2020-11-19T11:30:00-04:00"`. |
|
|
|
|
// * **Metadata field**: |
|
|
|
|
// To filter on metadata fields use traversal operation as follows: |
|
|
|
|
// `metadata.<field_name>.<type_value>`. |
|
|
|
|
// For example: `metadata.field_1.number_value = 10.0`. |
|
|
|
|
// * **Parent Child filtering**: |
|
|
|
|
// To filter Contexts based on parent-child relationship use the HAS |
|
|
|
|
// operator as follows: |
|
|
|
|
// |
|
|
|
|
// ``` |
|
|
|
|
// parent_contexts: |
|
|
|
|
// "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>" |
|
|
|
|
// child_contexts: |
|
|
|
|
// "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>" |
|
|
|
|
// ``` |
|
|
|
|
// |
|
|
|
|
// Each of the above supported filters can be combined together using |
|
|
|
|
// logical operators (`AND` & `OR`). |
|
|
|
|
// |
|
|
|
|
// For example: `display_name = "test" AND metadata.field1.bool_value = true`. |
|
|
|
|
string filter = 4; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
@ -639,12 +672,18 @@ message AddContextArtifactsAndExecutionsRequest { |
|
|
|
|
]; |
|
|
|
|
|
|
|
|
|
// The resource names of the Artifacts to attribute to the Context. |
|
|
|
|
// |
|
|
|
|
// Format: |
|
|
|
|
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact} |
|
|
|
|
repeated string artifacts = 2 [(google.api.resource_reference) = { |
|
|
|
|
type: "aiplatform.googleapis.com/Artifact" |
|
|
|
|
}]; |
|
|
|
|
|
|
|
|
|
// The resource names of the Executions to associate with the |
|
|
|
|
// Context. |
|
|
|
|
// |
|
|
|
|
// Format: |
|
|
|
|
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} |
|
|
|
|
repeated string executions = 3 [(google.api.resource_reference) = { |
|
|
|
|
type: "aiplatform.googleapis.com/Execution" |
|
|
|
|
}]; |
|
|
|
|
@ -658,6 +697,7 @@ message AddContextArtifactsAndExecutionsResponse { |
|
|
|
|
// Request message for [MetadataService.AddContextChildren][google.cloud.aiplatform.v1beta1.MetadataService.AddContextChildren]. |
|
|
|
|
message AddContextChildrenRequest { |
|
|
|
|
// Required. The resource name of the parent Context. |
|
|
|
|
// |
|
|
|
|
// Format: |
|
|
|
|
// projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context} |
|
|
|
|
string context = 1 [ |
|
|
|
|
@ -756,7 +796,7 @@ message ListExecutionsRequest { |
|
|
|
|
// call. Provide this to retrieve the subsequent page. |
|
|
|
|
// |
|
|
|
|
// When paginating, all other provided parameters must match the call that |
|
|
|
|
// provided the page token. (Otherwise the request will fail with |
|
|
|
|
// provided the page token. (Otherwise the request will fail with an |
|
|
|
|
// INVALID_ARGUMENT error.) |
|
|
|
|
string page_token = 3; |
|
|
|
|
|
|
|
|
|
@ -764,28 +804,28 @@ message ListExecutionsRequest { |
|
|
|
|
// order to be part of the result set. |
|
|
|
|
// The syntax to define filter query is based on https://google.aip.dev/160. |
|
|
|
|
// Following are the supported set of filters: |
|
|
|
|
// 1. Attributes filtering |
|
|
|
|
// e.g. display_name = "test" |
|
|
|
|
// |
|
|
|
|
// supported fields include: name, display_name, state, |
|
|
|
|
// schema_title, create_time and update_time. |
|
|
|
|
// Time fields, i.e. create_time and update_time, require values to |
|
|
|
|
// specified in RFC-3339 format. |
|
|
|
|
// e.g. create_time = "2020-11-19T11:30:00-04:00" |
|
|
|
|
// 2. Metadata field |
|
|
|
|
// To filter on metadata fields use traversal operation as follows: |
|
|
|
|
// metadata.<field_name>.<type_value> |
|
|
|
|
// e.g. metadata.field_1.number_value = 10.0 |
|
|
|
|
// 3. Context based filtering |
|
|
|
|
// To filter Executions based on the contexts to which they belong use |
|
|
|
|
// the function operator with the full resource name |
|
|
|
|
// "in_context(<context-name>)" |
|
|
|
|
// e.g. |
|
|
|
|
// in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>") |
|
|
|
|
// * **Attribute filtering**: |
|
|
|
|
// For example: `display_name = "test"`. |
|
|
|
|
// Supported fields include: `name`, `display_name`, `state`, |
|
|
|
|
// `schema_title`, `create_time`, and `update_time`. |
|
|
|
|
// Time fields, such as `create_time` and `update_time`, require values |
|
|
|
|
// specified in RFC-3339 format. |
|
|
|
|
// For example: `create_time = "2020-11-19T11:30:00-04:00"`. |
|
|
|
|
// * **Metadata field**: |
|
|
|
|
// To filter on metadata fields use traversal operation as follows: |
|
|
|
|
// `metadata.<field_name>.<type_value>` |
|
|
|
|
// For example: `metadata.field_1.number_value = 10.0` |
|
|
|
|
// * **Context based filtering**: |
|
|
|
|
// To filter Executions based on the contexts to which they belong use |
|
|
|
|
// the function operator with the full resource name: |
|
|
|
|
// `in_context(<context-name>)`. |
|
|
|
|
// For example: |
|
|
|
|
// `in_context("projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context-id>")` |
|
|
|
|
// |
|
|
|
|
// Each of the above supported filters can be combined together using |
|
|
|
|
// Logical operators (AND & OR). |
|
|
|
|
// e.g. display_name = "test" AND metadata.field1.bool_value = true. |
|
|
|
|
// logical operators (`AND` & `OR`). |
|
|
|
|
// For example: `display_name = "test" AND metadata.field1.bool_value = true`. |
|
|
|
|
string filter = 4; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
@ -912,7 +952,7 @@ message ListMetadataSchemasRequest { |
|
|
|
|
|
|
|
|
|
// A page token, received from a previous |
|
|
|
|
// [MetadataService.ListMetadataSchemas][google.cloud.aiplatform.v1beta1.MetadataService.ListMetadataSchemas] call. Provide this to retrieve the |
|
|
|
|
// subsequent page. |
|
|
|
|
// next page. |
|
|
|
|
// |
|
|
|
|
// When paginating, all other provided parameters must match the call that |
|
|
|
|
// provided the page token. (Otherwise the request will fail with |
|
|
|
|
@ -962,21 +1002,22 @@ message QueryArtifactLineageSubgraphRequest { |
|
|
|
|
// order to be part of the Lineage Subgraph. |
|
|
|
|
// The syntax to define filter query is based on https://google.aip.dev/160. |
|
|
|
|
// The supported set of filters include the following: |
|
|
|
|
// 1. Attributes filtering |
|
|
|
|
// e.g. display_name = "test" |
|
|
|
|
// |
|
|
|
|
// supported fields include: name, display_name, uri, state, |
|
|
|
|
// schema_title, create_time and update_time. |
|
|
|
|
// Time fields, i.e. create_time and update_time, require values to |
|
|
|
|
// specified in RFC-3339 format. |
|
|
|
|
// e.g. create_time = "2020-11-19T11:30:00-04:00" |
|
|
|
|
// 2. Metadata field |
|
|
|
|
// To filter on metadata fields use traversal operation as follows: |
|
|
|
|
// metadata.<field_name>.<type_value> |
|
|
|
|
// e.g. metadata.field_1.number_value = 10.0 |
|
|
|
|
// * **Attribute filtering**: |
|
|
|
|
// For example: `display_name = "test"` |
|
|
|
|
// Supported fields include: `name`, `display_name`, `uri`, `state`, |
|
|
|
|
// `schema_title`, `create_time`, and `update_time`. |
|
|
|
|
// Time fields, such as `create_time` and `update_time`, require values |
|
|
|
|
// specified in RFC-3339 format. |
|
|
|
|
// For example: `create_time = "2020-11-19T11:30:00-04:00"` |
|
|
|
|
// * **Metadata field**: |
|
|
|
|
// To filter on metadata fields use traversal operation as follows: |
|
|
|
|
// `metadata.<field_name>.<type_value>`. |
|
|
|
|
// For example: `metadata.field_1.number_value = 10.0` |
|
|
|
|
// |
|
|
|
|
// Each of the above supported filter types can be combined together using |
|
|
|
|
// Logical operators (AND & OR). |
|
|
|
|
// e.g. display_name = "test" AND metadata.field1.bool_value = true. |
|
|
|
|
// logical operators (`AND` & `OR`). |
|
|
|
|
// |
|
|
|
|
// For example: `display_name = "test" AND metadata.field1.bool_value = true`. |
|
|
|
|
string filter = 3; |
|
|
|
|
} |
|
|
|
|
|
Google APIs
4 years ago
committed by
Copybara-Service