Class ResourceSearchResult (2.2.1)

ResourceSearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

NameDescription
name str
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
asset_type str
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 str
The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}. To search against the ``project``: - specify the ``scope`` field as this project in your search request.
display_name str
The display name of this resource. To search against the ``display_name``: - use a field query. Example: ``displayName:"My Instance"`` - use a free text query. Example: ``"My Instance"``
description str
One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. To search against the ``description``: - use a field query. Example: ``description:"*important instance*"`` - use a free text query. Example: ``"*important instance*"``
location str
Location can be ``global``, regional like ``us-east1``, or zonal like ``us-west1-b``. To search against the ``location``: - use a field query. Example: ``location:us-west*`` - use a free text query. Example: ``us-west*``
labels Sequence[`.assets.ResourceSearchResult.LabelsEntry`]
Labels associated with this resource. See `Labelling and grouping GCP resources
network_tags Sequence[str]
Network tags associated with this resource. Like labels, network tags are a type of annotations used to group GCP resources. See `Labelling GCP resources
additional_attributes `.struct.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

Inheritance

builtins.object > proto.message.Message > ResourceSearchResult

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, `.Message`]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.