Class: Google::Cloud::DiscoveryEngine::V1::CmekConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb

Overview

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

Defined Under Namespace

Modules: NotebookLMState, State

Instance Attribute Summary collapse

Instance Attribute Details

#is_default ⇒ ::Boolean (readonly)

Returns Output only. The default CmekConfig for the Customer.

Returns:

  • (::Boolean) —

    Output only. The default CmekConfig for the Customer.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb', line 94

class CmekConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # States of the CmekConfig.
  module State
    # The CmekConfig state is unknown.
    STATE_UNSPECIFIED = 0

    # The CmekConfig is creating.
    CREATING = 1

    # The CmekConfig can be used with DataStores.
    ACTIVE = 2

    # The CmekConfig is unavailable, most likely due to the KMS Key being
    # revoked.
    KEY_ISSUE = 3

    # The CmekConfig is deleting.
    DELETING = 4

    # The CmekConfig deletion process failed.
    DELETE_FAILED = 7

    # The CmekConfig is not usable, most likely due to some internal issue.
    UNUSABLE = 5

    # The KMS key version is being rotated.
    ACTIVE_ROTATING = 6

    # The KMS key is soft deleted. Some cleanup policy will eventually be
    # applied.
    DELETED = 8
  end

  # States of NotebookLM.
  module NotebookLMState
    # The NotebookLM state is unknown.
    NOTEBOOK_LM_STATE_UNSPECIFIED = 0

    # The NotebookLM is not ready.
    NOTEBOOK_LM_NOT_READY = 1

    # The NotebookLM is ready to be used.
    NOTEBOOK_LM_READY = 2

    # The NotebookLM is not enabled.
    NOTEBOOK_LM_NOT_ENABLED = 3
  end
end

#kms_key ⇒ ::String

Returns KMS key resource name which will be used to encrypt resources projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

Returns:

  • (::String) —

    KMS key resource name which will be used to encrypt resources projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb', line 94

class CmekConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # States of the CmekConfig.
  module State
    # The CmekConfig state is unknown.
    STATE_UNSPECIFIED = 0

    # The CmekConfig is creating.
    CREATING = 1

    # The CmekConfig can be used with DataStores.
    ACTIVE = 2

    # The CmekConfig is unavailable, most likely due to the KMS Key being
    # revoked.
    KEY_ISSUE = 3

    # The CmekConfig is deleting.
    DELETING = 4

    # The CmekConfig deletion process failed.
    DELETE_FAILED = 7

    # The CmekConfig is not usable, most likely due to some internal issue.
    UNUSABLE = 5

    # The KMS key version is being rotated.
    ACTIVE_ROTATING = 6

    # The KMS key is soft deleted. Some cleanup policy will eventually be
    # applied.
    DELETED = 8
  end

  # States of NotebookLM.
  module NotebookLMState
    # The NotebookLM state is unknown.
    NOTEBOOK_LM_STATE_UNSPECIFIED = 0

    # The NotebookLM is not ready.
    NOTEBOOK_LM_NOT_READY = 1

    # The NotebookLM is ready to be used.
    NOTEBOOK_LM_READY = 2

    # The NotebookLM is not enabled.
    NOTEBOOK_LM_NOT_ENABLED = 3
  end
end

#kms_key_version ⇒ ::String

Returns KMS key version resource name which will be used to encrypt resources <kms_key>/cryptoKeyVersions/{keyVersion}.

Returns:

  • (::String) —

    KMS key version resource name which will be used to encrypt resources <kms_key>/cryptoKeyVersions/{keyVersion}.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb', line 94

class CmekConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # States of the CmekConfig.
  module State
    # The CmekConfig state is unknown.
    STATE_UNSPECIFIED = 0

    # The CmekConfig is creating.
    CREATING = 1

    # The CmekConfig can be used with DataStores.
    ACTIVE = 2

    # The CmekConfig is unavailable, most likely due to the KMS Key being
    # revoked.
    KEY_ISSUE = 3

    # The CmekConfig is deleting.
    DELETING = 4

    # The CmekConfig deletion process failed.
    DELETE_FAILED = 7

    # The CmekConfig is not usable, most likely due to some internal issue.
    UNUSABLE = 5

    # The KMS key version is being rotated.
    ACTIVE_ROTATING = 6

    # The KMS key is soft deleted. Some cleanup policy will eventually be
    # applied.
    DELETED = 8
  end

  # States of NotebookLM.
  module NotebookLMState
    # The NotebookLM state is unknown.
    NOTEBOOK_LM_STATE_UNSPECIFIED = 0

    # The NotebookLM is not ready.
    NOTEBOOK_LM_NOT_READY = 1

    # The NotebookLM is ready to be used.
    NOTEBOOK_LM_READY = 2

    # The NotebookLM is not enabled.
    NOTEBOOK_LM_NOT_ENABLED = 3
  end
end

#last_rotation_timestamp_micros ⇒ ::Integer (readonly)

Returns Output only. The timestamp of the last key rotation.

Returns:

  • (::Integer) —

    Output only. The timestamp of the last key rotation.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb', line 94

class CmekConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # States of the CmekConfig.
  module State
    # The CmekConfig state is unknown.
    STATE_UNSPECIFIED = 0

    # The CmekConfig is creating.
    CREATING = 1

    # The CmekConfig can be used with DataStores.
    ACTIVE = 2

    # The CmekConfig is unavailable, most likely due to the KMS Key being
    # revoked.
    KEY_ISSUE = 3

    # The CmekConfig is deleting.
    DELETING = 4

    # The CmekConfig deletion process failed.
    DELETE_FAILED = 7

    # The CmekConfig is not usable, most likely due to some internal issue.
    UNUSABLE = 5

    # The KMS key version is being rotated.
    ACTIVE_ROTATING = 6

    # The KMS key is soft deleted. Some cleanup policy will eventually be
    # applied.
    DELETED = 8
  end

  # States of NotebookLM.
  module NotebookLMState
    # The NotebookLM state is unknown.
    NOTEBOOK_LM_STATE_UNSPECIFIED = 0

    # The NotebookLM is not ready.
    NOTEBOOK_LM_NOT_READY = 1

    # The NotebookLM is ready to be used.
    NOTEBOOK_LM_READY = 2

    # The NotebookLM is not enabled.
    NOTEBOOK_LM_NOT_ENABLED = 3
  end
end

#name ⇒ ::String

Returns Required. The name of the CmekConfig of the form projects/{project}/locations/{location}/cmekConfig or projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

Returns:

  • (::String) —

    Required. The name of the CmekConfig of the form projects/{project}/locations/{location}/cmekConfig or projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb', line 94

class CmekConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # States of the CmekConfig.
  module State
    # The CmekConfig state is unknown.
    STATE_UNSPECIFIED = 0

    # The CmekConfig is creating.
    CREATING = 1

    # The CmekConfig can be used with DataStores.
    ACTIVE = 2

    # The CmekConfig is unavailable, most likely due to the KMS Key being
    # revoked.
    KEY_ISSUE = 3

    # The CmekConfig is deleting.
    DELETING = 4

    # The CmekConfig deletion process failed.
    DELETE_FAILED = 7

    # The CmekConfig is not usable, most likely due to some internal issue.
    UNUSABLE = 5

    # The KMS key version is being rotated.
    ACTIVE_ROTATING = 6

    # The KMS key is soft deleted. Some cleanup policy will eventually be
    # applied.
    DELETED = 8
  end

  # States of NotebookLM.
  module NotebookLMState
    # The NotebookLM state is unknown.
    NOTEBOOK_LM_STATE_UNSPECIFIED = 0

    # The NotebookLM is not ready.
    NOTEBOOK_LM_NOT_READY = 1

    # The NotebookLM is ready to be used.
    NOTEBOOK_LM_READY = 2

    # The NotebookLM is not enabled.
    NOTEBOOK_LM_NOT_ENABLED = 3
  end
end

#notebooklm_state ⇒ ::Google::Cloud::DiscoveryEngine::V1::CmekConfig::NotebookLMState (readonly)

Returns Output only. Whether the NotebookLM Corpus is ready to be used.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb', line 94

class CmekConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # States of the CmekConfig.
  module State
    # The CmekConfig state is unknown.
    STATE_UNSPECIFIED = 0

    # The CmekConfig is creating.
    CREATING = 1

    # The CmekConfig can be used with DataStores.
    ACTIVE = 2

    # The CmekConfig is unavailable, most likely due to the KMS Key being
    # revoked.
    KEY_ISSUE = 3

    # The CmekConfig is deleting.
    DELETING = 4

    # The CmekConfig deletion process failed.
    DELETE_FAILED = 7

    # The CmekConfig is not usable, most likely due to some internal issue.
    UNUSABLE = 5

    # The KMS key version is being rotated.
    ACTIVE_ROTATING = 6

    # The KMS key is soft deleted. Some cleanup policy will eventually be
    # applied.
    DELETED = 8
  end

  # States of NotebookLM.
  module NotebookLMState
    # The NotebookLM state is unknown.
    NOTEBOOK_LM_STATE_UNSPECIFIED = 0

    # The NotebookLM is not ready.
    NOTEBOOK_LM_NOT_READY = 1

    # The NotebookLM is ready to be used.
    NOTEBOOK_LM_READY = 2

    # The NotebookLM is not enabled.
    NOTEBOOK_LM_NOT_ENABLED = 3
  end
end

#single_region_keys ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::SingleRegionKey>

Returns Optional. Single-regional CMEKs that are required for some VAIS features.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb', line 94

class CmekConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # States of the CmekConfig.
  module State
    # The CmekConfig state is unknown.
    STATE_UNSPECIFIED = 0

    # The CmekConfig is creating.
    CREATING = 1

    # The CmekConfig can be used with DataStores.
    ACTIVE = 2

    # The CmekConfig is unavailable, most likely due to the KMS Key being
    # revoked.
    KEY_ISSUE = 3

    # The CmekConfig is deleting.
    DELETING = 4

    # The CmekConfig deletion process failed.
    DELETE_FAILED = 7

    # The CmekConfig is not usable, most likely due to some internal issue.
    UNUSABLE = 5

    # The KMS key version is being rotated.
    ACTIVE_ROTATING = 6

    # The KMS key is soft deleted. Some cleanup policy will eventually be
    # applied.
    DELETED = 8
  end

  # States of NotebookLM.
  module NotebookLMState
    # The NotebookLM state is unknown.
    NOTEBOOK_LM_STATE_UNSPECIFIED = 0

    # The NotebookLM is not ready.
    NOTEBOOK_LM_NOT_READY = 1

    # The NotebookLM is ready to be used.
    NOTEBOOK_LM_READY = 2

    # The NotebookLM is not enabled.
    NOTEBOOK_LM_NOT_ENABLED = 3
  end
end

#state ⇒ ::Google::Cloud::DiscoveryEngine::V1::CmekConfig::State (readonly)

Returns Output only. The states of the CmekConfig.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb', line 94

class CmekConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # States of the CmekConfig.
  module State
    # The CmekConfig state is unknown.
    STATE_UNSPECIFIED = 0

    # The CmekConfig is creating.
    CREATING = 1

    # The CmekConfig can be used with DataStores.
    ACTIVE = 2

    # The CmekConfig is unavailable, most likely due to the KMS Key being
    # revoked.
    KEY_ISSUE = 3

    # The CmekConfig is deleting.
    DELETING = 4

    # The CmekConfig deletion process failed.
    DELETE_FAILED = 7

    # The CmekConfig is not usable, most likely due to some internal issue.
    UNUSABLE = 5

    # The KMS key version is being rotated.
    ACTIVE_ROTATING = 6

    # The KMS key is soft deleted. Some cleanup policy will eventually be
    # applied.
    DELETED = 8
  end

  # States of NotebookLM.
  module NotebookLMState
    # The NotebookLM state is unknown.
    NOTEBOOK_LM_STATE_UNSPECIFIED = 0

    # The NotebookLM is not ready.
    NOTEBOOK_LM_NOT_READY = 1

    # The NotebookLM is ready to be used.
    NOTEBOOK_LM_READY = 2

    # The NotebookLM is not enabled.
    NOTEBOOK_LM_NOT_ENABLED = 3
  end
end