Class: Google::Cloud::EdgeContainer::V1::Cluster

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

Overview

A Google Distributed Cloud Edge Kubernetes cluster.

Defined Under Namespace

Modules: ReleaseChannel, Status Classes: ControlPlane, ControlPlaneEncryption, LabelsEntry, MaintenanceEvent, SurvivabilityConfig, SystemAddonsConfig

Instance Attribute Summary collapse

Instance Attribute Details

#authorization ⇒ ::Google::Cloud::EdgeContainer::V1::Authorization

Returns Required. Immutable. RBAC policy that will be applied and managed by GEC.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#cluster_ca_certificate ⇒ ::String (readonly)

Returns Output only. The PEM-encoded public certificate of the cluster's CA.

Returns:

  • (::String) —

    Output only. The PEM-encoded public certificate of the cluster's CA.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#control_plane ⇒ ::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane

Returns Optional. The configuration of the cluster control plane.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#control_plane_encryption ⇒ ::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlaneEncryption

Returns Optional. Remote control plane disk encryption options. This field is only used when enabling CMEK support.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#control_plane_version ⇒ ::String (readonly)

Returns Output only. The control plane release version.

Returns:

  • (::String) —

    Output only. The control plane release version



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the cluster was created.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#default_max_pods_per_node ⇒ ::Integer

Returns Optional. The default maximum number of pods per node used if a maximum value is not specified explicitly for a node pool in this cluster. If unspecified, the Kubernetes default value will be used.

Returns:

  • (::Integer) —

    Optional. The default maximum number of pods per node used if a maximum value is not specified explicitly for a node pool in this cluster. If unspecified, the Kubernetes default value will be used.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#endpoint ⇒ ::String (readonly)

Returns Output only. The IP address of the Kubernetes API server.

Returns:

  • (::String) —

    Output only. The IP address of the Kubernetes API server.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#external_load_balancer_ipv4_address_pools ⇒ ::Array<::String>

Returns Optional. IPv4 address pools for cluster data plane external load balancing.

Returns:

  • (::Array<::String>) —

    Optional. IPv4 address pools for cluster data plane external load balancing.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#external_load_balancer_ipv6_address_pools ⇒ ::Array<::String>

Returns Optional. IPv6 address pools for cluster data plane external load balancing.

Returns:

  • (::Array<::String>) —

    Optional. IPv6 address pools for cluster data plane external load balancing.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#fleet ⇒ ::Google::Cloud::EdgeContainer::V1::Fleet

Returns Required. Fleet configuration.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels associated with this resource.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels associated with this resource.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#maintenance_events ⇒ ::Array<::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent> (readonly)

Returns Output only. All the maintenance events scheduled for the cluster, including the ones ongoing, planned for the future and done in the past (up to 90 days).

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#maintenance_policy ⇒ ::Google::Cloud::EdgeContainer::V1::MaintenancePolicy

Returns Optional. Cluster-wide maintenance policy configuration.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#name ⇒ ::String

Returns Required. The resource name of the cluster.

Returns:

  • (::String) —

    Required. The resource name of the cluster.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#networking ⇒ ::Google::Cloud::EdgeContainer::V1::ClusterNetworking

Returns Required. Cluster-wide networking configuration.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#node_version ⇒ ::String (readonly)

Returns Output only. The lowest release version among all worker nodes. This field can be empty if the cluster does not have any worker nodes.

Returns:

  • (::String) —

    Output only. The lowest release version among all worker nodes. This field can be empty if the cluster does not have any worker nodes.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#port ⇒ ::Integer (readonly)

Returns Output only. The port number of the Kubernetes API server.

Returns:

  • (::Integer) —

    Output only. The port number of the Kubernetes API server.



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#release_channel ⇒ ::Google::Cloud::EdgeContainer::V1::Cluster::ReleaseChannel

Returns Optional. The release channel a cluster is subscribed to.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#status ⇒ ::Google::Cloud::EdgeContainer::V1::Cluster::Status (readonly)

Returns Output only. The current status of the cluster.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#survivability_config ⇒ ::Google::Cloud::EdgeContainer::V1::Cluster::SurvivabilityConfig

