public final class ListArtifactsRequest extends GeneratedMessageV3 implements ListArtifactsRequestOrBuilder
Request message for
MetadataService.ListArtifacts.
Protobuf type google.cloud.aiplatform.v1.ListArtifactsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ListArtifactsRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListArtifactsRequest.Builder newBuilder()
public static ListArtifactsRequest.Builder newBuilder(ListArtifactsRequest prototype)
public static ListArtifactsRequest parseDelimitedFrom(InputStream input)
public static ListArtifactsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListArtifactsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ListArtifactsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListArtifactsRequest parseFrom(ByteString data)
public static ListArtifactsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListArtifactsRequest parseFrom(CodedInputStream input)
public static ListArtifactsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListArtifactsRequest parseFrom(InputStream input)
public static ListArtifactsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListArtifactsRequest parseFrom(ByteBuffer data)
public static ListArtifactsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListArtifactsRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public ListArtifactsRequest getDefaultInstanceForType()
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;
| Returns |
| Type |
Description |
String |
The filter.
|
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, 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
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;
| Returns |
| Type |
Description |
String |
The orderBy.
|
public 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for orderBy.
|
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;
| Returns |
| 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;
| Returns |
| 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
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) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
public Parser<ListArtifactsRequest> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListArtifactsRequest.Builder newBuilderForType()
protected ListArtifactsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ListArtifactsRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
