public final class ListExecutionsRequest extends GeneratedMessageV3 implements ListExecutionsRequestOrBuilder
Request message for MetadataService.ListExecutions.
Protobuf type google.cloud.aiplatform.v1.ListExecutionsRequest
Static Fields
public static final int FILTER_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
public static final int PARENT_FIELD_NUMBER
Field Value
Static Methods
public static ListExecutionsRequest getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ListExecutionsRequest.Builder newBuilder()
Returns
public static ListExecutionsRequest.Builder newBuilder(ListExecutionsRequest prototype)
Parameter
Returns
public static ListExecutionsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListExecutionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListExecutionsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static ListExecutionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListExecutionsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ListExecutionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListExecutionsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListExecutionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListExecutionsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListExecutionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListExecutionsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ListExecutionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ListExecutionsRequest> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public ListExecutionsRequest getDefaultInstanceForType()
Returns
public String getFilter()
Filter specifying the boolean condition for the Executions 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.
Following are the supported set of filters:
- Attribute filtering:
For example:
display_name = "test".
Supported fields include: name, display_name, 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 Executions 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 filters 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.
|
public ByteString getFilterBytes()
Filter specifying the boolean condition for the Executions 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.
Following are the supported set of filters:
- Attribute filtering:
For example:
display_name = "test".
Supported fields include: name, display_name, 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 Executions 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 filters can be combined together using
logical operators (AND & OR).
For example: display_name = "test" AND metadata.field1.bool_value = true.
string filter = 4;
getPageSize()
The maximum number of Executions 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.ListExecutions
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 an
INVALID_ARGUMENT error.)
string page_token = 3;
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token, received from a previous MetadataService.ListExecutions
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 an
INVALID_ARGUMENT error.)
string page_token = 3;
public String getParent()
Required. The MetadataStore whose Executions 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.
|
public ByteString getParentBytes()
Required. The MetadataStore whose Executions should be listed.
Format:
projects/{project}/locations/{location}/metadataStores/{metadatastore}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
public Parser<ListExecutionsRequest> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ListExecutionsRequest.Builder newBuilderForType()
Returns
protected ListExecutionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ListExecutionsRequest.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