Returns Optional. Configuration of the cluster survivability, e.g., for the case when network connectivity is lost. Note: This only applies to local control plane clusters.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#system_addons_config ⇒ ::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig

Returns Optional. The configuration of the system add-ons.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#target_version ⇒ ::String

Returns Optional. The target cluster version. For example: "1.5.0".

Returns:

  • (::String) —

    Optional. The target cluster version. For example: "1.5.0".



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when the cluster was last updated.

Returns:



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'proto_docs/google/cloud/edgecontainer/v1/resources.rb', line 107

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

  # Configuration of the cluster control plane.
  # @!attribute [rw] remote
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Remote]
  #     Remote control plane configuration.
  # @!attribute [rw] local
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::Local]
  #     Local control plane configuration.
  #
  #     Warning: Local control plane clusters must be created in their own
  #     project. Local control plane clusters cannot coexist in the same
  #     project with any other type of clusters, including non-GDCE clusters.
  #     Mixing local control plane GDCE clusters with any other type of
  #     clusters in the same project can result in data loss.
  class ControlPlane
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configuration specific to clusters with a control plane hosted remotely.
    class Remote
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Configuration specific to clusters with a control plane hosted locally.
    #
    # Warning: Local control plane clusters must be created in their own
    # project. Local control plane clusters cannot coexist in the same
    # project with any other type of clusters, including non-GDCE clusters.
    # Mixing local control plane GDCE clusters with any other type of
    # clusters in the same project can result in data loss.
    # @!attribute [rw] node_location
    #   @return [::String]
    #     Name of the Google Distributed Cloud Edge zones where this node pool
    #     will be created. For example: `us-central1-edge-customer-a`.
    # @!attribute [rw] node_count
    #   @return [::Integer]
    #     The number of nodes to serve as replicas of the Control Plane.
    # @!attribute [rw] machine_filter
    #   @return [::String]
    #     Only machines matching this filter will be allowed to host control
    #     plane nodes. The filtering language accepts strings like "name=<name>",
    #     and is documented here: [AIP-160](https://google.aip.dev/160).
    # @!attribute [rw] shared_deployment_policy
    #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::ControlPlane::SharedDeploymentPolicy]
    #     Policy configuration about how user applications are deployed.
    class Local
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the policy configuration about how user applications are
    # deployed.
    module SharedDeploymentPolicy
      # Unspecified.
      SHARED_DEPLOYMENT_POLICY_UNSPECIFIED = 0

      # User applications can be deployed both on control plane and worker
      # nodes.
      ALLOWED = 1

      # User applications can not be deployed on control plane nodes and can
      # only be deployed on worker nodes.
      DISALLOWED = 2
    end
  end

  # Config that customers are allowed to define for GDCE system add-ons.
  # @!attribute [rw] ingress
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::SystemAddonsConfig::Ingress]
  #     Optional. Config for Ingress.
  class SystemAddonsConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Config for the Ingress add-on which allows customers to create an Ingress
    # object to manage external access to the servers in a cluster. The add-on
    # consists of istiod and istio-ingress.
    # @!attribute [rw] disabled
    #   @return [::Boolean]
    #     Optional. Whether Ingress is disabled.
    # @!attribute [rw] ipv4_vip
    #   @return [::String]
    #     Optional. Ingress VIP.
    class Ingress
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Configuration for Customer-managed KMS key support for remote control plane
  # cluster disk encryption.
  # @!attribute [rw] kms_key
  #   @return [::String]
  #     Immutable. The Cloud KMS CryptoKey e.g.
  #     projects/\\{project}/locations/\\{location}/keyRings/\\{keyRing}/cryptoKeys/\\{cryptoKey}
  #     to use for protecting control plane disks. If not specified, a
  #     Google-managed key will be used instead.
  # @!attribute [r] kms_key_active_version
  #   @return [::String]
  #     Output only. The Cloud KMS CryptoKeyVersion currently in use for
  #     protecting control plane disks. Only applicable if kms_key is set.
  # @!attribute [r] kms_key_state
  #   @return [::Google::Cloud::EdgeContainer::V1::KmsKeyState]
  #     Output only. Availability of the Cloud KMS CryptoKey. If not
  #     `KEY_AVAILABLE`, then nodes may go offline as they cannot access their
  #     local data. This can be caused by a lack of permissions to use the key,
  #     or if the key is disabled or deleted.
  # @!attribute [r] kms_status
  #   @return [::Google::Rpc::Status]
  #     Output only. Error status returned by Cloud KMS when using this key. This
  #     field may be populated only if `kms_key_state` is not
  #     `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the
  #     error status reported by Cloud KMS.
  class ControlPlaneEncryption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Maintenance Event is an operation that could cause temporary disruptions
  # to the cluster workloads, including Google-driven or user-initiated cluster
  # upgrades, user-initiated cluster configuration changes that require
  # restarting nodes, etc.
  # @!attribute [r] uuid
  #   @return [::String]
  #     Output only. UUID of the maintenance event.
  # @!attribute [r] target_version
  #   @return [::String]
  #     Output only. The target version of the cluster.
  # @!attribute [r] operation
  #   @return [::String]
  #     Output only. The operation for running the maintenance event. Specified
  #     in the format projects/*/locations/*/operations/*. If the maintenance
  #     event is split into multiple operations (e.g. due to maintenance
  #     windows), the latest one is recorded.
  # @!attribute [r] type
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Type]
  #     Output only. The type of the maintenance event.
  # @!attribute [r] schedule
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::Schedule]
  #     Output only. The schedule of the maintenance event.
  # @!attribute [r] state
  #   @return [::Google::Cloud::EdgeContainer::V1::Cluster::MaintenanceEvent::State]
  #     Output only. The state of the maintenance event.
  # @!attribute [r] create_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event request was created.
  # @!attribute [r] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event started.
  # @!attribute [r] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event ended, either
  #     successfully or not. If the maintenance event is split into multiple
  #     maintenance windows, end_time is only updated when the whole flow ends.
  # @!attribute [r] update_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when the maintenance event message was updated.
  class MaintenanceEvent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Indicates the maintenance event type.
    module Type
      # Unspecified.
      TYPE_UNSPECIFIED = 0

      # Upgrade initiated by users.
      USER_INITIATED_UPGRADE = 1

      # Upgrade driven by Google.
      GOOGLE_DRIVEN_UPGRADE = 2
    end

    # Indicates when the maintenance event should be performed.
    module Schedule
      # Unspecified.
      SCHEDULE_UNSPECIFIED = 0

      # Immediately after receiving the request.
      IMMEDIATELY = 1
    end

    # Indicates the maintenance event state.
    module State
      # Unspecified.
      STATE_UNSPECIFIED = 0

      # The maintenance event is ongoing. The cluster might be unusable.
      RECONCILING = 1

      # The maintenance event succeeded.
      SUCCEEDED = 2

      # The maintenance event failed.
      FAILED = 3
    end
  end

  # Configuration of the cluster survivability, e.g., for the case when network
  # connectivity is lost.
  # @!attribute [rw] offline_reboot_ttl
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Time period that allows the cluster nodes to be rebooted and
  #     become functional without network connectivity to Google. The default 0
  #     means not allowed. The maximum is 7 days.
  class SurvivabilityConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Indicates the status of the cluster.
  module Status
    # Status unknown.
    STATUS_UNSPECIFIED = 0

    # The cluster is being created.
    PROVISIONING = 1

    # The cluster is created and fully usable.
    RUNNING = 2

    # The cluster is being deleted.
    DELETING = 3

    # The status indicates that some errors occurred while reconciling/deleting
    # the cluster.
    ERROR = 4

    # The cluster is undergoing some work such as version upgrades, etc.
    RECONCILING = 5
  end

  # The release channel a cluster is subscribed to.
  module ReleaseChannel
    # Unspecified release channel. This will default to the REGULAR channel.
    RELEASE_CHANNEL_UNSPECIFIED = 0

    # No release channel.
    NONE = 1

    # Regular release channel.
    REGULAR = 2
  end
end