Class UpdateHmacKeyRequest (2.15.1)

public final class UpdateHmacKeyRequest extends GeneratedMessageV3 implements UpdateHmacKeyRequestOrBuilder

Request object to update an HMAC key state. HmacKeyMetadata.state is required and the only writable field in UpdateHmacKey operation. Specifying fields other than state will result in an error.

Protobuf type google.storage.v2.UpdateHmacKeyRequest

Static Fields

HMAC_KEY_FIELD_NUMBER

public static final int HMAC_KEY_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateHmacKeyRequest getDefaultInstance()
Returns
Type Description
UpdateHmacKeyRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UpdateHmacKeyRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public UpdateHmacKeyRequest getDefaultInstanceForType()
Returns
Type Description
UpdateHmacKeyRequest

getHmacKey()

public HmacKeyMetadata getHmacKey()

Required. The HMAC key to update. If present, the hmac_key's id field will be used to identify the key. Otherwise, the hmac_key's access_id and project fields will be used to identify the key.

.google.storage.v2.HmacKeyMetadata hmac_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
HmacKeyMetadata

The hmacKey.

getHmacKeyOrBuilder()

public HmacKeyMetadataOrBuilder getHmacKeyOrBuilder()

Required. The HMAC key to update. If present, the hmac_key's id field will be used to identify the key. Otherwise, the hmac_key's access_id and project fields will be used to identify the key.

.google.storage.v2.HmacKeyMetadata hmac_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
HmacKeyMetadataOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUpdateMask()

public FieldMask getUpdateMask()

Update mask for hmac_key. Not specifying any fields will mean only the state field is updated to the value specified in hmac_key.

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Update mask for hmac_key. Not specifying any fields will mean only the state field is updated to the value specified in hmac_key.

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
FieldMaskOrBuilder

hasHmacKey()

public boolean hasHmacKey()

Required. The HMAC key to update. If present, the hmac_key's id field will be used to identify the key. Otherwise, the hmac_key's access_id and project fields will be used to identify the key.

.google.storage.v2.HmacKeyMetadata hmac_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the hmacKey field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Update mask for hmac_key. Not specifying any fields will mean only the state field is updated to the value specified in hmac_key.

.google.protobuf.FieldMask update_mask = 3;

Returns
Type Description
boolean

Whether the updateMask 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 UpdateHmacKeyRequest.Builder newBuilderForType()
Returns
Type Description
UpdateHmacKeyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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