Package com.google.cloud.kms.v1

Class ListSingleTenantHsmInstancesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListSingleTenantHsmInstancesRequest.Builder>
com.google.cloud.kms.v1.ListSingleTenantHsmInstancesRequest.Builder
All Implemented Interfaces:
ListSingleTenantHsmInstancesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListSingleTenantHsmInstancesRequest
public static final class ListSingleTenantHsmInstancesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListSingleTenantHsmInstancesRequest.Builder> implements ListSingleTenantHsmInstancesRequestOrBuilder
 Request message for
 [HsmManagement.ListSingleTenantHsmInstances][google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances].
Protobuf type google.cloud.kms.v1.ListSingleTenantHsmInstancesRequest

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

    • clear

      public ListSingleTenantHsmInstancesRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListSingleTenantHsmInstancesRequest.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.GeneratedMessage.Builder<ListSingleTenantHsmInstancesRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ListSingleTenantHsmInstancesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSingleTenantHsmInstancesRequest.Builder>

    • mergeFrom

      public ListSingleTenantHsmInstancesRequest.Builder mergeFrom(ListSingleTenantHsmInstancesRequest other)

    • isInitialized

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

    • mergeFrom

      public ListSingleTenantHsmInstancesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSingleTenantHsmInstancesRequest.Builder>
      Throws:
      IOException

    • getParent

      public String getParent()
       Required. The resource name of the location associated with the
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to
 list, in the format `projects/*/locations/*`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListSingleTenantHsmInstancesRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the location associated with the
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to
 list, in the format `projects/*/locations/*`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListSingleTenantHsmInstancesRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public ListSingleTenantHsmInstancesRequest.Builder setParent(String value)
       Required. The resource name of the location associated with the
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to
 list, in the format `projects/*/locations/*`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListSingleTenantHsmInstancesRequest.Builder clearParent()
       Required. The resource name of the location associated with the
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to
 list, in the format `projects/*/locations/*`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public ListSingleTenantHsmInstancesRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. The resource name of the location associated with the
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to
 list, in the format `projects/*/locations/*`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public int getPageSize()
       Optional. Optional limit on the number of
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to
 include in the response. Further
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] can
 subsequently be
 obtained by including the
 [ListSingleTenantHsmInstancesResponse.next_page_token][google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token]
 in a subsequent request. If unspecified, the server will pick an
 appropriate default.
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface ListSingleTenantHsmInstancesRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListSingleTenantHsmInstancesRequest.Builder setPageSize(int value)
       Optional. Optional limit on the number of
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to
 include in the response. Further
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] can
 subsequently be
 obtained by including the
 [ListSingleTenantHsmInstancesResponse.next_page_token][google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token]
 in a subsequent request. If unspecified, the server will pick an
 appropriate default.
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListSingleTenantHsmInstancesRequest.Builder clearPageSize()
       Optional. Optional limit on the number of
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to
 include in the response. Further
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] can
 subsequently be
 obtained by including the
 [ListSingleTenantHsmInstancesResponse.next_page_token][google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token]
 in a subsequent request. If unspecified, the server will pick an
 appropriate default.
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       Optional. Optional pagination token, returned earlier via
 [ListSingleTenantHsmInstancesResponse.next_page_token][google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token].
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface ListSingleTenantHsmInstancesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. Optional pagination token, returned earlier via
 [ListSingleTenantHsmInstancesResponse.next_page_token][google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token].
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface ListSingleTenantHsmInstancesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListSingleTenantHsmInstancesRequest.Builder setPageToken(String value)
       Optional. Optional pagination token, returned earlier via
 [ListSingleTenantHsmInstancesResponse.next_page_token][google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token].
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListSingleTenantHsmInstancesRequest.Builder clearPageToken()
       Optional. Optional pagination token, returned earlier via
 [ListSingleTenantHsmInstancesResponse.next_page_token][google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token].
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListSingleTenantHsmInstancesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       Optional. Optional pagination token, returned earlier via
 [ListSingleTenantHsmInstancesResponse.next_page_token][google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token].
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getFilter

      public String getFilter()
       Optional. Only include resources that match the filter in the response. For
 more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface ListSingleTenantHsmInstancesRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Optional. Only include resources that match the filter in the response. For
 more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterBytes in interface ListSingleTenantHsmInstancesRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public ListSingleTenantHsmInstancesRequest.Builder setFilter(String value)
       Optional. Only include resources that match the filter in the response. For
 more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListSingleTenantHsmInstancesRequest.Builder clearFilter()
       Optional. Only include resources that match the filter in the response. For
 more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setFilterBytes

      public ListSingleTenantHsmInstancesRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       Optional. Only include resources that match the filter in the response. For
 more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getOrderBy

      public String getOrderBy()
       Optional. Specify how the results should be sorted. If not specified, the
 results will be sorted in the default order.  For more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOrderBy in interface ListSingleTenantHsmInstancesRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.ByteString getOrderByBytes()
       Optional. Specify how the results should be sorted. If not specified, the
 results will be sorted in the default order.  For more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOrderByBytes in interface ListSingleTenantHsmInstancesRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • setOrderBy

      public ListSingleTenantHsmInstancesRequest.Builder setOrderBy(String value)
       Optional. Specify how the results should be sorted. If not specified, the
 results will be sorted in the default order.  For more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • clearOrderBy

      public ListSingleTenantHsmInstancesRequest.Builder clearOrderBy()
       Optional. Specify how the results should be sorted. If not specified, the
 results will be sorted in the default order.  For more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setOrderByBytes

      public ListSingleTenantHsmInstancesRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       Optional. Specify how the results should be sorted. If not specified, the
 results will be sorted in the default order.  For more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.

    • getShowDeleted

      public boolean getShowDeleted()
       Optional. If set to true,
 [HsmManagement.ListSingleTenantHsmInstances][google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances]
 will also return
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] in
 DELETED state.
      bool show_deleted = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getShowDeleted in interface ListSingleTenantHsmInstancesRequestOrBuilder
      Returns:
      The showDeleted.

    • setShowDeleted

      public ListSingleTenantHsmInstancesRequest.Builder setShowDeleted(boolean value)
       Optional. If set to true,
 [HsmManagement.ListSingleTenantHsmInstances][google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances]
 will also return
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] in
 DELETED state.
      bool show_deleted = 6 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The showDeleted to set.
      Returns:
      This builder for chaining.

    • clearShowDeleted

      public ListSingleTenantHsmInstancesRequest.Builder clearShowDeleted()
       Optional. If set to true,
 [HsmManagement.ListSingleTenantHsmInstances][google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances]
 will also return
 [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] in
 DELETED state.
      bool show_deleted = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.