- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 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.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class ListArtifactsRequest.Builder extends GeneratedMessageV3.Builder<ListArtifactsRequest.Builder> implements ListArtifactsRequestOrBuilder
Request message for MetadataService.ListArtifacts.
Protobuf type google.cloud.aiplatform.v1.ListArtifactsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListArtifactsRequest.BuilderImplements
ListArtifactsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListArtifactsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
ListArtifactsRequest.Builder |
build()
public ListArtifactsRequest build()
Type | Description |
ListArtifactsRequest |
buildPartial()
public ListArtifactsRequest buildPartial()
Type | Description |
ListArtifactsRequest |
clear()
public ListArtifactsRequest.Builder clear()
Type | Description |
ListArtifactsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListArtifactsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
ListArtifactsRequest.Builder |
clearFilter()
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
, andupdate_time
. Time fields, such ascreate_time
andupdate_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
). For example:display_name = "test" AND metadata.field1.bool_value = true
.
string filter = 4;
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListArtifactsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
ListArtifactsRequest.Builder |
clearPageSize()
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;
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
clearPageToken()
public ListArtifactsRequest.Builder clearPageToken()
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.)
string page_token = 3;
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
clearParent()
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) = { ... }
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
clone()
public ListArtifactsRequest.Builder clone()
Type | Description |
ListArtifactsRequest.Builder |
getDefaultInstanceForType()
public ListArtifactsRequest getDefaultInstanceForType()
Type | Description |
ListArtifactsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getFilter()
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
, andupdate_time
. Time fields, such ascreate_time
andupdate_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
). For example:display_name = "test" AND metadata.field1.bool_value = true
.
string filter = 4;
Type | Description |
String | The filter. |
getFilterBytes()
public 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
, andupdate_time
. Time fields, such ascreate_time
andupdate_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
). For example:display_name = "test" AND metadata.field1.bool_value = true
.
string filter = 4;
Type | Description |
ByteString | The bytes for filter. |
getPageSize()
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;
Type | Description |
int | The pageSize. |
getPageToken()
public String 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.)
string page_token = 3;
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
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.)
string page_token = 3;
Type | Description |
ByteString | The bytes for pageToken. |
getParent()
public 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) = { ... }
Type | Description |
String | The parent. |
getParentBytes()
public 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) = { ... }
Type | Description |
ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(ListArtifactsRequest other)
public ListArtifactsRequest.Builder mergeFrom(ListArtifactsRequest other)
Name | Description |
other | ListArtifactsRequest |
Type | Description |
ListArtifactsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListArtifactsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
ListArtifactsRequest.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public ListArtifactsRequest.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
ListArtifactsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListArtifactsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
ListArtifactsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListArtifactsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
ListArtifactsRequest.Builder |
setFilter(String value)
public 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
, andupdate_time
. Time fields, such ascreate_time
andupdate_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
). For example:display_name = "test" AND metadata.field1.bool_value = true
.
string filter = 4;
Name | Description |
value | String The filter to set. |
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListArtifactsRequest.Builder setFilterBytes(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
, andupdate_time
. Time fields, such ascreate_time
andupdate_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
). For example:display_name = "test" AND metadata.field1.bool_value = true
.
string filter = 4;
Name | Description |
value | ByteString The bytes for filter to set. |
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
setPageSize(int value)
public 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;
Name | Description |
value | int The pageSize to set. |
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListArtifactsRequest.Builder setPageToken(String value)
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.)
string page_token = 3;
Name | Description |
value | String The pageToken to set. |
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListArtifactsRequest.Builder setPageTokenBytes(ByteString value)
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.)
string page_token = 3;
Name | Description |
value | ByteString The bytes for pageToken to set. |
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
setParent(String value)
public 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) = { ... }
Name | Description |
value | String The parent to set. |
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListArtifactsRequest.Builder setParentBytes(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) = { ... }
Name | Description |
value | ByteString The bytes for parent to set. |
Type | Description |
ListArtifactsRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListArtifactsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
ListArtifactsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListArtifactsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
ListArtifactsRequest.Builder |