- 3.48.0 (latest)
- 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 interface ListExecutionsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getFilter()
public abstract 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;
Type | Description |
String | The filter. |
getFilterBytes()
public abstract 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;
Type | Description |
ByteString | The bytes for filter. |
getOrderBy()
public abstract 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;
Type | Description |
String | The orderBy. |
getOrderByBytes()
public abstract 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;
Type | Description |
ByteString | The bytes for orderBy. |
getPageSize()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |