Class HmacKeyMetadata.Builder (2.43.1)

public static final class HmacKeyMetadata.Builder extends GeneratedMessageV3.Builder<HmacKeyMetadata.Builder> implements HmacKeyMetadataOrBuilder

Hmac Key Metadata, which includes all information other than the secret.

Protobuf type google.storage.v2.HmacKeyMetadata

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public HmacKeyMetadata build()
Returns
Type Description
HmacKeyMetadata

buildPartial()

public HmacKeyMetadata buildPartial()
Returns
Type Description
HmacKeyMetadata

clear()

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

clearAccessId()

public HmacKeyMetadata.Builder clearAccessId()

Immutable. Globally unique id for keys.

string access_id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

clearCreateTime()

public HmacKeyMetadata.Builder clearCreateTime()

Output only. The creation time of the HMAC key.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
HmacKeyMetadata.Builder

clearEtag()

public HmacKeyMetadata.Builder clearEtag()

Optional. The etag of the HMAC key.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearId()

public HmacKeyMetadata.Builder clearId()

Immutable. Resource name ID of the key in the format {projectIdentifier}/{accessId}. {projectIdentifier} can be the project ID or project number.

string id = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProject()

public HmacKeyMetadata.Builder clearProject()

Immutable. Identifies the project that owns the service account of the specified HMAC key, in the format "projects/{projectIdentifier}". {projectIdentifier} can be the project ID or project number.

string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

clearServiceAccountEmail()

public HmacKeyMetadata.Builder clearServiceAccountEmail()

Output only. Email of the service account the key authenticates as.

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

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

clearState()

public HmacKeyMetadata.Builder clearState()

Optional. State of the key. One of ACTIVE, INACTIVE, or DELETED. Writable, can be updated by UpdateHmacKey operation.

string state = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

clearUpdateTime()

public HmacKeyMetadata.Builder clearUpdateTime()

Output only. The last modification time of the HMAC key metadata.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
HmacKeyMetadata.Builder

clone()

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

getAccessId()

public String getAccessId()

Immutable. Globally unique id for keys.

string access_id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The accessId.

getAccessIdBytes()

public ByteString getAccessIdBytes()

Immutable. Globally unique id for keys.

string access_id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for accessId.

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation time of the HMAC key.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The creation time of the HMAC key.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time of the HMAC key.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public HmacKeyMetadata getDefaultInstanceForType()
Returns
Type Description
HmacKeyMetadata

getDescriptorForType()

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

getEtag()

public String getEtag()

Optional. The etag of the HMAC key.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. The etag of the HMAC key.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for etag.

getId()

public String getId()

Immutable. Resource name ID of the key in the format {projectIdentifier}/{accessId}. {projectIdentifier} can be the project ID or project number.

string id = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Immutable. Resource name ID of the key in the format {projectIdentifier}/{accessId}. {projectIdentifier} can be the project ID or project number.

string id = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for id.

getProject()

public String getProject()

Immutable. Identifies the project that owns the service account of the specified HMAC key, in the format "projects/{projectIdentifier}". {projectIdentifier} can be the project ID or project number.

string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Immutable. Identifies the project that owns the service account of the specified HMAC key, in the format "projects/{projectIdentifier}". {projectIdentifier} can be the project ID or project number.

string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for project.

getServiceAccountEmail()

public String getServiceAccountEmail()

Output only. Email of the service account the key authenticates as.

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

Returns
Type Description
String

The serviceAccountEmail.

getServiceAccountEmailBytes()

public ByteString getServiceAccountEmailBytes()

Output only. Email of the service account the key authenticates as.

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

Returns
Type Description
ByteString

The bytes for serviceAccountEmail.

getState()

public String getState()

Optional. State of the key. One of ACTIVE, INACTIVE, or DELETED. Writable, can be updated by UpdateHmacKey operation.

string state = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The state.

getStateBytes()

public ByteString getStateBytes()

