Struct gapi_grpc::google::cloud::asset::v1::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 caller must be granted the cloudasset.assets.searchAllResources permission on the desired scope.

The allowed values are:

• projects/{PROJECT_ID} (e.g., “projects/foo-bar”)
• projects/{PROJECT_NUMBER} (e.g., “projects/12345678”)
• folders/{FOLDER_NUMBER} (e.g., “folders/1234567”)
• organizations/{ORGANIZATION_NUMBER} (e.g., “organizations/123456”)

query: String

Optional. The query statement. See how to construct a query for more information. If not specified or empty, it will search all the resources within the specified scope.

Examples:

• name:Important to find Cloud resources whose name contains “Important” as a word.
• name=Important to find the Cloud resource whose name is exactly “Important”.
• displayName:Impor* to find Cloud resources whose display name contains “Impor” as a prefix of any word in the field.
• location:us-west* to find Cloud resources whose location contains both “us” and “west” as prefixes.
• labels:prod to find Cloud resources whose labels contain “prod” as a key or value.
• labels.env:prod to find Cloud resources that have a label “env” and its value is “prod”.
• labels.env:* to find Cloud resources that have a label “env”.
• kmsKey:key to find Cloud resources encrypted with a customer-managed encryption key whose name contains the word “key”.
• state:ACTIVE to find Cloud resources whose state contains “ACTIVE” as a word.
• NOT state:ACTIVE to find {{gcp_name}} resources whose state doesn’t contain “ACTIVE” as a word.
• createTime<1609459200 to find Cloud resources that were created before “2021-01-01 00:00:00 UTC”. 1609459200 is the epoch timestamp of “2021-01-01 00:00:00 UTC” in seconds.
• updateTime>1609459200 to find Cloud resources that were updated after “2021-01-01 00:00:00 UTC”. 1609459200 is the epoch timestamp of “2021-01-01 00:00:00 UTC” in seconds.
• Important to find Cloud resources that contain “Important” as a word in any of the searchable fields.
• Impor* to find Cloud resources that contain “Impor” as a prefix of any word in any of the searchable fields.
• Important location:(us-west1 OR global) to find Cloud resources that contain “Important” as a word in any of the searchable fields and are also located in the “us-west1” region or the “global” location.

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.

Regular expressions are also supported. For example:

• “compute.googleapis.com.*” snapshots resources whose asset type starts with “compute.googleapis.com”.
• “.*Instance” snapshots resources whose asset type ends with “Instance”.
• “.Instance.” snapshots resources whose asset type contains “Instance”.

See RE2 for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.

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”. Only singular primitive fields in the response are sortable:

• name
• assetType
• project
• displayName
• description
• location
• kmsKey
• createTime
• updateTime
• state
• parentFullResourceName
• parentAssetType All the other fields such as repeated fields (e.g., networkTags), map fields (e.g., labels) and struct fields (e.g., additionalAttributes) are not supported.

Trait Implementations

impl Clone for SearchAllResourcesRequest

fn clone(&self) -> SearchAllResourcesRequest

Returns a copy of the value.

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

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<SearchAllResourcesRequest> for SearchAllResourcesRequest

fn eq(&self, other: &SearchAllResourcesRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SearchAllResourcesRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for SearchAllResourcesRequest