Struct google_api_proto::google::cloud::aiplatform::v1::ListNotebookRuntimesRequest

pub struct ListNotebookRuntimesRequest {
    pub parent: String,
    pub filter: String,
    pub page_size: i32,
    pub page_token: String,
    pub read_mask: Option<FieldMask>,
    pub order_by: String,
}

Request message for [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes].

Fields

parent: String

Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/{project}/locations/{location}

filter: String

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

• notebookRuntime supports = and !=. notebookRuntime represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime’s [resource name] [google.cloud.aiplatform.v1.NotebookRuntime.name].
• displayName supports = and != and regex.
• notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate’s [resource name] [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
• healthState supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED].
• runtimeState supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID].
• runtimeUser supports = and !=.
• API version is UI only: uiState supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED].
• notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK].

Some examples:

• notebookRuntime="notebookRuntime123"
• displayName="myDisplayName" and displayName=~"myDisplayNameRegex"
• notebookRuntimeTemplate="notebookRuntimeTemplate321"
• healthState=HEALTHY
• runtimeState=RUNNING
• runtimeUser="test@google.com"
• uiState=UI_RESOURCE_STATE_BEING_DELETED
• notebookRuntimeType=USER_DEFINED

page_size: i32

Optional. The standard list page size.

page_token: String

Optional. The standard list page token. Typically obtained via [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesResponse.next_page_token] of the previous [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes] call.

read_mask: Option<FieldMask>

Optional. Mask specifying which fields to read.

order_by: String

Optional. A comma-separated list of fields to order by, sorted in ascending order. Use “desc” after a field name for descending. Supported fields:

• display_name
• create_time
• update_time

Example: display_name, create_time desc.

Trait Implementations

impl Clone for ListNotebookRuntimesRequest

fn clone(&self) -> ListNotebookRuntimesRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListNotebookRuntimesRequest

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

Formats the value using the given formatter.

impl Default for ListNotebookRuntimesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListNotebookRuntimesRequest

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.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

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

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

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

impl PartialEq for ListNotebookRuntimesRequest

fn eq(&self, other: &ListNotebookRuntimesRequest) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListNotebookRuntimesRequest