Class EncryptionInfo (6.25.1)

Stay organized with collections Save and categorize content based on your preferences.
public final class EncryptionInfo extends GeneratedMessageV3 implements EncryptionInfoOrBuilder

Encryption information for a Cloud Spanner database or backup.

Protobuf type google.spanner.admin.database.v1.EncryptionInfo

Static Fields

ENCRYPTION_STATUS_FIELD_NUMBER

public static final int ENCRYPTION_STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTION_TYPE_FIELD_NUMBER

public static final int ENCRYPTION_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_VERSION_FIELD_NUMBER

public static final int KMS_KEY_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static EncryptionInfo getDefaultInstance()
Returns
TypeDescription
EncryptionInfo

getDescriptor()

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

newBuilder()

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

newBuilder(EncryptionInfo prototype)

public static EncryptionInfo.Builder newBuilder(EncryptionInfo prototype)
Parameter
NameDescription
prototypeEncryptionInfo
Returns
TypeDescription
EncryptionInfo.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public EncryptionInfo getDefaultInstanceForType()
Returns
TypeDescription
EncryptionInfo

getEncryptionStatus()

public Status getEncryptionStatus()

Output only. If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.

.google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.Status

The encryptionStatus.

getEncryptionStatusOrBuilder()

public StatusOrBuilder getEncryptionStatusOrBuilder()

Output only. If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.

.google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getEncryptionType()

public EncryptionInfo.Type getEncryptionType()

Output only. The type of encryption.

.google.spanner.admin.database.v1.EncryptionInfo.Type encryption_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
EncryptionInfo.Type

The encryptionType.

getEncryptionTypeValue()

public int getEncryptionTypeValue()

Output only. The type of encryption.

.google.spanner.admin.database.v1.EncryptionInfo.Type encryption_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for encryptionType.

getKmsKeyVersion()

public String getKmsKeyVersion()

Output only. A Cloud KMS key version that is being used to protect the database or backup.

string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The kmsKeyVersion.

getKmsKeyVersionBytes()

public ByteString getKmsKeyVersionBytes()

Output only. A Cloud KMS key version that is being used to protect the database or backup.

string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for kmsKeyVersion.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasEncryptionStatus()

public boolean hasEncryptionStatus()

Output only. If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest.

.google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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