Class ListSingleTenantHsmInstancesRequest.Builder (2.86.0)

public static final class ListSingleTenantHsmInstancesRequest.Builder extends GeneratedMessage.Builder<ListSingleTenantHsmInstancesRequest.Builder> implements ListSingleTenantHsmInstancesRequestOrBuilder

Request message for HsmManagement.ListSingleTenantHsmInstances.

Protobuf type google.cloud.kms.v1.ListSingleTenantHsmInstancesRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListSingleTenantHsmInstancesRequest build()
Returns
Type Description
ListSingleTenantHsmInstancesRequest

buildPartial()

public ListSingleTenantHsmInstancesRequest buildPartial()
Returns
Type Description
ListSingleTenantHsmInstancesRequest

clear()

public ListSingleTenantHsmInstancesRequest.Builder clear()
Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder
Overrides

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.

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

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

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.

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

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

clearPageSize()

public ListSingleTenantHsmInstancesRequest.Builder clearPageSize()

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

This builder for chaining.

clearPageToken()

public ListSingleTenantHsmInstancesRequest.Builder clearPageToken()

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

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

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

clearParent()

public ListSingleTenantHsmInstancesRequest.Builder clearParent()

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

This builder for chaining.

clearShowDeleted()

public ListSingleTenantHsmInstancesRequest.Builder clearShowDeleted()

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

This builder for chaining.

getDefaultInstanceForType()

public ListSingleTenantHsmInstancesRequest getDefaultInstanceForType()
Returns
Type Description
ListSingleTenantHsmInstancesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListSingleTenantHsmInstancesRequest other)

public ListSingleTenantHsmInstancesRequest.Builder mergeFrom(ListSingleTenantHsmInstancesRequest other)
Parameter
Name Description
other ListSingleTenantHsmInstancesRequest
Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListSingleTenantHsmInstancesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListSingleTenantHsmInstancesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder
Overrides

setFilter(String value)

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.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListSingleTenantHsmInstancesRequest.Builder setFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

setOrderBy(String value)

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.

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

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListSingleTenantHsmInstancesRequest.Builder setOrderByBytes(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.

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

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListSingleTenantHsmInstancesRequest.Builder setPageSize(int value)

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];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListSingleTenantHsmInstancesRequest.Builder setPageToken(String value)

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

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListSingleTenantHsmInstancesRequest.Builder setPageTokenBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

setParent(String value)

public ListSingleTenantHsmInstancesRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListSingleTenantHsmInstancesRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.

setShowDeleted(boolean value)

public ListSingleTenantHsmInstancesRequest.Builder setShowDeleted(boolean value)

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

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

Parameter
Name Description
value boolean

The showDeleted to set.

Returns
Type Description
ListSingleTenantHsmInstancesRequest.Builder

This builder for chaining.