Cloud AI Platform v1beta1 API - Class ListArtifactsRequest (1.0.0-beta05) 

public sealed class ListArtifactsRequest : IMessage<ListArtifactsRequest>, IEquatable<ListArtifactsRequest>, IDeepCloneable<ListArtifactsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class ListArtifactsRequest.

Request message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts].

Inheritance

object > ListArtifactsRequest

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

ListArtifactsRequest()

public ListArtifactsRequest()

ListArtifactsRequest(ListArtifactsRequest)

public ListArtifactsRequest(ListArtifactsRequest other)
Parameter
Name Description
other ListArtifactsRequest

Properties

Filter

public string Filter { get; set; }

Filter specifying the boolean condition for the Artifacts 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. The supported set of filters include the following:

  • 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 In case the field name contains special characters (such as colon), one can embed it inside double quote. 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). Maximum nested expression depth allowed is 5.

For example: display_name = "test" AND metadata.field1.bool_value = true.

Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a . character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

A page token, received from a previous [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts] 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 INVALID_ARGUMENT error.)

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The MetadataStore whose Artifacts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Property Value
Type Description
string

ParentAsMetadataStoreName

public MetadataStoreName ParentAsMetadataStoreName { get; set; }

MetadataStoreName-typed view over the Parent resource name property.

Property Value
Type Description
MetadataStoreName