Class ListHmacKeysRequest (2.5.1)

public final class ListHmacKeysRequest extends GeneratedMessageV3 implements ListHmacKeysRequestOrBuilder

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

Protobuf type google.storage.v2.ListHmacKeysRequest

Static Fields

COMMON_REQUEST_PARAMS_FIELD_NUMBER

public static final int COMMON_REQUEST_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
Field Value
Type Description
int

SHOW_DELETED_KEYS_FIELD_NUMBER

public static final int SHOW_DELETED_KEYS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListHmacKeysRequest getDefaultInstance()
Returns
Type Description
ListHmacKeysRequest

getDescriptor()

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

newBuilder()

public static ListHmacKeysRequest.Builder newBuilder()
Returns
Type Description
ListHmacKeysRequest.Builder

newBuilder(ListHmacKeysRequest prototype)

public static ListHmacKeysRequest.Builder newBuilder(ListHmacKeysRequest prototype)
Parameter
Name Description
prototype ListHmacKeysRequest
Returns
Type Description
ListHmacKeysRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListHmacKeysRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListHmacKeysRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListHmacKeysRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListHmacKeysRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListHmacKeysRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListHmacKeysRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListHmacKeysRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListHmacKeysRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListHmacKeysRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListHmacKeysRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListHmacKeysRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListHmacKeysRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListHmacKeysRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListHmacKeysRequest> parser()
Returns
Type Description
Parser<ListHmacKeysRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
CommonRequestParams

The commonRequestParams.

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
Type Description
CommonRequestParamsOrBuilder

getDefaultInstanceForType()

public ListHmacKeysRequest getDefaultInstanceForType()
Returns
Type Description
ListHmacKeysRequest

getPageSize()

public int getPageSize()

Optional. The maximum number of keys to return.

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

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for pageToken.

getParserForType()

public Parser<ListHmacKeysRequest> getParserForType()
Returns
Type Description
Parser<ListHmacKeysRequest>
Overrides

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
Type Description
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
Type Description
ByteString

The bytes for project.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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
Type Description
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
Type Description
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
Type Description
boolean

The showDeletedKeys.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

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
Type Description
boolean

Whether the commonRequestParams field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListHmacKeysRequest.Builder newBuilderForType()
Returns
Type Description
ListHmacKeysRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListHmacKeysRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListHmacKeysRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListHmacKeysRequest.Builder toBuilder()
Returns
Type Description
ListHmacKeysRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException