Struct google_api_proto::google::cloud::compute::v1small::ListAddressesRequest

pub struct ListAddressesRequest {
    pub filter: Option<String>,
    pub max_results: Option<u32>,
    pub order_by: String,
    pub page_token: Option<String>,
    pub project: String,
    pub region: String,
}

A request message for Addresses.List. See the method description for details.

Fields

filter: Option<String>

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = “Intel Skylake”). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = “Intel Skylake”) OR (cpuPlatform = “Intel Broadwell”) AND (scheduling.automaticRestart = true).

max_results: Option<u32>

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

order_by: String

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy=“creationTimestamp desc”. This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

page_token: Option<String>

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

project: String

Project ID for this request.

region: String

Name of the region for this request.

Implementations

impl ListAddressesRequest

pub fn page_token(&self) -> &str

Returns the value of page_token, or the default value if page_token is unset.

pub fn max_results(&self) -> u32

Returns the value of max_results, or the default value if max_results is unset.

pub fn filter(&self) -> &str

Returns the value of filter, or the default value if filter is unset.

Trait Implementations

impl Clone for ListAddressesRequest

fn clone(&self) -> ListAddressesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListAddressesRequest

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

Formats the value using the given formatter.

impl Default for ListAddressesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListAddressesRequest

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for ListAddressesRequest

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