Struct SearchAllResourcesRequest

pub struct SearchAllResourcesRequest {
    pub scope: String,
    pub query: String,
    pub asset_types: Vec<String>,
    pub page_size: i32,
    pub page_token: String,
    pub order_by: String,
}

Search all resources request.

Fields

scope: String

Required. A scope can be a project, a folder or an organization. The search is limited to the resources within the scope.

The allowed values are:

• projects/{PROJECT_ID}
• projects/{PROJECT_NUMBER}
• folders/{FOLDER_NUMBER}
• organizations/{ORGANIZATION_NUMBER}

query: String

Optional. The query statement. An empty query can be specified to search all the resources of certain asset_types within the given scope.

Examples:

• name : "Important" to find Cloud resources whose name contains “Important” as a word.
• displayName : "Impor*" to find Cloud resources whose display name contains “Impor” as a word prefix.
• description : "*por*" to find Cloud resources whose description contains “por” as a substring.
• location : "us-west*" to find Cloud resources whose location is prefixed with “us-west”.
• labels : "prod" to find Cloud resources whose labels contain “prod” as a key or value.
• labels.env : "prod" to find Cloud resources which have a label “env” and its value is “prod”.
• labels.env : * to find Cloud resources which have a label “env”.
• "Important" to find Cloud resources which contain “Important” as a word in any of the searchable fields.
• "Impor*" to find Cloud resources which contain “Impor” as a word prefix in any of the searchable fields.
• "*por*" to find Cloud resources which contain “por” as a substring in any of the searchable fields.
• ("Important" AND location : ("us-west1" OR "global")) to find Cloud resources which contain “Important” as a word in any of the searchable fields and are also located in the “us-west1” region or the “global” location.

See how to construct a query for more details.

asset_types: Vec<String>

Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types.

page_size: i32

Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.

page_token: String

Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters, must be identical to those in the previous call.

order_by: String

Optional. A comma separated list of fields specifying the sorting order of the results. The default order is ascending. Add “ DESC“ after the field name to indicate descending order. Redundant space characters are ignored. Example: “location DESC, name”. See supported resource metadata fields for more details.

Trait Implementations

impl Clone for SearchAllResourcesRequest

fn clone(&self) -> SearchAllResourcesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchAllResourcesRequest

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

Formats the value using the given formatter.

impl Default for SearchAllResourcesRequest

fn default() -> SearchAllResourcesRequest

Returns the “default value” for a type.

impl Message for SearchAllResourcesRequest

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_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 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 SearchAllResourcesRequest

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