Struct gapi_grpc::google::cloud::asset::v1::ResourceSearchResult

pub struct ResourceSearchResult {
    pub name: String,
    pub asset_type: String,
    pub project: String,
    pub folders: Vec<String>,
    pub organization: String,
    pub display_name: String,
    pub description: String,
    pub location: String,
    pub labels: HashMap<String, String>,
    pub network_tags: Vec<String>,
    pub kms_key: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub state: String,
    pub additional_attributes: Option<Struct>,
    pub parent_full_resource_name: String,
    pub parent_asset_type: String,
}

A result of Resource Search, containing information of a cloud resource.

Fields

name: String

The full resource name of this resource. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1. See Cloud Asset Inventory Resource Name Format for more information.

To search against the name:

• use a field query. Example: name:instance1
• use a free text query. Example: instance1

asset_type: String

The type of this resource. Example: compute.googleapis.com/Disk.

To search against the asset_type:

• specify the asset_type field in your search request.

project: String

The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}. This field is available when the resource belongs to a project.

To search against project:

• use a field query. Example: project:12345
• use a free text query. Example: 12345
• specify the scope field as this project in your search request.

folders: Vec<String>

The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders.

To search against folders:

• use a field query. Example: folders:(123 OR 456)
• use a free text query. Example: 123
• specify the scope field as this folder in your search request.

organization: String

The organization that this resource belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the resource belongs to an organization.

To search against organization:

• use a field query. Example: organization:123
• use a free text query. Example: 123
• specify the scope field as this organization in your search request.

display_name: String

The display name of this resource. This field is available only when the resource’s proto contains it.

To search against the display_name:

• use a field query. Example: displayName:"My Instance"
• use a free text query. Example: "My Instance"

description: String

One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. This field is available only when the resource’s proto contains it.

To search against the description:

• use a field query. Example: description:"important instance"
• use a free text query. Example: "important instance"

location: String

Location can be global, regional like us-east1, or zonal like us-west1-b. This field is available only when the resource’s proto contains it.

To search against the location:

• use a field query. Example: location:us-west*
• use a free text query. Example: us-west*

labels: HashMap<String, String>

Labels associated with this resource. See Labelling and grouping GCP resources for more information. This field is available only when the resource’s proto contains it.

To search against the labels:

• use a field query:
  • query on any label’s key or value. Example: labels:prod
  • query by a given label. Example: labels.env:prod
  • query by a given label’s existence. Example: labels.env:*
• use a free text query. Example: prod

network_tags: Vec<String>

Network tags associated with this resource. Like labels, network tags are a type of annotations used to group GCP resources. See Labelling GCP resources for more information. This field is available only when the resource’s proto contains it.

To search against the network_tags:

• use a field query. Example: networkTags:internal
• use a free text query. Example: internal

kms_key: String

The Cloud KMS CryptoKey name or CryptoKeyVersion name. This field is available only when the resource’s proto contains it.

To search against the kms_key:

• use a field query. Example: kmsKey:key
• use a free text query. Example: key

create_time: Option<Timestamp>

The create timestamp of this resource, at which the resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource’s proto contains it.

To search against create_time:

• use a field query.
  • value in seconds since unix epoch. Example: createTime > 1609459200
  • value in date string. Example: createTime > 2021-01-01
  • value in date-time string (must be quoted). Example: createTime > "2021-01-01T00:00:00"

update_time: Option<Timestamp>

The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource’s proto contains it.

To search against update_time:

• use a field query.
  • value in seconds since unix epoch. Example: updateTime < 1609459200
  • value in date string. Example: updateTime < 2021-01-01
  • value in date-time string (must be quoted). Example: updateTime < "2021-01-01T00:00:00"

state: String

The state of this resource. Different resources types have different state definitions that are mapped from various fields of different resource types. This field is available only when the resource’s proto contains it.

Example: If the resource is an instance provided by Compute Engine, its state will include PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. See status definition in API Reference. If the resource is a project provided by Cloud Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See lifecycleState definition in API Reference.

To search against the state:

• use a field query. Example: state:RUNNING
• use a free text query. Example: RUNNING

additional_attributes: Option<Struct>

The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: projectId for Project, dnsName for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding GCP service (e.g., Compute Engine). see API references and supported searchable attributes to see which fields are included.

You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the GCP service updates to a new incompatible API version.

To search against the additional_attributes:

• use a free text query to match the attributes values. Example: to search additional_attributes = { dnsName: "foobar" }, you can issue a query foobar.

parent_full_resource_name: String

The full resource name of this resource’s parent, if it has one. To search against the parent_full_resource_name:

• use a field query. Example: parentFullResourceName:"project-name"
• use a free text query. Example: project-name

parent_asset_type: String

The type of this resource’s immediate parent, if there is one.

To search against the parent_asset_type:

• use a field query. Example: parentAssetType:"cloudresourcemanager.googleapis.com/Project"
• use a free text query. Example: cloudresourcemanager.googleapis.com/Project

Trait Implementations

impl Clone for ResourceSearchResult

fn clone(&self) -> ResourceSearchResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceSearchResult

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

Formats the value using the given formatter.

impl Default for ResourceSearchResult

fn default() -> ResourceSearchResult

Returns the “default value” for a type.

impl Message for ResourceSearchResult

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<ResourceSearchResult> for ResourceSearchResult

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

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

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

This method tests for !=.

impl StructuralPartialEq for ResourceSearchResult