- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 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 final class ListExecutionsRequest extends GeneratedMessageV3 implements ListExecutionsRequestOrBuilderRequest message for MetadataService.ListExecutions.
Protobuf type google.cloud.aiplatform.v1.ListExecutionsRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListExecutionsRequestImplements
ListExecutionsRequestOrBuilderFields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER| Type | Description |
| int |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER| Type | Description |
| int |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER| Type | Description |
| int |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER| Type | Description |
| int |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getDefaultInstance()
public static ListExecutionsRequest getDefaultInstance()| Type | Description |
| ListExecutionsRequest |
getDefaultInstanceForType()
public ListExecutionsRequest getDefaultInstanceForType()| Type | Description |
| ListExecutionsRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
getFilter()
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, andupdate_time. Time fields, such ascreate_timeandupdate_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. |
getFilterBytes()
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, andupdate_time. Time fields, such ascreate_timeandupdate_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 |
| ByteString | The bytes for filter. |
getPageSize()
public int 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;
| Type | Description |
| ByteString | The bytes for pageToken. |
getParent()
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. |
getParentBytes()
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) = { ... }
| Type | Description |
| ByteString | The bytes for parent. |
getParserForType()
public Parser<ListExecutionsRequest> getParserForType()| Type | Description |
| Parser<ListExecutionsRequest> |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilder()
public static ListExecutionsRequest.Builder newBuilder()| Type | Description |
| ListExecutionsRequest.Builder |
newBuilder(ListExecutionsRequest prototype)
public static ListExecutionsRequest.Builder newBuilder(ListExecutionsRequest prototype)| Name | Description |
| prototype | ListExecutionsRequest |
| Type | Description |
| ListExecutionsRequest.Builder |
newBuilderForType()
public ListExecutionsRequest.Builder newBuilderForType()| Type | Description |
| ListExecutionsRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListExecutionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| ListExecutionsRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
parseDelimitedFrom(InputStream input)
public static ListExecutionsRequest parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static ListExecutionsRequest parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ListExecutionsRequest parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ListExecutionsRequest parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static ListExecutionsRequest parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static ListExecutionsRequest parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListExecutionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListExecutionsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<ListExecutionsRequest> parser()| Type | Description |
| Parser<ListExecutionsRequest> |
toBuilder()
public ListExecutionsRequest.Builder toBuilder()| Type | Description |
| ListExecutionsRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |