Class ListSingleTenantHsmInstancesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.kms.v1.ListSingleTenantHsmInstancesRequest
All Implemented Interfaces:
ListSingleTenantHsmInstancesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ListSingleTenantHsmInstancesRequest extends com.google.protobuf.GeneratedMessage implements ListSingleTenantHsmInstancesRequestOrBuilder
 Request message for
 [HsmManagement.ListSingleTenantHsmInstances][google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances].
 
Protobuf type google.cloud.kms.v1.ListSingleTenantHsmInstancesRequest
See Also:
  • Field Details

  • 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
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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 ListSingleTenantHsmInstancesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static ListSingleTenantHsmInstancesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static ListSingleTenantHsmInstancesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static ListSingleTenantHsmInstancesRequest.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

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

      public static ListSingleTenantHsmInstancesRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ListSingleTenantHsmInstancesRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<ListSingleTenantHsmInstancesRequest> 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 ListSingleTenantHsmInstancesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder