- 3.55.0 (latest)
- 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 static final class ListExecutionsRequest.Builder extends GeneratedMessageV3.Builder<ListExecutionsRequest.Builder> implements ListExecutionsRequestOrBuilder
Request message for MetadataService.ListExecutions.
Protobuf type google.cloud.aiplatform.v1beta1.ListExecutionsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListExecutionsRequest.BuilderImplements
ListExecutionsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListExecutionsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
build()
public ListExecutionsRequest build()
Returns | |
---|---|
Type | Description |
ListExecutionsRequest |
buildPartial()
public ListExecutionsRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListExecutionsRequest |
clear()
public ListExecutionsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListExecutionsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
clearFilter()
public ListExecutionsRequest.Builder clearFilter()
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_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 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
). Maximum nested expression depth allowed is 5. For example:display_name = "test" AND metadata.field1.bool_value = true
.
string filter = 4;
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListExecutionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
clearOrderBy()
public ListExecutionsRequest.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;
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
clearPageSize()
public ListExecutionsRequest.Builder clearPageSize()
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;
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
clearPageToken()
public ListExecutionsRequest.Builder clearPageToken()
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;
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
clearParent()
public ListExecutionsRequest.Builder clearParent()
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) = { ... }
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
clone()
public ListExecutionsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
getDefaultInstanceForType()
public ListExecutionsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListExecutionsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
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_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 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
). 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. |
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_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 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
). 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. |
getOrderBy()
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. |
getOrderByBytes()
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()
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;
Returns | |
---|---|
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;
Returns | |
---|---|
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;
Returns | |
---|---|
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) = { ... }
Returns | |
---|---|
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) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListExecutionsRequest other)
public ListExecutionsRequest.Builder mergeFrom(ListExecutionsRequest other)
Parameter | |
---|---|
Name | Description |
other | ListExecutionsRequest |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListExecutionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListExecutionsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListExecutionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListExecutionsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
setFilter(String value)
public ListExecutionsRequest.Builder setFilter(String value)
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_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 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
). Maximum nested expression depth allowed is 5. For example:display_name = "test" AND metadata.field1.bool_value = true
.
string filter = 4;
Parameter | |
---|---|
Name | Description |
value | String The filter to set. |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListExecutionsRequest.Builder setFilterBytes(ByteString value)
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_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 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
). Maximum nested expression depth allowed is 5. For example:display_name = "test" AND metadata.field1.bool_value = true
.
string filter = 4;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
setOrderBy(String value)
public ListExecutionsRequest.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;
Parameter | |
---|---|
Name | Description |
value | String The orderBy to set. |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
setOrderByBytes(ByteString value)
public ListExecutionsRequest.Builder setOrderByBytes(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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for orderBy to set. |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
setPageSize(int value)
public ListExecutionsRequest.Builder setPageSize(int value)
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;
Parameter | |
---|---|
Name | Description |
value | int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListExecutionsRequest.Builder setPageToken(String value)
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;
Parameter | |
---|---|
Name | Description |
value | String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListExecutionsRequest.Builder setPageTokenBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
setParent(String value)
public ListExecutionsRequest.Builder setParent(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The parent to set. |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListExecutionsRequest.Builder setParentBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for parent to set. |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListExecutionsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListExecutionsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListExecutionsRequest.Builder |