Class Bucket.Encryption (2.53.3) 

public static final class Bucket.Encryption extends GeneratedMessageV3 implements Bucket.EncryptionOrBuilder

Encryption properties of a bucket.

Protobuf type google.storage.v2.Bucket.Encryption

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Bucket.Encryption

Static Fields

CUSTOMER_MANAGED_ENCRYPTION_ENFORCEMENT_CONFIG_FIELD_NUMBER

public static final int CUSTOMER_MANAGED_ENCRYPTION_ENFORCEMENT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CUSTOMER_SUPPLIED_ENCRYPTION_ENFORCEMENT_CONFIG_FIELD_NUMBER

public static final int CUSTOMER_SUPPLIED_ENCRYPTION_ENFORCEMENT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_KMS_KEY_FIELD_NUMBER

public static final int DEFAULT_KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int

GOOGLE_MANAGED_ENCRYPTION_ENFORCEMENT_CONFIG_FIELD_NUMBER

public static final int GOOGLE_MANAGED_ENCRYPTION_ENFORCEMENT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Bucket.Encryption getDefaultInstance()
Returns
Type Description
Bucket.Encryption

getDescriptor()

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

newBuilder()

public static Bucket.Encryption.Builder newBuilder()
Returns
Type Description
Bucket.Encryption.Builder

newBuilder(Bucket.Encryption prototype)

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

parseDelimitedFrom(InputStream input)

public static Bucket.Encryption parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Bucket.Encryption
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Bucket.Encryption parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Bucket.Encryption
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Bucket.Encryption parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Bucket.Encryption
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Bucket.Encryption parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Bucket.Encryption
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Bucket.Encryption parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Bucket.Encryption
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Bucket.Encryption> parser()
Returns
Type Description
Parser<Encryption>

Methods

equals(Object obj)

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

getCustomerManagedEncryptionEnforcementConfig()

public Bucket.Encryption.CustomerManagedEncryptionEnforcementConfig getCustomerManagedEncryptionEnforcementConfig()

Optional. If omitted, then new objects with CMEK encryption-type is allowed. If set, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.

optional .google.storage.v2.Bucket.Encryption.CustomerManagedEncryptionEnforcementConfig customer_managed_encryption_enforcement_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Bucket.Encryption.CustomerManagedEncryptionEnforcementConfig

The customerManagedEncryptionEnforcementConfig.

getCustomerManagedEncryptionEnforcementConfigOrBuilder()

public Bucket.Encryption.CustomerManagedEncryptionEnforcementConfigOrBuilder getCustomerManagedEncryptionEnforcementConfigOrBuilder()

Optional. If omitted, then new objects with CMEK encryption-type is allowed. If set, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.

optional .google.storage.v2.Bucket.Encryption.CustomerManagedEncryptionEnforcementConfig customer_managed_encryption_enforcement_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Bucket.Encryption.CustomerManagedEncryptionEnforcementConfigOrBuilder

getCustomerSuppliedEncryptionEnforcementConfig()

public Bucket.Encryption.CustomerSuppliedEncryptionEnforcementConfig getCustomerSuppliedEncryptionEnforcementConfig()

Optional. If omitted, then new objects with CSEK encryption-type is allowed. If set, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.

optional .google.storage.v2.Bucket.Encryption.CustomerSuppliedEncryptionEnforcementConfig customer_supplied_encryption_enforcement_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Bucket.Encryption.CustomerSuppliedEncryptionEnforcementConfig

The customerSuppliedEncryptionEnforcementConfig.

getCustomerSuppliedEncryptionEnforcementConfigOrBuilder()

public Bucket.Encryption.CustomerSuppliedEncryptionEnforcementConfigOrBuilder getCustomerSuppliedEncryptionEnforcementConfigOrBuilder()

Optional. If omitted, then new objects with CSEK encryption-type is allowed. If set, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.

optional .google.storage.v2.Bucket.Encryption.CustomerSuppliedEncryptionEnforcementConfig customer_supplied_encryption_enforcement_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Bucket.Encryption.CustomerSuppliedEncryptionEnforcementConfigOrBuilder

getDefaultInstanceForType()

public Bucket.Encryption getDefaultInstanceForType()
Returns
Type Description
Bucket.Encryption

getDefaultKmsKey()

public String getDefaultKmsKey()

Optional. The name of the Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.

string default_kms_key = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The defaultKmsKey.

getDefaultKmsKeyBytes()

public ByteString getDefaultKmsKeyBytes()

Optional. The name of the Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.

string default_kms_key = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for defaultKmsKey.

getGoogleManagedEncryptionEnforcementConfig()

public Bucket.Encryption.GoogleManagedEncryptionEnforcementConfig getGoogleManagedEncryptionEnforcementConfig()

Optional. If omitted, then new objects with GMEK encryption-type is allowed. If set, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.

optional .google.storage.v2.Bucket.Encryption.GoogleManagedEncryptionEnforcementConfig google_managed_encryption_enforcement_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Bucket.Encryption.GoogleManagedEncryptionEnforcementConfig

The googleManagedEncryptionEnforcementConfig.

getGoogleManagedEncryptionEnforcementConfigOrBuilder()

public Bucket.Encryption.GoogleManagedEncryptionEnforcementConfigOrBuilder getGoogleManagedEncryptionEnforcementConfigOrBuilder()

Optional. If omitted, then new objects with GMEK encryption-type is allowed. If set, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.

optional .google.storage.v2.Bucket.Encryption.GoogleManagedEncryptionEnforcementConfig google_managed_encryption_enforcement_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Bucket.Encryption.GoogleManagedEncryptionEnforcementConfigOrBuilder

getParserForType()

public Parser<Bucket.Encryption> getParserForType()
Returns
Type Description
Parser<Encryption>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCustomerManagedEncryptionEnforcementConfig()

public boolean hasCustomerManagedEncryptionEnforcementConfig()

Optional. If omitted, then new objects with CMEK encryption-type is allowed. If set, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.

optional .google.storage.v2.Bucket.Encryption.CustomerManagedEncryptionEnforcementConfig customer_managed_encryption_enforcement_config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the customerManagedEncryptionEnforcementConfig field is set.

hasCustomerSuppliedEncryptionEnforcementConfig()

public boolean hasCustomerSuppliedEncryptionEnforcementConfig()

Optional. If omitted, then new objects with CSEK encryption-type is allowed. If set, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.

optional .google.storage.v2.Bucket.Encryption.CustomerSuppliedEncryptionEnforcementConfig customer_supplied_encryption_enforcement_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the customerSuppliedEncryptionEnforcementConfig field is set.

hasGoogleManagedEncryptionEnforcementConfig()

public boolean hasGoogleManagedEncryptionEnforcementConfig()

Optional. If omitted, then new objects with GMEK encryption-type is allowed. If set, then new objects created in this bucket must comply with enforcement config. Changing this has no effect on existing objects; it applies to new objects only.

optional .google.storage.v2.Bucket.Encryption.GoogleManagedEncryptionEnforcementConfig google_managed_encryption_enforcement_config = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the googleManagedEncryptionEnforcementConfig 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 Bucket.Encryption.Builder newBuilderForType()
Returns
Type Description
Bucket.Encryption.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Bucket.Encryption.Builder toBuilder()
Returns
Type Description
Bucket.Encryption.Builder

writeTo(CodedOutputStream output)

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