Class: Google::Cloud::Asset::V1::SearchAllResourcesRequest
- Inherits:
-
Object
- Object
- Google::Cloud::Asset::V1::SearchAllResourcesRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/asset/v1/asset_service.rb
Overview
Search all resources request.
Instance Attribute Summary collapse
-
#asset_types ⇒ ::Array<::String>
Optional.
-
#order_by ⇒ ::String
Optional.
-
#page_size ⇒ ::Integer
Optional.
-
#page_token ⇒ ::String
Optional.
-
#query ⇒ ::String
Optional.
-
#scope ⇒ ::String
Required.
Instance Attribute Details
#asset_types ⇒ ::Array<::String>
Returns Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types.
453 454 455 456 |
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 453 class SearchAllResourcesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#order_by ⇒ ::String
Returns 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 string fields in the response are
sortable, including name
, displayName
, description
, location
. 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.
453 454 455 456 |
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 453 class SearchAllResourcesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#page_size ⇒ ::Integer
Returns 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.
453 454 455 456 |
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 453 class SearchAllResourcesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#page_token ⇒ ::String
Returns 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.
453 454 455 456 |
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 453 class SearchAllResourcesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#query ⇒ ::String
Returns 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
. Note that the query string is
compared against each Cloud IAM policy binding, including its members,
roles, and Cloud IAM conditions. The returned Cloud IAM policies will only
contain the bindings that match your query. To learn more about the IAM
policy structure, see IAM policy
doc.
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 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 that have a label "env" and its value is "prod".labels.env:*
to find Cloud resources that have a label "env".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 in any of the searchable fields.*por*
to find Cloud resources that contain "por" as a substring 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.
453 454 455 456 |
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 453 class SearchAllResourcesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#scope ⇒ ::String
Returns 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").
453 454 455 456 |
# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 453 class SearchAllResourcesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |