Struct google_api_proto::google::cloud::compute::v1::ListNetworkAttachmentsRequest
source · pub struct ListNetworkAttachmentsRequest {
pub filter: Option<String>,
pub max_results: Option<u32>,
pub order_by: Option<String>,
pub page_token: Option<String>,
pub project: String,
pub region: String,
pub return_partial_success: Option<bool>,
}
Expand description
A request message for NetworkAttachments.List. See the method description for details.
Fields§
§filter: Option<String>
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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
. The :*
comparison can be used to test whether a key has been defined. For example, to find all objects with owner
label use: labels.owner:*
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)
If you want to use a regular expression, use the eq
(equal) or ne
(not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal
fieldname eq 'single quoted literal'
fieldname eq "double quoted literal"
(fieldname1 eq literal) (fieldname2 ne "literal")
The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name “instance”, you would use name ne .*instance
. You cannot combine constraints on multiple fields using regular expressions.
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.
region: String
Name of the region of this request.
return_partial_success: Option<bool>
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Implementations§
source§impl ListNetworkAttachmentsRequest
impl ListNetworkAttachmentsRequest
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 return_partial_success(&self) -> bool
pub fn return_partial_success(&self) -> bool
Returns the value of return_partial_success
, or the default value if return_partial_success
is unset.
Trait Implementations§
source§impl Clone for ListNetworkAttachmentsRequest
impl Clone for ListNetworkAttachmentsRequest
source§fn clone(&self) -> ListNetworkAttachmentsRequest
fn clone(&self) -> ListNetworkAttachmentsRequest
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Message for ListNetworkAttachmentsRequest
impl Message for ListNetworkAttachmentsRequest
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
source§fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where
Self: Sized,
fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where
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(
&self,
buf: &mut impl BufMut,
) -> Result<(), EncodeError>where
Self: Sized,
fn encode_length_delimited(
&self,
buf: &mut impl BufMut,
) -> Result<(), EncodeError>where
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(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
fn decode(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
source§fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
source§fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
self
. Read moresource§fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
self
.source§impl PartialEq for ListNetworkAttachmentsRequest
impl PartialEq for ListNetworkAttachmentsRequest
source§fn eq(&self, other: &ListNetworkAttachmentsRequest) -> bool
fn eq(&self, other: &ListNetworkAttachmentsRequest) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ListNetworkAttachmentsRequest
Auto Trait Implementations§
impl Freeze for ListNetworkAttachmentsRequest
impl RefUnwindSafe for ListNetworkAttachmentsRequest
impl Send for ListNetworkAttachmentsRequest
impl Sync for ListNetworkAttachmentsRequest
impl Unpin for ListNetworkAttachmentsRequest
impl UnwindSafe for ListNetworkAttachmentsRequest
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