Optional. State of the key. One of ACTIVE, INACTIVE, or DELETED. Writable, can be updated by UpdateHmacKey operation.

string state = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last modification time of the HMAC key metadata.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The last modification time of the HMAC key metadata.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last modification time of the HMAC key metadata.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation time of the HMAC key.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last modification time of the HMAC key metadata.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public HmacKeyMetadata.Builder mergeCreateTime(Timestamp value)

Output only. The creation time of the HMAC key.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
HmacKeyMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(HmacKeyMetadata other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public HmacKeyMetadata.Builder mergeUpdateTime(Timestamp value)

Output only. The last modification time of the HMAC key metadata.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
HmacKeyMetadata.Builder

setAccessId(String value)

public HmacKeyMetadata.Builder setAccessId(String value)

Immutable. Globally unique id for keys.

string access_id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The accessId to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setAccessIdBytes(ByteString value)

public HmacKeyMetadata.Builder setAccessIdBytes(ByteString value)

Immutable. Globally unique id for keys.

string access_id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for accessId to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public HmacKeyMetadata.Builder setCreateTime(Timestamp value)

Output only. The creation time of the HMAC key.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
HmacKeyMetadata.Builder

setCreateTime(Timestamp.Builder builderForValue)

public HmacKeyMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The creation time of the HMAC key.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
HmacKeyMetadata.Builder

setEtag(String value)

public HmacKeyMetadata.Builder setEtag(String value)

Optional. The etag of the HMAC key.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public HmacKeyMetadata.Builder setEtagBytes(ByteString value)

Optional. The etag of the HMAC key.

string etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setId(String value)

public HmacKeyMetadata.Builder setId(String value)

Immutable. Resource name ID of the key in the format {projectIdentifier}/{accessId}. {projectIdentifier} can be the project ID or project number.

string id = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The id to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setIdBytes(ByteString value)

public HmacKeyMetadata.Builder setIdBytes(ByteString value)

Immutable. Resource name ID of the key in the format {projectIdentifier}/{accessId}. {projectIdentifier} can be the project ID or project number.

string id = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for id to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setProject(String value)

public HmacKeyMetadata.Builder setProject(String value)

Immutable. Identifies the project that owns the service account of the specified HMAC key, in the format "projects/{projectIdentifier}". {projectIdentifier} can be the project ID or project number.

string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The project to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setProjectBytes(ByteString value)

public HmacKeyMetadata.Builder setProjectBytes(ByteString value)

Immutable. Identifies the project that owns the service account of the specified HMAC key, in the format "projects/{projectIdentifier}". {projectIdentifier} can be the project ID or project number.

string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for project to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

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

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

setServiceAccountEmail(String value)

public HmacKeyMetadata.Builder setServiceAccountEmail(String value)

Output only. Email of the service account the key authenticates as.

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

Parameter
Name Description
value String

The serviceAccountEmail to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setServiceAccountEmailBytes(ByteString value)

public HmacKeyMetadata.Builder setServiceAccountEmailBytes(ByteString value)

Output only. Email of the service account the key authenticates as.

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

Parameter
Name Description
value ByteString

The bytes for serviceAccountEmail to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setState(String value)

public HmacKeyMetadata.Builder setState(String value)

Optional. State of the key. One of ACTIVE, INACTIVE, or DELETED. Writable, can be updated by UpdateHmacKey operation.

string state = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The state to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setStateBytes(ByteString value)

public HmacKeyMetadata.Builder setStateBytes(ByteString value)

Optional. State of the key. One of ACTIVE, INACTIVE, or DELETED. Writable, can be updated by UpdateHmacKey operation.

string state = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for state to set.

Returns
Type Description
HmacKeyMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public HmacKeyMetadata.Builder setUpdateTime(Timestamp value)

Output only. The last modification time of the HMAC key metadata.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
HmacKeyMetadata.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public HmacKeyMetadata.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The last modification time of the HMAC key metadata.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
HmacKeyMetadata.Builder