Class EncryptionConfig (1.60.0)

public final class EncryptionConfig extends GeneratedMessageV3 implements EncryptionConfigOrBuilder

A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK).

Protobuf type google.cloud.dataplex.v1.EncryptionConfig

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTION_STATE_FIELD_NUMBER

public static final int ENCRYPTION_STATE_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

FAILURE_DETAILS_FIELD_NUMBER

public static final int FAILURE_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EncryptionConfig getDefaultInstance()
Returns
Type Description
EncryptionConfig

getDescriptor()

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

newBuilder()

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

newBuilder(EncryptionConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the Encryption configuration was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the Encryption configuration was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public EncryptionConfig getDefaultInstanceForType()
Returns
Type Description
EncryptionConfig

getEncryptionState()

public EncryptionConfig.EncryptionState getEncryptionState()

Output only. The state of encryption of the databases.

.google.cloud.dataplex.v1.EncryptionConfig.EncryptionState encryption_state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionConfig.EncryptionState

The encryptionState.

getEncryptionStateValue()

public int getEncryptionStateValue()

Output only. The state of encryption of the databases.

.google.cloud.dataplex.v1.EncryptionConfig.EncryptionState encryption_state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for encryptionState.

getEtag()

public String getEtag()

Etag of the EncryptionConfig. This is a strong etag.

string etag = 6;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Etag of the EncryptionConfig. This is a strong etag.

string etag = 6;

Returns
Type Description
ByteString

The bytes for etag.

getFailureDetails()

public EncryptionConfig.FailureDetails getFailureDetails()

Output only. Details of the failure if anything related to Cmek db fails.

.google.cloud.dataplex.v1.EncryptionConfig.FailureDetails failure_details = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionConfig.FailureDetails

The failureDetails.

getFailureDetailsOrBuilder()

public EncryptionConfig.FailureDetailsOrBuilder getFailureDetailsOrBuilder()

Output only. Details of the failure if anything related to Cmek db fails.

.google.cloud.dataplex.v1.EncryptionConfig.FailureDetails failure_details = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EncryptionConfig.FailureDetailsOrBuilder

getKey()

public String getKey()

Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption.

string key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

Optional. If a key is chosen, it means that the customer is using CMEK. If a key is not chosen, it means that the customer is using Google managed encryption.

string key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for key.

getName()

public String getName()

Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the EncryptionConfig. Format: organizations/{organization}/locations/{location}/encryptionConfigs/{encryption_config} Global location is not supported.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time when the Encryption configuration was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the Encryption configuration was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the Encryption configuration was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasFailureDetails()

public boolean hasFailureDetails()

Output only. Details of the failure if anything related to Cmek db fails.

.google.cloud.dataplex.v1.EncryptionConfig.FailureDetails failure_details = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the failureDetails field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time when the Encryption configuration was last updated.

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

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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