pub struct AggregatedListAddressesRequest {
pub filter: Option<String>,
pub include_all_scopes: Option<bool>,
pub max_results: Option<u32>,
pub order_by: Option<String>,
pub page_token: Option<String>,
pub project: String,
}
Expand description
A request message for Addresses.AggregatedList. 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)
include_all_scopes: Option<bool>
Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
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: Option<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.
Implementations§
source§impl AggregatedListAddressesRequest
impl AggregatedListAddressesRequest
sourcepub fn page_token(&self) -> &str
pub fn page_token(&self) -> &str
Returns the value of page_token
, or the default value if page_token
is unset.
sourcepub fn max_results(&self) -> u32
pub fn max_results(&self) -> u32
Returns the value of max_results
, or the default value if max_results
is unset.
sourcepub fn order_by(&self) -> &str
pub fn order_by(&self) -> &str
Returns the value of order_by
, or the default value if order_by
is unset.
sourcepub fn filter(&self) -> &str
pub fn filter(&self) -> &str
Returns the value of filter
, or the default value if filter
is unset.
sourcepub fn include_all_scopes(&self) -> bool
pub fn include_all_scopes(&self) -> bool
Returns the value of include_all_scopes
, or the default value if include_all_scopes
is unset.
Trait Implementations§
source§impl Clone for AggregatedListAddressesRequest
impl Clone for AggregatedListAddressesRequest
source§fn clone(&self) -> AggregatedListAddressesRequest
fn clone(&self) -> AggregatedListAddressesRequest
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Message for AggregatedListAddressesRequest
impl Message for AggregatedListAddressesRequest
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
source§fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
. Read moresource§fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
.source§impl PartialEq for AggregatedListAddressesRequest
impl PartialEq for AggregatedListAddressesRequest
source§fn eq(&self, other: &AggregatedListAddressesRequest) -> bool
fn eq(&self, other: &AggregatedListAddressesRequest) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AggregatedListAddressesRequest
Auto Trait Implementations§
impl Freeze for AggregatedListAddressesRequest
impl RefUnwindSafe for AggregatedListAddressesRequest
impl Send for AggregatedListAddressesRequest
impl Sync for AggregatedListAddressesRequest
impl Unpin for AggregatedListAddressesRequest
impl UnwindSafe for AggregatedListAddressesRequest
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request