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

Class SearchProtectedResourcesRequest.Builder

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProtectedResourcesRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProtectedResourcesRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProtectedResourcesRequest.Builder>

      • getScope

        public String getScope()
         Required. Resource name of the organization.
 Example: organizations/123
        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. Resource name of the organization.
 Example: organizations/123
        string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getScopeBytes in interface SearchProtectedResourcesRequestOrBuilder
        Returns:
        The bytes for scope.

      • setScope

        public SearchProtectedResourcesRequest.Builder setScope​(String value)
         Required. Resource name of the organization.
 Example: organizations/123
        string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The scope to set.
        Returns:
        This builder for chaining.

      • clearScope

        public SearchProtectedResourcesRequest.Builder clearScope()
         Required. Resource name of the organization.
 Example: organizations/123
        string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setScopeBytes

        public SearchProtectedResourcesRequest.Builder setScopeBytes​(com.google.protobuf.ByteString value)
         Required. Resource name of the organization.
 Example: organizations/123
        string scope = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for scope to set.
        Returns:
        This builder for chaining.

      • 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.

      • setCryptoKey

        public SearchProtectedResourcesRequest.Builder setCryptoKey​(String value)
         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) = { ... }
        Parameters:
        value - The cryptoKey to set.
        Returns:
        This builder for chaining.

      • clearCryptoKey

        public SearchProtectedResourcesRequest.Builder clearCryptoKey()
         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:
        This builder for chaining.

      • setCryptoKeyBytes

        public SearchProtectedResourcesRequest.Builder setCryptoKeyBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for cryptoKey to set.
        Returns:
        This builder for chaining.

      • 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.

      • setPageSize

        public SearchProtectedResourcesRequest.Builder setPageSize​(int value)
         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;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public SearchProtectedResourcesRequest.Builder clearPageSize()
         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:
        This builder for chaining.

      • 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.

      • setPageToken

        public SearchProtectedResourcesRequest.Builder setPageToken​(String value)
         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;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public SearchProtectedResourcesRequest.Builder clearPageToken()
         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:
        This builder for chaining.

      • setPageTokenBytes

        public SearchProtectedResourcesRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • 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.

      • setResourceTypes

        public SearchProtectedResourcesRequest.Builder setResourceTypes​(int index,
                                                                String value)
         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 to set the value at.
        value - The resourceTypes to set.
        Returns:
        This builder for chaining.

      • addResourceTypes

        public SearchProtectedResourcesRequest.Builder addResourceTypes​(String value)
         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:
        value - The resourceTypes to add.
        Returns:
        This builder for chaining.

      • addAllResourceTypes

        public SearchProtectedResourcesRequest.Builder addAllResourceTypes​(Iterable<String> values)
         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:
        values - The resourceTypes to add.
        Returns:
        This builder for chaining.

      • clearResourceTypes

        public SearchProtectedResourcesRequest.Builder clearResourceTypes()
         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:
        This builder for chaining.

      • addResourceTypesBytes

        public SearchProtectedResourcesRequest.Builder addResourceTypesBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the resourceTypes to add.
        Returns:
        This builder for chaining.