Class ListSingleTenantHsmInstancesRequest (2.86.0)

public final class ListSingleTenantHsmInstancesRequest extends GeneratedMessage implements ListSingleTenantHsmInstancesRequestOrBuilder

Request message for HsmManagement.ListSingleTenantHsmInstances.

Protobuf type google.cloud.kms.v1.ListSingleTenantHsmInstancesRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ListSingleTenantHsmInstancesRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SHOW_DELETED_FIELD_NUMBER

public static final int SHOW_DELETED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListSingleTenantHsmInstancesRequest getDefaultInstance()
Returns
Type Description
ListSingleTenantHsmInstancesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListSingleTenantHsmInstancesRequest.Builder newBuilder()
Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

newBuilder(ListSingleTenantHsmInstancesRequest prototype)

public static ListSingleTenantHsmInstancesRequest.Builder newBuilder(ListSingleTenantHsmInstancesRequest prototype)
Parameter
Name Description
prototype ListSingleTenantHsmInstancesRequest
Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListSingleTenantHsmInstancesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSingleTenantHsmInstancesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListSingleTenantHsmInstancesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListSingleTenantHsmInstancesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListSingleTenantHsmInstancesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListSingleTenantHsmInstancesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListSingleTenantHsmInstancesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSingleTenantHsmInstancesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListSingleTenantHsmInstancesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSingleTenantHsmInstancesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListSingleTenantHsmInstancesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListSingleTenantHsmInstancesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSingleTenantHsmInstancesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListSingleTenantHsmInstancesRequest> parser()
Returns
Type Description
Parser<ListSingleTenantHsmInstancesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListSingleTenantHsmInstancesRequest getDefaultInstanceForType()
Returns
Type Description
ListSingleTenantHsmInstancesRequest

getFilter()

public String getFilter()

Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

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.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

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

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Optional limit on the number of SingleTenantHsmInstances to include in the response. Further SingleTenantHsmInstances can subsequently be obtained by including the 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
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstancesResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstancesResponse.next_page_token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the location associated with the SingleTenantHsmInstances to list, in the format projects/*/locations/*.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the location associated with the SingleTenantHsmInstances to list, in the format projects/*/locations/*.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListSingleTenantHsmInstancesRequest> getParserForType()
Returns
Type Description
Parser<ListSingleTenantHsmInstancesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShowDeleted()

public boolean getShowDeleted()

Optional. If set to true, HsmManagement.ListSingleTenantHsmInstances will also return SingleTenantHsmInstances in DELETED state.

bool show_deleted = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The showDeleted.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListSingleTenantHsmInstancesRequest.Builder newBuilderForType()
Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ListSingleTenantHsmInstancesRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder
Overrides

toBuilder()

public ListSingleTenantHsmInstancesRequest.Builder toBuilder()
Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException