public final class CmekSettings extends GeneratedMessageV3 implements CmekSettingsOrBuilder
Describes the customer-managed encryption key (CMEK) settings associated with
a project, folder, organization, billing account, or flexible resource.
Note: CMEK for the Log Router can currently only be configured for Google
Cloud organizations. Once configured, it applies to all projects and folders
in the Google Cloud organization.
See Enabling CMEK for Log
Router for
more information.
Protobuf type google.logging.v2.CmekSettings
Static Fields
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_VERSION_NAME_FIELD_NUMBER
public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVICE_ACCOUNT_ID_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static CmekSettings getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CmekSettings.Builder newBuilder()
newBuilder(CmekSettings prototype)
public static CmekSettings.Builder newBuilder(CmekSettings prototype)
public static CmekSettings parseDelimitedFrom(InputStream input)
public static CmekSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CmekSettings parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CmekSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CmekSettings parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CmekSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CmekSettings parseFrom(CodedInputStream input)
public static CmekSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CmekSettings parseFrom(InputStream input)
public static CmekSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CmekSettings parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CmekSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CmekSettings> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public CmekSettings getDefaultInstanceForType()
getKmsKeyName()
public String getKmsKeyName()
The resource name for the configured Cloud KMS key.
KMS key name format:
"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"
For example:
"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"
To enable CMEK for the Log Router, set this field to a valid
kms_key_name for which the associated service account has the required
cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.
The Cloud KMS key used by the Log Router can be updated by changing the
kms_key_name to a new valid key name or disabled by setting the key name
to an empty string. Encryption operations that are in progress will be
completed with the key that was in use when they started. Decryption
operations will be completed using the key that was used at the time of
encryption unless access to that key has been revoked.
To disable CMEK for the Log Router, set this field to an empty string.
See Enabling CMEK for Log
Router
for more information.
string kms_key_name = 2;
| Returns |
|---|
| Type | Description |
String | The kmsKeyName.
|
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes()
The resource name for the configured Cloud KMS key.
KMS key name format:
"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"
For example:
"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"
To enable CMEK for the Log Router, set this field to a valid
kms_key_name for which the associated service account has the required
cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.
The Cloud KMS key used by the Log Router can be updated by changing the
kms_key_name to a new valid key name or disabled by setting the key name
to an empty string. Encryption operations that are in progress will be
completed with the key that was in use when they started. Decryption
operations will be completed using the key that was used at the time of
encryption unless access to that key has been revoked.
To disable CMEK for the Log Router, set this field to an empty string.
See Enabling CMEK for Log
Router
for more information.
string kms_key_name = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for kmsKeyName.
|
getKmsKeyVersionName()
public String getKmsKeyVersionName()
The CryptoKeyVersion resource name for the configured Cloud KMS key.
KMS key name format:
"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]"
For example:
"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"
This is a read-only field used to convey the specific configured
CryptoKeyVersion of kms_key that has been configured. It will be
populated in cases where the CMEK settings are bound to a single key
version.
If this field is populated, the kms_key is tied to a specific
CryptoKeyVersion.
string kms_key_version_name = 4;
| Returns |
|---|
| Type | Description |
String | The kmsKeyVersionName.
|
getKmsKeyVersionNameBytes()
public ByteString getKmsKeyVersionNameBytes()
The CryptoKeyVersion resource name for the configured Cloud KMS key.
KMS key name format:
"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]"
For example:
"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"
This is a read-only field used to convey the specific configured
CryptoKeyVersion of kms_key that has been configured. It will be
populated in cases where the CMEK settings are bound to a single key
version.
If this field is populated, the kms_key is tied to a specific
CryptoKeyVersion.
string kms_key_version_name = 4;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for kmsKeyVersionName.
|
getName()
Output only. The resource name of the CMEK settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The resource name of the CMEK settings.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<CmekSettings> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getServiceAccountId()
public String getServiceAccountId()
Output only. The service account that will be used by the Log Router to
access your Cloud KMS key.
Before enabling CMEK for Log Router, you must first assign the
cloudkms.cryptoKeyEncrypterDecrypter role to the service account that
the Log Router will use to access your Cloud KMS key. Use
GetCmekSettings to
obtain the service account ID.
See Enabling CMEK for Log
Router
for more information.
string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The serviceAccountId.
|
getServiceAccountIdBytes()
public ByteString getServiceAccountIdBytes()
Output only. The service account that will be used by the Log Router to
access your Cloud KMS key.
Before enabling CMEK for Log Router, you must first assign the
cloudkms.cryptoKeyEncrypterDecrypter role to the service account that
the Log Router will use to access your Cloud KMS key. Use
GetCmekSettings to
obtain the service account ID.
See Enabling CMEK for Log
Router
for more information.
string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for serviceAccountId.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CmekSettings.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CmekSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public CmekSettings.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
