Class ListCryptoKeysRequest.Builder (2.47.0)

public static final class ListCryptoKeysRequest.Builder extends GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder> implements ListCryptoKeysRequestOrBuilder

Request message for KeyManagementService.ListCryptoKeys.

Protobuf type google.cloud.kms.v1.ListCryptoKeysRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListCryptoKeysRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListCryptoKeysRequest.Builder
Overrides

build()

public ListCryptoKeysRequest build()
Returns
Type Description
ListCryptoKeysRequest

buildPartial()

public ListCryptoKeysRequest buildPartial()
Returns
Type Description
ListCryptoKeysRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public ListCryptoKeysRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListCryptoKeysRequest.Builder
Overrides

clearFilter()

public ListCryptoKeysRequest.Builder clearFilter()

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

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

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListCryptoKeysRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListCryptoKeysRequest.Builder
Overrides

clearOrderBy()

public ListCryptoKeysRequest.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 = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

clearPageSize()

public ListCryptoKeysRequest.Builder clearPageSize()

Optional. Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.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
ListCryptoKeysRequest.Builder

This builder for chaining.

clearPageToken()

public ListCryptoKeysRequest.Builder clearPageToken()

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

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

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

clearParent()

public ListCryptoKeysRequest.Builder clearParent()

Required. The resource name of the KeyRing to list, in the format projects/*/locations/*/keyRings/*.

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

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

clearVersionView()

public ListCryptoKeysRequest.Builder clearVersionView()

The fields of the primary version to include in the response.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

clone()

public ListCryptoKeysRequest.Builder clone()
Returns
Type Description
ListCryptoKeysRequest.Builder
Overrides

getDefaultInstanceForType()

public ListCryptoKeysRequest getDefaultInstanceForType()
Returns
Type Description
ListCryptoKeysRequest

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 = 5 [(.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 = 5 [(.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 = 6 [(.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 = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.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 ListCryptoKeysResponse.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 ListCryptoKeysResponse.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 KeyRing to list, in the format projects/*/locations/*/keyRings/*.

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 KeyRing to list, in the format projects/*/locations/*/keyRings/*.

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

Returns
Type Description
ByteString

The bytes for parent.

getVersionView()

public CryptoKeyVersion.CryptoKeyVersionView getVersionView()

The fields of the primary version to include in the response.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;

Returns
Type Description
CryptoKeyVersion.CryptoKeyVersionView

The versionView.

getVersionViewValue()

public int getVersionViewValue()

The fields of the primary version to include in the response.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;

Returns
Type Description
int

The enum numeric value on the wire for versionView.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListCryptoKeysRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListCryptoKeysRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListCryptoKeysRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListCryptoKeysRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListCryptoKeysRequest.Builder
Overrides

setFilter(String value)

public ListCryptoKeysRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListCryptoKeysRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListCryptoKeysRequest.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 = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListCryptoKeysRequest.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 = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListCryptoKeysRequest.Builder setPageSize(int value)

Optional. Optional limit on the number of CryptoKeys to include in the response. Further CryptoKeys can subsequently be obtained by including the ListCryptoKeysResponse.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
ListCryptoKeysRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListCryptoKeysRequest.Builder setPageToken(String value)

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

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListCryptoKeysRequest.Builder setPageTokenBytes(ByteString value)

Optional. Optional pagination token, returned earlier via ListCryptoKeysResponse.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
ListCryptoKeysRequest.Builder

This builder for chaining.

setParent(String value)

public ListCryptoKeysRequest.Builder setParent(String value)

Required. The resource name of the KeyRing to list, in the format projects/*/locations/*/keyRings/*.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListCryptoKeysRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the KeyRing to list, in the format projects/*/locations/*/keyRings/*.

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

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListCryptoKeysRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListCryptoKeysRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListCryptoKeysRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListCryptoKeysRequest.Builder
Overrides

setVersionView(CryptoKeyVersion.CryptoKeyVersionView value)

public ListCryptoKeysRequest.Builder setVersionView(CryptoKeyVersion.CryptoKeyVersionView value)

The fields of the primary version to include in the response.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;

Parameter
Name Description
value CryptoKeyVersion.CryptoKeyVersionView

The versionView to set.

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.

setVersionViewValue(int value)

public ListCryptoKeysRequest.Builder setVersionViewValue(int value)

The fields of the primary version to include in the response.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for versionView to set.

Returns
Type Description
ListCryptoKeysRequest.Builder

This builder for chaining.