public static final class ListArtifactsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder> implements ListArtifactsRequestOrBuilder
Request message for [MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts].Protobuf type
google.cloud.aiplatform.v1beta1.ListArtifactsRequest| Modifier and Type | Method and Description |
|---|---|
ListArtifactsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListArtifactsRequest |
build() |
ListArtifactsRequest |
buildPartial() |
ListArtifactsRequest.Builder |
clear() |
ListArtifactsRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ListArtifactsRequest.Builder |
clearFilter()
Filter specifying the boolean condition for the Artifacts to satisfy in
order to be part of the result set.
|
ListArtifactsRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ListArtifactsRequest.Builder |
clearOrderBy()
How the list of messages is ordered.
|
ListArtifactsRequest.Builder |
clearPageSize()
The maximum number of Artifacts to return.
|
ListArtifactsRequest.Builder |
clearPageToken()
A page token, received from a previous
[MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]
call.
|
ListArtifactsRequest.Builder |
clearParent()
Required.
|
ListArtifactsRequest.Builder |
clone() |
ListArtifactsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getFilter()
Filter specifying the boolean condition for the Artifacts to satisfy in
order to be part of the result set.
|
com.google.protobuf.ByteString |
getFilterBytes()
Filter specifying the boolean condition for the Artifacts to satisfy in
order to be part of the result set.
|
String |
getOrderBy()
How the list of messages is ordered.
|
com.google.protobuf.ByteString |
getOrderByBytes()
How the list of messages is ordered.
|
int |
getPageSize()
The maximum number of Artifacts to return.
|
String |
getPageToken()
A page token, received from a previous
[MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]
call.
|
com.google.protobuf.ByteString |
getPageTokenBytes()
A page token, received from a previous
[MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]
call.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ListArtifactsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ListArtifactsRequest.Builder |
mergeFrom(ListArtifactsRequest other) |
ListArtifactsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ListArtifactsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ListArtifactsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListArtifactsRequest.Builder |
setFilter(String value)
Filter specifying the boolean condition for the Artifacts to satisfy in
order to be part of the result set.
|
ListArtifactsRequest.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
Filter specifying the boolean condition for the Artifacts to satisfy in
order to be part of the result set.
|
ListArtifactsRequest.Builder |
setOrderBy(String value)
How the list of messages is ordered.
|
ListArtifactsRequest.Builder |
setOrderByBytes(com.google.protobuf.ByteString value)
How the list of messages is ordered.
|
ListArtifactsRequest.Builder |
setPageSize(int value)
The maximum number of Artifacts to return.
|
ListArtifactsRequest.Builder |
setPageToken(String value)
A page token, received from a previous
[MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]
call.
|
ListArtifactsRequest.Builder |
setPageTokenBytes(com.google.protobuf.ByteString value)
A page token, received from a previous
[MetadataService.ListArtifacts][google.cloud.aiplatform.v1beta1.MetadataService.ListArtifacts]
call.
|
ListArtifactsRequest.Builder |
setParent(String value)
Required.
|
ListArtifactsRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
Required.
|
ListArtifactsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ListArtifactsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public ListArtifactsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public ListArtifactsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ListArtifactsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ListArtifactsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ListArtifactsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public ListArtifactsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public ListArtifactsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public ListArtifactsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public ListArtifactsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public ListArtifactsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public ListArtifactsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListArtifactsRequest.Builder>public ListArtifactsRequest.Builder mergeFrom(ListArtifactsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public ListArtifactsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListArtifactsRequest.Builder>IOExceptionpublic String getParent()
Required. The MetadataStore whose Artifacts should be listed.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParent in interface ListArtifactsRequestOrBuilderpublic com.google.protobuf.ByteString getParentBytes()
Required. The MetadataStore whose Artifacts should be listed.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParentBytes in interface ListArtifactsRequestOrBuilderpublic ListArtifactsRequest.Builder setParent(String value)
Required. The MetadataStore whose Artifacts should be listed.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value - The parent to set.public ListArtifactsRequest.Builder clearParent()
Required. The MetadataStore whose Artifacts should be listed.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
public ListArtifactsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
Required. The MetadataStore whose Artifacts should be listed.
Format:
`projects/{project}/locations/{location}/metadataStores/{metadatastore}`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value - The bytes for parent to set.public int getPageSize()
The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
int32 page_size = 2;getPageSize in interface ListArtifactsRequestOrBuilderpublic ListArtifactsRequest.Builder setPageSize(int value)
The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
int32 page_size = 2;value - The pageSize to set.public ListArtifactsRequest.Builder clearPageSize()
The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
int32 page_size = 2;public String getPageToken()
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.)
string page_token = 3;getPageToken in interface ListArtifactsRequestOrBuilderpublic com.google.protobuf.ByteString getPageTokenBytes()
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.)
string page_token = 3;getPageTokenBytes in interface ListArtifactsRequestOrBuilderpublic ListArtifactsRequest.Builder setPageToken(String value)
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.)
string page_token = 3;value - The pageToken to set.public ListArtifactsRequest.Builder clearPageToken()
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.)
string page_token = 3;public ListArtifactsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
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.)
string page_token = 3;value - The bytes for pageToken to set.public String 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`
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`.
string filter = 4;getFilter in interface ListArtifactsRequestOrBuilderpublic com.google.protobuf.ByteString getFilterBytes()
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`.
string filter = 4;getFilterBytes in interface ListArtifactsRequestOrBuilderpublic ListArtifactsRequest.Builder setFilter(String value)
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`.
string filter = 4;value - The filter to set.public ListArtifactsRequest.Builder clearFilter()
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`.
string filter = 4;public ListArtifactsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
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`.
string filter = 4;value - The bytes for filter to set.public String 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.
string order_by = 5;getOrderBy in interface ListArtifactsRequestOrBuilderpublic com.google.protobuf.ByteString getOrderByBytes()
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.
string order_by = 5;getOrderByBytes in interface ListArtifactsRequestOrBuilderpublic ListArtifactsRequest.Builder setOrderBy(String value)
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.
string order_by = 5;value - The orderBy to set.public ListArtifactsRequest.Builder clearOrderBy()
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.
string order_by = 5;public ListArtifactsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
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.
string order_by = 5;value - The bytes for orderBy to set.public final ListArtifactsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>public final ListArtifactsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListArtifactsRequest.Builder>Copyright © 2025 Google LLC. All rights reserved.