Show / Hide Table of Contents

Class V1Resource.SearchAllResourcesRequest

Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the cloudasset.assets.searchAllResources permission on the desired scope, otherwise the request will be rejected.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SearchAllResourcesResponse>
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>
V1Resource.SearchAllResourcesRequest
Implements
IClientServiceRequest<SearchAllResourcesResponse>
IClientServiceRequest
Inherited Members
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.Xgafv
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.AccessToken
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.Alt
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.Callback
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.Fields
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.Key
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.OauthToken
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.PrettyPrint
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.QuotaUser
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.UploadType
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.UploadProtocol
ClientServiceRequest<SearchAllResourcesResponse>.Execute()
ClientServiceRequest<SearchAllResourcesResponse>.ExecuteAsStream()
ClientServiceRequest<SearchAllResourcesResponse>.ExecuteAsync()
ClientServiceRequest<SearchAllResourcesResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<SearchAllResourcesResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<SearchAllResourcesResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<SearchAllResourcesResponse>.CreateRequest(bool?)
ClientServiceRequest<SearchAllResourcesResponse>.GenerateRequestUri()
ClientServiceRequest<SearchAllResourcesResponse>.GetBody()
ClientServiceRequest<SearchAllResourcesResponse>.GetDefaultETagAction(string)
ClientServiceRequest<SearchAllResourcesResponse>.ETagAction
ClientServiceRequest<SearchAllResourcesResponse>.ModifyRequest
ClientServiceRequest<SearchAllResourcesResponse>.ValidateParameters
ClientServiceRequest<SearchAllResourcesResponse>.RequestParameters
ClientServiceRequest<SearchAllResourcesResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudAsset.v1
Assembly: Google.Apis.CloudAsset.v1.dll
Syntax
public class V1Resource.SearchAllResourcesRequest : CloudAssetBaseServiceRequest<SearchAllResourcesResponse>, IClientServiceRequest<SearchAllResourcesResponse>, IClientServiceRequest

Constructors

SearchAllResourcesRequest(IClientService, string)

Constructs a new SearchAllResources request.

Declaration
public SearchAllResourcesRequest(IClientService service, string scope)
Parameters
Type Name Description
IClientService service
string scope

Properties

AssetTypes

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.

Declaration
[RequestParameter("assetTypes", RequestParameterType.Query)]
public virtual Repeatable<string> AssetTypes { get; set; }
Property Value
Type Description
Repeatable<string>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudAsset.v1.Data.SearchAllResourcesResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudAsset.v1.Data.SearchAllResourcesResponse>.MethodName

OrderBy

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 * createTime * updateTime * state * parentFullResourceName * parentAssetType All the other fields such as repeated fields (e.g., networkTags, kmsKeys), map fields (e.g., labels) and struct fields (e.g., additionalAttributes) are not supported.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PageSize

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 or a negative value, 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.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

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.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Query

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 Google Cloud resources whose name contains "Important" as a word. * name=Important to find the Google Cloud resource whose name is exactly "Important". * displayName:Impor* to find Google Cloud resources whose display name contains "Impor" as a prefix of any word in the field. * location:us-west* to find Google Cloud resources whose location contains both "us" and "west" as prefixes. * labels:prod to find Google Cloud resources whose labels contain "prod" as a key or value. * labels.env:prod to find Google Cloud resources that have a label "env" and its value is "prod". * labels.env:* to find Google Cloud resources that have a label "env". * kmsKey:key to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains "key" as a word. This field is deprecated. Please use the kmsKeys field to retrieve Cloud KMS key information. * kmsKeys:key to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word "key". * relationships:instance-group-1 to find Google Cloud resources that have relationships with "instance-group-1" in the related resource name. * relationships:INSTANCE_TO_INSTANCEGROUP to find Compute Engine instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP". * relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1 to find Compute Engine instances that have relationships with "instance-group-1" in the Compute Engine instance group resource name, for relationship type "INSTANCE_TO_INSTANCEGROUP". * state:ACTIVE to find Google Cloud resources whose state contains "ACTIVE" as a word. * NOT state:ACTIVE to find Google Cloud resources whose state doesn't contain "ACTIVE" as a word. * createTime&lt;1609459200 to find Google 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&gt;1609459200 to find Google 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 Google Cloud resources that contain "Important" as a word in any of the searchable fields. * Impor* to find Google 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 Google 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.

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

ReadMask

Optional. A comma-separated list of fields that you want returned in the results. The following fields are returned by default if not specified: * name * assetType * project * folders * organization * displayName * description * location * labels * networkTags * kmsKeys * createTime * updateTime * state * additionalAttributes * parentFullResourceName * parentAssetType Some fields of large size, such as versionedResources and attachedResources, are not returned by default, but you can specify them in the read_mask parameter if you want to include them. If "*" is specified, all available fields are returned. Examples: "name,location", "name,versionedResources", "*". Any invalid field path will trigger INVALID_ARGUMENT error.

Declaration
[RequestParameter("readMask", RequestParameterType.Query)]
public virtual object ReadMask { get; set; }
Property Value
Type Description
object

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudAsset.v1.Data.SearchAllResourcesResponse>.RestPath

Scope

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")

Declaration
[RequestParameter("scope", RequestParameterType.Path)]
public virtual string Scope { get; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes SearchAllResources parameter list.

Declaration
protected override void InitParameters()
Overrides
CloudAssetBaseServiceRequest<SearchAllResourcesResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In This Article
Back to top Generated by DocFX