Class ListHmacKeysRequest.Builder (2.5.1)

public static final class ListHmacKeysRequest.Builder extends GeneratedMessageV3.Builder<ListHmacKeysRequest.Builder> implements ListHmacKeysRequestOrBuilder

Request to fetch a list of HMAC keys under a given project.

Protobuf type google.storage.v2.ListHmacKeysRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListHmacKeysRequest build()
Returns
TypeDescription
ListHmacKeysRequest

buildPartial()

public ListHmacKeysRequest buildPartial()
Returns
TypeDescription
ListHmacKeysRequest

clear()

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

clearCommonRequestParams()

public ListHmacKeysRequest.Builder clearCommonRequestParams()

Optional. A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListHmacKeysRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListHmacKeysRequest.Builder clearPageSize()

Optional. The maximum number of keys to return.

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

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

clearPageToken()

public ListHmacKeysRequest.Builder clearPageToken()

Optional. A previously returned token from ListHmacKeysResponse to get the next page.

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

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

clearProject()

public ListHmacKeysRequest.Builder clearProject()

Required. The project id to list HMAC keys for.

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

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

clearServiceAccountEmail()

public ListHmacKeysRequest.Builder clearServiceAccountEmail()

Optional. If set, filters to only return HMAC keys for specified service account.

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

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

clearShowDeletedKeys()

public ListHmacKeysRequest.Builder clearShowDeletedKeys()

Optional. If set, return deleted keys that have not yet been wiped out.

bool show_deleted_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

clone()

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

getCommonRequestParams()

public CommonRequestParams getCommonRequestParams()

Optional. A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CommonRequestParams

The commonRequestParams.

getCommonRequestParamsBuilder()

public CommonRequestParams.Builder getCommonRequestParamsBuilder()

Optional. A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CommonRequestParams.Builder

getCommonRequestParamsOrBuilder()

public CommonRequestParamsOrBuilder getCommonRequestParamsOrBuilder()

Optional. A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CommonRequestParamsOrBuilder

getDefaultInstanceForType()

public ListHmacKeysRequest getDefaultInstanceForType()
Returns
TypeDescription
ListHmacKeysRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

Optional. The maximum number of keys to return.

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

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A previously returned token from ListHmacKeysResponse to get the next page.

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

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A previously returned token from ListHmacKeysResponse to get the next page.

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

Returns
TypeDescription
ByteString

The bytes for pageToken.

getProject()

public String getProject()

Required. The project id to list HMAC keys for.

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

Returns
TypeDescription
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Required. The project id to list HMAC keys for.

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

Returns
TypeDescription
ByteString

The bytes for project.

getServiceAccountEmail()

public String getServiceAccountEmail()

Optional. If set, filters to only return HMAC keys for specified service account.

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

Returns
TypeDescription
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

Optional. If set, filters to only return HMAC keys for specified service account.

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

Returns
TypeDescription
ByteString

The bytes for serviceAccountEmail.

getShowDeletedKeys()

public boolean getShowDeletedKeys()

Optional. If set, return deleted keys that have not yet been wiped out.

bool show_deleted_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The showDeletedKeys.

hasCommonRequestParams()

public boolean hasCommonRequestParams()

Optional. A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the commonRequestParams field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCommonRequestParams(CommonRequestParams value)

public ListHmacKeysRequest.Builder mergeCommonRequestParams(CommonRequestParams value)

Optional. A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueCommonRequestParams
Returns
TypeDescription
ListHmacKeysRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(ListHmacKeysRequest other)

public ListHmacKeysRequest.Builder mergeFrom(ListHmacKeysRequest other)
Parameter
NameDescription
otherListHmacKeysRequest
Returns
TypeDescription
ListHmacKeysRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCommonRequestParams(CommonRequestParams value)

public ListHmacKeysRequest.Builder setCommonRequestParams(CommonRequestParams value)

Optional. A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueCommonRequestParams
Returns
TypeDescription
ListHmacKeysRequest.Builder

setCommonRequestParams(CommonRequestParams.Builder builderForValue)

public ListHmacKeysRequest.Builder setCommonRequestParams(CommonRequestParams.Builder builderForValue)

Optional. A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueCommonRequestParams.Builder
Returns
TypeDescription
ListHmacKeysRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ListHmacKeysRequest.Builder setPageSize(int value)

Optional. The maximum number of keys to return.

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

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListHmacKeysRequest.Builder setPageToken(String value)

Optional. A previously returned token from ListHmacKeysResponse to get the next page.

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

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListHmacKeysRequest.Builder setPageTokenBytes(ByteString value)

Optional. A previously returned token from ListHmacKeysResponse to get the next page.

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

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

setProject(String value)

public ListHmacKeysRequest.Builder setProject(String value)

Required. The project id to list HMAC keys for.

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

Parameter
NameDescription
valueString

The project to set.

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public ListHmacKeysRequest.Builder setProjectBytes(ByteString value)

Required. The project id to list HMAC keys for.

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

Parameter
NameDescription
valueByteString

The bytes for project to set.

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

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

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

setServiceAccountEmail(String value)

public ListHmacKeysRequest.Builder setServiceAccountEmail(String value)

Optional. If set, filters to only return HMAC keys for specified service account.

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

Parameter
NameDescription
valueString

The serviceAccountEmail to set.

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

setServiceAccountEmailBytes(ByteString value)

public ListHmacKeysRequest.Builder setServiceAccountEmailBytes(ByteString value)

Optional. If set, filters to only return HMAC keys for specified service account.

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

Parameter
NameDescription
valueByteString

The bytes for serviceAccountEmail to set.

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

setShowDeletedKeys(boolean value)

public ListHmacKeysRequest.Builder setShowDeletedKeys(boolean value)

Optional. If set, return deleted keys that have not yet been wiped out.

bool show_deleted_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueboolean

The showDeletedKeys to set.

Returns
TypeDescription
ListHmacKeysRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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