Struct google_api_proto::google::cloud::aiplatform::v1::ListExecutionsRequest
source · pub struct ListExecutionsRequest {
pub parent: String,
pub page_size: i32,
pub page_token: String,
pub filter: String,
pub order_by: String,
}
Expand description
Request message for [MetadataService.ListExecutions][google.cloud.aiplatform.v1.MetadataService.ListExecutions].
Fields§
§parent: String
Required. The MetadataStore whose Executions should be listed.
Format:
projects/{project}/locations/{location}/metadataStores/{metadatastore}
page_size: i32
The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.
page_token: String
A page token, received from a previous [MetadataService.ListExecutions][google.cloud.aiplatform.v1.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.)
filter: String
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
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 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
.
order_by: String
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.
Trait Implementations§
source§impl Clone for ListExecutionsRequest
impl Clone for ListExecutionsRequest
source§fn clone(&self) -> ListExecutionsRequest
fn clone(&self) -> ListExecutionsRequest
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListExecutionsRequest
impl Debug for ListExecutionsRequest
source§impl Default for ListExecutionsRequest
impl Default for ListExecutionsRequest
source§impl Message for ListExecutionsRequest
impl Message for ListExecutionsRequest
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
source§fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
. Read moresource§fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
.source§impl PartialEq for ListExecutionsRequest
impl PartialEq for ListExecutionsRequest
source§fn eq(&self, other: &ListExecutionsRequest) -> bool
fn eq(&self, other: &ListExecutionsRequest) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ListExecutionsRequest
Auto Trait Implementations§
impl Freeze for ListExecutionsRequest
impl RefUnwindSafe for ListExecutionsRequest
impl Send for ListExecutionsRequest
impl Sync for ListExecutionsRequest
impl Unpin for ListExecutionsRequest
impl UnwindSafe for ListExecutionsRequest
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request