Struct google_api_proto::google::spanner::admin::instance::v1::ListInstancesRequest

pub struct ListInstancesRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
    pub instance_deadline: Option<Timestamp>,
}

The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].

Fields

parent: String

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

page_size: i32

Number of instances to be returned in the response. If 0 or less, defaults to the server’s maximum allowed page size.

page_token: String

If non-empty, page_token should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].

filter: String

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

• name
• display_name
• labels.key where key is the name of a label

Some examples of using filters are:

• name:* –> The instance has a name.
• name:Howl –> The instance’s name contains the string “howl”.
• name:HOWL –> Equivalent to above.
• NAME:howl –> Equivalent to above.
• labels.env:* –> The instance has the label “env”.
• labels.env:dev –> The instance has the label “env” and the value of the label contains the string “dev”.
• name:howl labels.env:dev –> The instance’s name contains “howl” and it has the label “env” with its value containing “dev”.

instance_deadline: Option<Timestamp>

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to [unreachable][google.spanner.admin.instance.v1.ListInstancesResponse.unreachable] in [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].

Trait Implementations

impl Clone for ListInstancesRequest

fn clone(&self) -> ListInstancesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListInstancesRequest

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

Formats the value using the given formatter.

impl Default for ListInstancesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListInstancesRequest

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 ListInstancesRequest

fn eq(&self, other: &ListInstancesRequest) -> 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 ListInstancesRequest