Class ListCryptoKeyVersionsRequest.Builder (2.33.0)

public static final class ListCryptoKeyVersionsRequest.Builder extends GeneratedMessageV3.Builder<ListCryptoKeyVersionsRequest.Builder> implements ListCryptoKeyVersionsRequestOrBuilder

Request message for KeyManagementService.ListCryptoKeyVersions.

Protobuf type google.cloud.kms.v1.ListCryptoKeyVersionsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListCryptoKeyVersionsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides

build()

public ListCryptoKeyVersionsRequest build()
Returns
TypeDescription
ListCryptoKeyVersionsRequest

buildPartial()

public ListCryptoKeyVersionsRequest buildPartial()
Returns
TypeDescription
ListCryptoKeyVersionsRequest

clear()

public ListCryptoKeyVersionsRequest.Builder clear()
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListCryptoKeyVersionsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides

clearFilter()

public ListCryptoKeyVersionsRequest.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
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListCryptoKeyVersionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides

clearOrderBy()

public ListCryptoKeyVersionsRequest.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
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

clearPageSize()

public ListCryptoKeyVersionsRequest.Builder clearPageSize()

Optional. Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.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
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListCryptoKeyVersionsRequest.Builder clearPageToken()

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

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

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

clearParent()

public ListCryptoKeyVersionsRequest.Builder clearParent()

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

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

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

clearView()

public ListCryptoKeyVersionsRequest.Builder clearView()

The fields to include in the response.

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

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

clone()

public ListCryptoKeyVersionsRequest.Builder clone()
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListCryptoKeyVersionsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListCryptoKeyVersionsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

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

The pageSize.

getPageToken()

public String getPageToken()

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

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

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for parent.

getView()

public CryptoKeyVersion.CryptoKeyVersionView getView()

The fields to include in the response.

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

Returns
TypeDescription
CryptoKeyVersion.CryptoKeyVersionView

The view.

getViewValue()

public int getViewValue()

The fields to include in the response.

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

Returns
TypeDescription
int

The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListCryptoKeyVersionsRequest other)

public ListCryptoKeyVersionsRequest.Builder mergeFrom(ListCryptoKeyVersionsRequest other)
Parameter
NameDescription
otherListCryptoKeyVersionsRequest
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListCryptoKeyVersionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListCryptoKeyVersionsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListCryptoKeyVersionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListCryptoKeyVersionsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides

setFilter(String value)

public ListCryptoKeyVersionsRequest.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
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListCryptoKeyVersionsRequest.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
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListCryptoKeyVersionsRequest.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
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListCryptoKeyVersionsRequest.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
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListCryptoKeyVersionsRequest.Builder setPageSize(int value)

Optional. Optional limit on the number of CryptoKeyVersions to include in the response. Further CryptoKeyVersions can subsequently be obtained by including the ListCryptoKeyVersionsResponse.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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListCryptoKeyVersionsRequest.Builder setPageToken(String value)

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

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

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListCryptoKeyVersionsRequest.Builder setPageTokenBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

setParent(String value)

public ListCryptoKeyVersionsRequest.Builder setParent(String value)

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

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListCryptoKeyVersionsRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

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

public ListCryptoKeyVersionsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListCryptoKeyVersionsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder
Overrides

setView(CryptoKeyVersion.CryptoKeyVersionView value)

public ListCryptoKeyVersionsRequest.Builder setView(CryptoKeyVersion.CryptoKeyVersionView value)

The fields to include in the response.

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

Parameter
NameDescription
valueCryptoKeyVersion.CryptoKeyVersionView

The view to set.

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.

setViewValue(int value)

public ListCryptoKeyVersionsRequest.Builder setViewValue(int value)

The fields to include in the response.

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

Parameter
NameDescription
valueint

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

Returns
TypeDescription
ListCryptoKeyVersionsRequest.Builder

This builder for chaining.