Class ListKeyRingsRequest.Builder (2.50.0)

public static final class ListKeyRingsRequest.Builder extends GeneratedMessageV3.Builder<ListKeyRingsRequest.Builder> implements ListKeyRingsRequestOrBuilder

Request message for KeyManagementService.ListKeyRings.

Protobuf type google.cloud.kms.v1.ListKeyRingsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListKeyRingsRequest build()
Returns
Type Description
ListKeyRingsRequest

buildPartial()

public ListKeyRingsRequest buildPartial()
Returns
Type Description
ListKeyRingsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

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

This builder for chaining.

clearPageSize()

public ListKeyRingsRequest.Builder clearPageSize()

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

This builder for chaining.

clearPageToken()

public ListKeyRingsRequest.Builder clearPageToken()

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

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

Returns
Type Description
ListKeyRingsRequest.Builder

This builder for chaining.

clearParent()

public ListKeyRingsRequest.Builder clearParent()

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

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

Returns
Type Description
ListKeyRingsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListKeyRingsRequest getDefaultInstanceForType()
Returns
Type Description
ListKeyRingsRequest

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 KeyRings to include in the response. Further KeyRings can subsequently be obtained by including the ListKeyRingsResponse.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 ListKeyRingsResponse.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 ListKeyRingsResponse.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 KeyRings, 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 KeyRings, 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListKeyRingsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

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

This builder for chaining.

setFilterBytes(ByteString value)

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

This builder for chaining.

setOrderBy(String value)

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

This builder for chaining.

setOrderByBytes(ByteString value)

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

This builder for chaining.

setPageSize(int value)

public ListKeyRingsRequest.Builder setPageSize(int value)

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

This builder for chaining.

setPageToken(String value)

public ListKeyRingsRequest.Builder setPageToken(String value)

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

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListKeyRingsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListKeyRingsRequest.Builder setPageTokenBytes(ByteString value)

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

This builder for chaining.

setParent(String value)

public ListKeyRingsRequest.Builder setParent(String value)

Required. The resource name of the location associated with the KeyRings, 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
ListKeyRingsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListKeyRingsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the location associated with the KeyRings, 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
ListKeyRingsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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