Package com.google.cloud.kms.inventory.v1

Interface SearchProtectedResourcesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchProtectedResourcesRequest, SearchProtectedResourcesRequest.Builder
@Generated public interface SearchProtectedResourcesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCryptoKey()
    Required.
    com.google.protobuf.ByteString
    getCryptoKeyBytes()
    Required.
    int
    getPageSize()
    The maximum number of resources to return.
    String
    getPageToken()
    A page token, received from a previous [KeyTrackingService.SearchProtectedResources][google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources] call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous [KeyTrackingService.SearchProtectedResources][google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources] call.
    String
    getResourceTypes(int index)
    Optional.
    com.google.protobuf.ByteString
    getResourceTypesBytes(int index)
    Optional.
    int
    getResourceTypesCount()
    Optional.
    List<String>
    getResourceTypesList()
    Optional.
    String
    getScope()
    Required.
    com.google.protobuf.ByteString
    getScopeBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getScope

      String getScope()
       Required. A scope can be an organization or a project. Resources protected
 by the crypto key in provided scope will be returned.

 The following values are allowed:

 * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/12345678")
 * projects/{PROJECT_ID} (e.g., "projects/foo-bar")
 * projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
      string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The scope.

    • getScopeBytes

      com.google.protobuf.ByteString getScopeBytes()
       Required. A scope can be an organization or a project. Resources protected
 by the crypto key in provided scope will be returned.

 The following values are allowed:

 * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/12345678")
 * projects/{PROJECT_ID} (e.g., "projects/foo-bar")
 * projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
      string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for scope.

    • getCryptoKey

      String getCryptoKey()
       Required. The resource name of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey].
      string crypto_key = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The cryptoKey.

    • getCryptoKeyBytes

      com.google.protobuf.ByteString getCryptoKeyBytes()
       Required. The resource name of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey].
      string crypto_key = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for cryptoKey.

    • getPageSize

      int getPageSize()
       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.
      int32 page_size = 3;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       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.
      string page_token = 4;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       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.
      string page_token = 4;
      Returns:
      The bytes for pageToken.

    • getResourceTypesList

      List<String> getResourceTypesList()
       Optional. A list of resource types that this request searches for. If
 empty, it will search all the [trackable resource
 types](https://cloud.google.com/kms/docs/view-key-usage#tracked-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](https://github.com/google/re2/wiki/Syntax) for all supported
 regular expression syntax. If the regular expression does not match any
 supported resource type, an INVALID_ARGUMENT error will be returned.
      repeated string resource_types = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the resourceTypes.

    • getResourceTypesCount

      int getResourceTypesCount()
       Optional. A list of resource types that this request searches for. If
 empty, it will search all the [trackable resource
 types](https://cloud.google.com/kms/docs/view-key-usage#tracked-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](https://github.com/google/re2/wiki/Syntax) for all supported
 regular expression syntax. If the regular expression does not match any
 supported resource type, an INVALID_ARGUMENT error will be returned.
      repeated string resource_types = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of resourceTypes.

    • getResourceTypes

      String getResourceTypes(int index)
       Optional. A list of resource types that this request searches for. If
 empty, it will search all the [trackable resource
 types](https://cloud.google.com/kms/docs/view-key-usage#tracked-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](https://github.com/google/re2/wiki/Syntax) for all supported
 regular expression syntax. If the regular expression does not match any
 supported resource type, an INVALID_ARGUMENT error will be returned.
      repeated string resource_types = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The resourceTypes at the given index.

    • getResourceTypesBytes

      com.google.protobuf.ByteString getResourceTypesBytes(int index)
       Optional. A list of resource types that this request searches for. If
 empty, it will search all the [trackable resource
 types](https://cloud.google.com/kms/docs/view-key-usage#tracked-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](https://github.com/google/re2/wiki/Syntax) for all supported
 regular expression syntax. If the regular expression does not match any
 supported resource type, an INVALID_ARGUMENT error will be returned.
      repeated string resource_types = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resourceTypes at the given index.