KMS Inventory v1 API - Class SearchProtectedResourcesRequest (1.5.0) 

public sealed class SearchProtectedResourcesRequest : IMessage<SearchProtectedResourcesRequest>, IEquatable<SearchProtectedResourcesRequest>, IDeepCloneable<SearchProtectedResourcesRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the KMS Inventory v1 API class SearchProtectedResourcesRequest.

Request message for [KeyTrackingService.SearchProtectedResources][google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources].

Inheritance

object > SearchProtectedResourcesRequest

Namespace

Google.Cloud.Kms.Inventory.V1

Assembly

Google.Cloud.Kms.Inventory.V1.dll

Constructors

SearchProtectedResourcesRequest()

public SearchProtectedResourcesRequest()

SearchProtectedResourcesRequest(SearchProtectedResourcesRequest)

public SearchProtectedResourcesRequest(SearchProtectedResourcesRequest other)
Parameter
Name Description
other SearchProtectedResourcesRequest

Properties

CryptoKey

public string CryptoKey { get; set; }

Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].

Property Value
Type Description
string

CryptoKeyAsResourceName

public IResourceName CryptoKeyAsResourceName { get; set; }

IResourceName-typed view over the CryptoKey resource name property.

Property Value
Type Description
IResourceName

PageSize

public int PageSize { get; set; }

The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

A page token, received from a previous [KeyTrackingService.SearchProtectedResources][google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [KeyTrackingService.SearchProtectedResources][google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources] must match the call that provided the page token.

Property Value
Type Description
string

ResourceTypes

public RepeatedField<string> ResourceTypes { get; }

Optional. A list of resource types that this request searches for. If empty, it will search all the trackable resource types.

Regular expressions are also supported. For example:

  • compute.googleapis.com.* snapshots resources whose type starts with compute.googleapis.com.
  • .*Image snapshots resources whose type ends with Image.
  • .*Image.* snapshots resources whose type contains Image.

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

Property Value
Type Description
RepeatedFieldstring

Scope

public string Scope { get; set; }

Required. Resource name of the organization. Example: organizations/123

Property Value
Type Description
string

ScopeAsOrganizationName

public OrganizationName ScopeAsOrganizationName { get; set; }

OrganizationName-typed view over the Scope resource name property.

Property Value
Type Description
OrganizationName