Class UpdateHmacKeyRequest (2.17.0)

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
TypeDescription
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateHmacKeyRequest getDefaultInstance()
Returns
TypeDescription
UpdateHmacKeyRequest

getDescriptor()

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

newBuilder()

public static UpdateHmacKeyRequest.Builder newBuilder()
Returns
TypeDescription
UpdateHmacKeyRequest.Builder

newBuilder(UpdateHmacKeyRequest prototype)

public static UpdateHmacKeyRequest.Builder newBuilder(UpdateHmacKeyRequest prototype)
Parameter
NameDescription
prototypeUpdateHmacKeyRequest
Returns
TypeDescription
UpdateHmacKeyRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateHmacKeyRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateHmacKeyRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UpdateHmacKeyRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateHmacKeyRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateHmacKeyRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateHmacKeyRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateHmacKeyRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateHmacKeyRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UpdateHmacKeyRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateHmacKeyRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UpdateHmacKeyRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateHmacKeyRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateHmacKeyRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UpdateHmacKeyRequest> parser()
Returns
TypeDescription
Parser<UpdateHmacKeyRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public UpdateHmacKeyRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
HmacKeyMetadataOrBuilder

getParserForType()

public Parser<UpdateHmacKeyRequest> getParserForType()
Returns
TypeDescription
Parser<UpdateHmacKeyRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateMask field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UpdateHmacKeyRequest.Builder newBuilderForType()
Returns
TypeDescription
UpdateHmacKeyRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateHmacKeyRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UpdateHmacKeyRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UpdateHmacKeyRequest.Builder toBuilder()
Returns
TypeDescription
UpdateHmacKeyRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException