Google Cloud Ai Platform V1 Client - Class ListArtifactsRequest (0.10.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListArtifactsRequest.

Request message for MetadataService.ListArtifacts.

Generated from protobuf message google.cloud.aiplatform.v1.ListArtifactsRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
`↳ page_size`	`int` The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
`↳ page_token`	`string` A page token, received from a previous 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.)
`↳ filter`	`string` 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` * 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`.
`↳ order_by`	`string` 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.

getParent

Required. The MetadataStore whose Artifacts should be listed.

Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type	Description
`string`

setParent

Required. The MetadataStore whose Artifacts should be listed.

Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

The maximum number of Artifacts to return. The service may return fewer.

Must be in range 1-1000, inclusive. Defaults to 100.

Generated from protobuf field int32 page_size = 2;

Returns
Type	Description
`int`

setPageSize

The maximum number of Artifacts to return. The service may return fewer.

Must be in range 1-1000, inclusive. Defaults to 100.

Generated from protobuf field int32 page_size = 2;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

A page token, received from a previous 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.)

Generated from protobuf field string page_token = 3;

Returns
Type	Description
`string`

setPageToken

A page token, received from a previous 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.)

Generated from protobuf field string page_token = 3;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

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
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.

Generated from protobuf field string filter = 4;

Returns
Type	Description
`string`

setFilter

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
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.

Generated from protobuf field string filter = 4;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

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.

Generated from protobuf field string order_by = 5;

Returns
Type	Description
`string`

setOrderBy

Subfields are specified with a . character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

Generated from protobuf field string order_by = 5;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`