Class SecretVersion (2.18.0)

public final class SecretVersion extends GeneratedMessageV3 implements SecretVersionOrBuilder

A secret version resource in the Secret Manager API.

Protobuf type google.cloud.secretmanager.v1.SecretVersion

Static Fields

CLIENT_SPECIFIED_PAYLOAD_CHECKSUM_FIELD_NUMBER

public static final int CLIENT_SPECIFIED_PAYLOAD_CHECKSUM_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESTROY_TIME_FIELD_NUMBER

public static final int DESTROY_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

REPLICATION_STATUS_FIELD_NUMBER

public static final int REPLICATION_STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SecretVersion getDefaultInstance()
Returns
TypeDescription
SecretVersion

getDescriptor()

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

newBuilder()

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

newBuilder(SecretVersion prototype)

public static SecretVersion.Builder newBuilder(SecretVersion prototype)
Parameter
NameDescription
prototypeSecretVersion
Returns
TypeDescription
SecretVersion.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getClientSpecifiedPayloadChecksum()

public boolean getClientSpecifiedPayloadChecksum()

Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion.

bool client_specified_payload_checksum = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The clientSpecifiedPayloadChecksum.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time at which the SecretVersion was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which the SecretVersion was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public SecretVersion getDefaultInstanceForType()
Returns
TypeDescription
SecretVersion

getDestroyTime()

public Timestamp getDestroyTime()

Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.

.google.protobuf.Timestamp destroy_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The destroyTime.

getDestroyTimeOrBuilder()

public TimestampOrBuilder getDestroyTimeOrBuilder()

Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.

.google.protobuf.Timestamp destroy_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getEtag()

public String getEtag()

Output only. Etag of the currently stored SecretVersion.

string etag = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. Etag of the currently stored SecretVersion.

string etag = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for etag.

getName()

public String getName()

Output only. The resource name of the SecretVersion in the format projects/*/secrets/*/versions/*. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the SecretVersion in the format projects/*/secrets/*/versions/*. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getReplicationStatus()

public ReplicationStatus getReplicationStatus()

The replication status of the SecretVersion.

.google.cloud.secretmanager.v1.ReplicationStatus replication_status = 5;

Returns
TypeDescription
ReplicationStatus

The replicationStatus.

getReplicationStatusOrBuilder()

public ReplicationStatusOrBuilder getReplicationStatusOrBuilder()

The replication status of the SecretVersion.

.google.cloud.secretmanager.v1.ReplicationStatus replication_status = 5;

Returns
TypeDescription
ReplicationStatusOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public SecretVersion.State getState()

Output only. The current state of the SecretVersion.

.google.cloud.secretmanager.v1.SecretVersion.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
SecretVersion.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the SecretVersion.

.google.cloud.secretmanager.v1.SecretVersion.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCreateTime()

public boolean hasCreateTime()

Output only. The time at which the SecretVersion was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasDestroyTime()

public boolean hasDestroyTime()

Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.

.google.protobuf.Timestamp destroy_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the destroyTime field is set.

hasReplicationStatus()

public boolean hasReplicationStatus()

The replication status of the SecretVersion.

.google.cloud.secretmanager.v1.ReplicationStatus replication_status = 5;

Returns
TypeDescription
boolean

Whether the replicationStatus 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 SecretVersion.Builder newBuilderForType()
Returns
TypeDescription
SecretVersion.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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