Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1CmekConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

Configurations used to enable CMEK data encryption with Cloud KMS keys.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1CmekConfig

Returns a new instance of GoogleCloudDiscoveryengineV1CmekConfig.



812
813
814
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 812

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#is_default ⇒ Boolean Also known as: is_default?

Output only. The default CmekConfig for the Customer. Corresponds to the JSON property isDefault

Returns:

  • (Boolean) 


775
776
777
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 775

def is_default
  @is_default
end

#kms_key ⇒ String

Kms key resource name which will be used to encrypt resources projects/ project/locations/location/keyRings/keyRing/cryptoKeys/keyId`. Corresponds to the JSON propertykmsKey`

Returns:

  • (String) 


782
783
784
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 782

def kms_key
  @kms_key
end

#kms_key_version ⇒ String

Kms key version resource name which will be used to encrypt resources / cryptoKeyVersions/keyVersion`. Corresponds to the JSON propertykmsKeyVersion`

Returns:

  • (String) 


788
789
790
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 788

def kms_key_version
  @kms_key_version
end

#last_rotation_timestamp_micros ⇒ Fixnum

Output only. The timestamp of the last key rotation. Corresponds to the JSON property lastRotationTimestampMicros

Returns:

  • (Fixnum) 


793
794
795
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 793

def last_rotation_timestamp_micros
  @last_rotation_timestamp_micros
end

#name ⇒ String

Required. Name of the CmekConfig, of the form projects/project/locations/ location/cmekConfig or projects/project/locations/location/cmekConfigs/ cmekConfig`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


800
801
802
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 800

def name
  @name
end

#single_region_keys ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1SingleRegionKey>

Optional. Single-regional CMEKs that are required for some VAIS features. Corresponds to the JSON property singleRegionKeys

Returns:



805
806
807
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 805

def single_region_keys
  @single_region_keys
end

#state ⇒ String

Output only. State of the CmekConfig. Corresponds to the JSON property state

Returns:

  • (String) 


810
811
812
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 810

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



817
818
819
820
821
822
823
824
825
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 817

def update!(**args)
  @is_default = args[:is_default] if args.key?(:is_default)
  @kms_key = args[:kms_key] if args.key?(:kms_key)
  @kms_key_version = args[:kms_key_version] if args.key?(:kms_key_version)
  @last_rotation_timestamp_micros = args[:last_rotation_timestamp_micros] if args.key?(:last_rotation_timestamp_micros)
  @name = args[:name] if args.key?(:name)
  @single_region_keys = args[:single_region_keys] if args.key?(:single_region_keys)
  @state = args[:state] if args.key?(:state)
end