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

Class SearchProtectedResourcesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.kms.inventory.v1.SearchProtectedResourcesRequest
All Implemented Interfaces:
SearchProtectedResourcesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchProtectedResourcesRequest extends com.google.protobuf.GeneratedMessage implements SearchProtectedResourcesRequestOrBuilder
 Request message for
 [KeyTrackingService.SearchProtectedResources][google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources].
Protobuf type google.cloud.kms.inventory.v1.SearchProtectedResourcesRequest
See Also:

  • Field Details

    • SCOPE_FIELD_NUMBER

      public static final int SCOPE_FIELD_NUMBER
      See Also:

    • CRYPTO_KEY_FIELD_NUMBER

      public static final int CRYPTO_KEY_FIELD_NUMBER
      See Also:

    • PAGE_SIZE_FIELD_NUMBER

      public static final int PAGE_SIZE_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

    • RESOURCE_TYPES_FIELD_NUMBER

      public static final int RESOURCE_TYPES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getScope

      public 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) = { ... }
      Specified by:
      getScope in interface SearchProtectedResourcesRequestOrBuilder
      Returns:
      The scope.

    • getScopeBytes

      public 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) = { ... }
      Specified by:
      getScopeBytes in interface SearchProtectedResourcesRequestOrBuilder
      Returns:
      The bytes for scope.

    • getCryptoKey

      public 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) = { ... }
      Specified by:
      getCryptoKey in interface SearchProtectedResourcesRequestOrBuilder
      Returns:
      The cryptoKey.

    • getCryptoKeyBytes

      public 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) = { ... }
      Specified by:
      getCryptoKeyBytes in interface SearchProtectedResourcesRequestOrBuilder
      Returns:
      The bytes for cryptoKey.

    • getPageSize

      public 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;
      Specified by:
      getPageSize in interface SearchProtectedResourcesRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public 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;
      Specified by:
      getPageToken in interface SearchProtectedResourcesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public 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;
      Specified by:
      getPageTokenBytes in interface SearchProtectedResourcesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getResourceTypesList

      public com.google.protobuf.ProtocolStringList 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];
      Specified by:
      getResourceTypesList in interface SearchProtectedResourcesRequestOrBuilder
      Returns:
      A list containing the resourceTypes.

    • getResourceTypesCount

      public 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];
      Specified by:
      getResourceTypesCount in interface SearchProtectedResourcesRequestOrBuilder
      Returns:
      The count of resourceTypes.

    • getResourceTypes

      public 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];
      Specified by:
      getResourceTypes in interface SearchProtectedResourcesRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The resourceTypes at the given index.

    • getResourceTypesBytes

      public 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];
      Specified by:
      getResourceTypesBytes in interface SearchProtectedResourcesRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the resourceTypes at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchProtectedResourcesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchProtectedResourcesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchProtectedResourcesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchProtectedResourcesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchProtectedResourcesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchProtectedResourcesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchProtectedResourcesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchProtectedResourcesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchProtectedResourcesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchProtectedResourcesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchProtectedResourcesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchProtectedResourcesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchProtectedResourcesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchProtectedResourcesRequest.Builder newBuilder()

    • newBuilder

      public static SearchProtectedResourcesRequest.Builder newBuilder(SearchProtectedResourcesRequest prototype)

    • toBuilder

      public SearchProtectedResourcesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchProtectedResourcesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchProtectedResourcesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchProtectedResourcesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchProtectedResourcesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SearchProtectedResourcesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder