Struct gapi_grpc::google::cloud::aiplatform::v1beta1::ListContextsRequest

[+] Show declaration

pub struct ListContextsRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
}

[−] Expand description

Request message for [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]

Fields

parent: String

[−] Expand description

Required. The MetadataStore whose Contexts should be listed. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}

page_size: i32

[−] Expand description

The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

page_token: String

[−] Expand description

A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts] 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 INVALID_ARGUMENT error.)

filter: String

[−] Expand description

Filter specifying the boolean condition for the Contexts 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, 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.

• Parent Child filtering: To filter Contexts based on parent-child relationship use the HAS operator as follows:

  parent_contexts:
  "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
  child_contexts:
  "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.

Trait Implementations

impl Clone for ListContextsRequest[+]

[+] Show hidden undocumented items

fn clone(&self) -> ListContextsRequest[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for ListContextsRequest[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result[−]

Formats the value using the given formatter.

impl Default for ListContextsRequest[+]

[+] Show hidden undocumented items

fn default() -> ListContextsRequest[−]

Returns the “default value” for a type.

impl Message for ListContextsRequest[+]

[+] Show hidden undocumented items

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize[−]

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)[−]

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<ListContextsRequest> for ListContextsRequest[+]

[+] Show hidden undocumented items

fn eq(&self, other: &ListContextsRequest) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ListContextsRequest) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for ListContextsRequest