Class ListKeyHandlesRequest.Builder (2.54.0)

public static final class ListKeyHandlesRequest.Builder extends GeneratedMessageV3.Builder<ListKeyHandlesRequest.Builder> implements ListKeyHandlesRequestOrBuilder

Request message for Autokey.ListKeyHandles.

Protobuf type google.cloud.kms.v1.ListKeyHandlesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListKeyHandlesRequest build()
Returns
Type Description
ListKeyHandlesRequest

buildPartial()

public ListKeyHandlesRequest buildPartial()
Returns
Type Description
ListKeyHandlesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListKeyHandlesRequest.Builder clearFilter()

Optional. Filter to apply when listing KeyHandles, e.g. resource_type_selector="{SERVICE}.googleapis.com/{TYPE}".

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

Returns
Type Description
ListKeyHandlesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListKeyHandlesRequest.Builder clearPageSize()

Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most 100 KeyHandles will be returned.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListKeyHandlesRequest.Builder

This builder for chaining.

clearPageToken()

public ListKeyHandlesRequest.Builder clearPageToken()

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

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

Returns
Type Description
ListKeyHandlesRequest.Builder

This builder for chaining.

clearParent()

public ListKeyHandlesRequest.Builder clearParent()

Required. Name of the resource project and location from which to list KeyHandles, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.

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

Returns
Type Description
ListKeyHandlesRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListKeyHandlesRequest getDefaultInstanceForType()
Returns
Type Description
ListKeyHandlesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Filter to apply when listing KeyHandles, e.g. resource_type_selector="{SERVICE}.googleapis.com/{TYPE}".

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter to apply when listing KeyHandles, e.g. resource_type_selector="{SERVICE}.googleapis.com/{TYPE}".

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most 100 KeyHandles will be returned.

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 ListKeyHandlesResponse.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 ListKeyHandlesResponse.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. Name of the resource project and location from which to list KeyHandles, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Name of the resource project and location from which to list KeyHandles, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.

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(ListKeyHandlesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListKeyHandlesRequest.Builder setFilter(String value)

Optional. Filter to apply when listing KeyHandles, e.g. resource_type_selector="{SERVICE}.googleapis.com/{TYPE}".

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListKeyHandlesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListKeyHandlesRequest.Builder setFilterBytes(ByteString value)

Optional. Filter to apply when listing KeyHandles, e.g. resource_type_selector="{SERVICE}.googleapis.com/{TYPE}".

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListKeyHandlesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListKeyHandlesRequest.Builder setPageSize(int value)

Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most 100 KeyHandles will be returned.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListKeyHandlesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListKeyHandlesRequest.Builder setPageToken(String value)

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

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListKeyHandlesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListKeyHandlesRequest.Builder setPageTokenBytes(ByteString value)

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

This builder for chaining.

setParent(String value)

public ListKeyHandlesRequest.Builder setParent(String value)

Required. Name of the resource project and location from which to list KeyHandles, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListKeyHandlesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListKeyHandlesRequest.Builder setParentBytes(ByteString value)

Required. Name of the resource project and location from which to list KeyHandles, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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