Struct ListNotebookRuntimesRequest 

#[non_exhaustive]
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,
    /* private fields */
}

Available on crate feature notebook-service only.

Request message for NotebookService.ListNotebookRuntimes.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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].
• machineType supports = and !=.
• acceleratorType supports = and !=.

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
• machineType=e2-standard-4
• acceleratorType=NVIDIA_TESLA_T4

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 of the previous 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.

Implementations

impl ListNotebookRuntimesRequest

pub fn new() -> Self

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

Example

let x = ListNotebookRuntimesRequest::new().set_parent("example");

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = ListNotebookRuntimesRequest::new().set_filter("example");

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

Example

let x = ListNotebookRuntimesRequest::new().set_page_size(42);

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Example

let x = ListNotebookRuntimesRequest::new().set_page_token("example");

pub fn set_read_mask<T>(self, v: T) -> Self

where T: Into<FieldMask>,

Sets the value of read_mask.

Example

use wkt::FieldMask;
let x = ListNotebookRuntimesRequest::new().set_read_mask(FieldMask::default()/* use setters */);

pub fn set_or_clear_read_mask<T>(self, v: Option<T>) -> Self

where T: Into<FieldMask>,

Sets or clears the value of read_mask.

Example

use wkt::FieldMask;
let x = ListNotebookRuntimesRequest::new().set_or_clear_read_mask(Some(FieldMask::default()/* use setters */));
let x = ListNotebookRuntimesRequest::new().set_or_clear_read_mask(None::<FieldMask>);

pub fn set_order_by<T: Into<String>>(self, v: T) -> Self

Sets the value of order_by.

Example

let x = ListNotebookRuntimesRequest::new().set_order_by("example");

Trait Implementations

impl Clone for ListNotebookRuntimesRequest

fn clone(&self) -> ListNotebookRuntimesRequest

Returns a duplicate 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() -> ListNotebookRuntimesRequest

Returns the “default value” for a type.

impl Message for ListNotebookRuntimesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListNotebookRuntimesRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListNotebookRuntimesRequest