Class CmekSettings (0.3.0)

public final class CmekSettings extends GeneratedMessage implements CmekSettingsOrBuilder

Settings for configuring CMEK for a bucket.

Protobuf type google.cloud.observability.v1.CmekSettings

Static Fields

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_VERSION_FIELD_NUMBER

public static final int KMS_KEY_VERSION_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()
Returns
Type Description
CmekSettings

getDescriptor()

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

newBuilder()

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

newBuilder(CmekSettings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CmekSettings getDefaultInstanceForType()
Returns
Type Description
CmekSettings

getKmsKey()

public String getKmsKey()

Optional. The resource name for the configured Cloud KMS key. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]

For example:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key

string kms_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

Optional. The resource name for the configured Cloud KMS key. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]

For example:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key

string kms_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for kmsKey.

getKmsKeyVersion()

public String getKmsKeyVersion()

Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. The format is:

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 read-only field is used to convey the specific configured CryptoKeyVersion of the kms_key that has been configured. It is populated when the CMEK settings are bound to a single key version.

string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The kmsKeyVersion.

getKmsKeyVersionBytes()

public ByteString getKmsKeyVersionBytes()

Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. The format is:

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 read-only field is used to convey the specific configured CryptoKeyVersion of the kms_key that has been configured. It is populated when the CMEK settings are bound to a single key version.

string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for kmsKeyVersion.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccountId()

public String getServiceAccountId()

Output only. The service account used to access the key.

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 used to access the key.

string service_account_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for serviceAccountId.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CmekSettings.Builder newBuilderForType()
Returns
Type Description
CmekSettings.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CmekSettings.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CmekSettings.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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