Class: Google::Cloud::Container::V1::Cluster

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

Overview

A Google Kubernetes Engine cluster.

Defined Under Namespace

Modules: Status Classes: ResourceLabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#addons_config ⇒ ::Google::Cloud::Container::V1::AddonsConfig

Returns Configurations for the various addons available to run in the cluster.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#authenticator_groups_config ⇒ ::Google::Cloud::Container::V1::AuthenticatorGroupsConfig

Returns Configuration controlling RBAC group membership information.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#autopilot ⇒ ::Google::Cloud::Container::V1::Autopilot

Returns Autopilot configuration for the cluster.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#autoscaling ⇒ ::Google::Cloud::Container::V1::ClusterAutoscaling

Returns Cluster-level autoscaling configuration.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#binary_authorization ⇒ ::Google::Cloud::Container::V1::BinaryAuthorization

Returns Configuration for Binary Authorization.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#cluster_ipv4_cidr ⇒ ::String

Returns The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

Returns:

  • (::String) —

    The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#conditions ⇒ ::Array<::Google::Cloud::Container::V1::StatusCondition>

Returns Which conditions caused the current cluster state.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#confidential_nodes ⇒ ::Google::Cloud::Container::V1::ConfidentialNodes

Returns Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#create_time ⇒ ::String

Returns [Output only] The time the cluster was created, in RFC3339 text format.

Returns:

  • (::String) —

    [Output only] The time the cluster was created, in RFC3339 text format.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#current_master_version ⇒ ::String

Returns [Output only] The current software version of the master endpoint.

Returns:

  • (::String) —

    [Output only] The current software version of the master endpoint.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#current_node_count ⇒ ::Integer

Returns [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

Returns:

  • (::Integer) —

    [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#current_node_version ⇒ ::String

Returns [Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

Returns:

  • (::String) —

    [Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#database_encryption ⇒ ::Google::Cloud::Container::V1::DatabaseEncryption

Returns Configuration of etcd encryption.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#default_max_pods_constraint ⇒ ::Google::Cloud::Container::V1::MaxPodsConstraint

Returns The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#description ⇒ ::String

Returns An optional description of this cluster.

Returns:

  • (::String) —

    An optional description of this cluster.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#enable_kubernetes_alpha ⇒ ::Boolean

Returns Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

Returns:

  • (::Boolean) —

    Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#enable_tpu ⇒ ::Boolean

Returns Enable the ability to use Cloud TPUs in this cluster.

Returns:

  • (::Boolean) —

    Enable the ability to use Cloud TPUs in this cluster.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#endpoint ⇒ ::String

Returns [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/.

See the masterAuth property of this resource for username and password information.

Returns:

  • (::String) —

    [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/.

    See the masterAuth property of this resource for username and password information.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#expire_time ⇒ ::String

Returns [Output only] The time the cluster will be automatically deleted in RFC3339 text format.

Returns:

  • (::String) —

    [Output only] The time the cluster will be automatically deleted in RFC3339 text format.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#id ⇒ ::String (readonly)

Returns Output only. Unique id for the cluster.

Returns:

  • (::String) —

    Output only. Unique id for the cluster.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#identity_service_config ⇒ ::Google::Cloud::Container::V1::IdentityServiceConfig

Returns Configuration for Identity Service component.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#initial_cluster_version ⇒ ::String

Returns The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "","-": picks the default Kubernetes version.

Returns:

  • (::String) —

    The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

    Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

    • "latest": picks the highest valid Kubernetes version
    • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
    • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
    • "1.X.Y-gke.N": picks an explicit Kubernetes version
    • "","-": picks the default Kubernetes version


1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#initial_node_count ⇒ ::Integer

Returns The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.

This field is deprecated, use node_pool.initial_node_count instead.

Returns:

  • (::Integer) —

    The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.

    This field is deprecated, use node_pool.initial_node_count instead.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#instance_group_urls ⇒ ::Array<::String>

Returns Deprecated. Use node_pools.instance_group_urls.

Returns:

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

    Deprecated. Use node_pools.instance_group_urls.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#ip_allocation_policy ⇒ ::Google::Cloud::Container::V1::IPAllocationPolicy

Returns Configuration for cluster IP allocation.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#label_fingerprint ⇒ ::String

Returns The fingerprint of the set of labels for this cluster.

Returns:

  • (::String) —

    The fingerprint of the set of labels for this cluster.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#legacy_abac ⇒ ::Google::Cloud::Container::V1::LegacyAbac

Returns Configuration for the legacy ABAC authorization mode.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#location ⇒ ::String

Returns [Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

Returns:

  • (::String) —

    [Output only] The name of the Google Compute Engine zone or region in which the cluster resides.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#locations ⇒ ::Array<::String>

Returns The list of Google Compute Engine zones in which the cluster's nodes should be located.

This field provides a default value if NodePool.Locations are not specified during node pool creation.

Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

Returns:

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

    The list of Google Compute Engine zones in which the cluster's nodes should be located.

    This field provides a default value if NodePool.Locations are not specified during node pool creation.

    Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#logging_config ⇒ ::Google::Cloud::Container::V1::LoggingConfig

Returns Logging configuration for the cluster.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#logging_service ⇒ ::String

Returns The logging service the cluster should use to write logs. Currently available options:

  • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model
  • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).
  • none - no logs will be exported from the cluster.

If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.

Returns:

  • (::String) —

    The logging service the cluster should use to write logs. Currently available options:

    • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model
    • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).
    • none - no logs will be exported from the cluster.

    If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

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

Returns Configure the maintenance policy for this cluster.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#master_auth ⇒ ::Google::Cloud::Container::V1::MasterAuth

Returns The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

Returns:

  • (::Google::Cloud::Container::V1::MasterAuth) —

    The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#master_authorized_networks_config ⇒ ::Google::Cloud::Container::V1::MasterAuthorizedNetworksConfig

Returns The configuration options for master authorized networks feature.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#mesh_certificates ⇒ ::Google::Cloud::Container::V1::MeshCertificates

Returns Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#monitoring_config ⇒ ::Google::Cloud::Container::V1::MonitoringConfig

Returns Monitoring configuration for the cluster.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#monitoring_service ⇒ ::String

Returns The monitoring service the cluster should use to write metrics. Currently available options:

  • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
  • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
  • none - No metrics will be exported from the cluster.

If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

Returns:

  • (::String) —

    The monitoring service the cluster should use to write metrics. Currently available options:

    • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
    • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
    • none - No metrics will be exported from the cluster.

    If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#name ⇒ ::String

Returns The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.
  • Must start with a letter.
  • Must end with a number or a letter.

Returns:

  • (::String) —

    The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

    • Lowercase letters, numbers, and hyphens only.
    • Must start with a letter.
    • Must end with a number or a letter.


1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#network ⇒ ::String

Returns The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

Returns:

  • (::String) —

    The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#network_config ⇒ ::Google::Cloud::Container::V1::NetworkConfig

Returns Configuration for cluster networking.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#network_policy ⇒ ::Google::Cloud::Container::V1::NetworkPolicy

Returns Configuration options for the NetworkPolicy feature.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#node_config ⇒ ::Google::Cloud::Container::V1::NodeConfig

Returns Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

Returns:

  • (::Google::Cloud::Container::V1::NodeConfig) —

    Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

    If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#node_ipv4_cidr_size ⇒ ::Integer

Returns [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

Returns:

  • (::Integer) —

    [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#node_pool_auto_config ⇒ ::Google::Cloud::Container::V1::NodePoolAutoConfig

Returns Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#node_pool_defaults ⇒ ::Google::Cloud::Container::V1::NodePoolDefaults

Returns Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#node_pools ⇒ ::Array<::Google::Cloud::Container::V1::NodePool>

Returns The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#notification_config ⇒ ::Google::Cloud::Container::V1::NotificationConfig

Returns Notification configuration of the cluster.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#private_cluster_config ⇒ ::Google::Cloud::Container::V1::PrivateClusterConfig

Returns Configuration for private cluster.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#release_channel ⇒ ::Google::Cloud::Container::V1::ReleaseChannel

Returns Release channel configuration.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

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

Returns The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

Returns:

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

    The resource labels for the cluster to use to annotate any related Google Compute Engine resources.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#resource_usage_export_config ⇒ ::Google::Cloud::Container::V1::ResourceUsageExportConfig

Returns Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#self_link ⇒ ::String

Returns [Output only] Server-defined URL for the resource.

Returns:

  • (::String) —

    [Output only] Server-defined URL for the resource.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#services_ipv4_cidr ⇒ ::String

Returns [Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

Returns:

  • (::String) —

    [Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#shielded_nodes ⇒ ::Google::Cloud::Container::V1::ShieldedNodes

Returns Shielded Nodes configuration.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#status ⇒ ::Google::Cloud::Container::V1::Cluster::Status

Returns [Output only] The current status of this cluster.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#status_message ⇒ ::String

Returns [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

Returns:

  • (::String) —

    [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#subnetwork ⇒ ::String

Returns The name of the Google Compute Engine subnetwork to which the cluster is connected.

Returns:

  • (::String) —

    The name of the Google Compute Engine subnetwork to which the cluster is connected.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#tpu_ipv4_cidr_block ⇒ ::String

Returns [Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

Returns:

  • (::String) —

    [Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#vertical_pod_autoscaling ⇒ ::Google::Cloud::Container::V1::VerticalPodAutoscaling

Returns Cluster-level Vertical Pod Autoscaling configuration.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#workload_identity_config ⇒ ::Google::Cloud::Container::V1::WorkloadIdentityConfig

Returns Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

Returns:



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end

#zone ⇒ ::String

Returns [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

Returns:

  • (::String) —

    [Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
 
# File 'proto_docs/google/container/v1/cluster_service.rb', line 1329

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

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

  # The current status of the cluster.
  module Status
    # Not set.
    STATUS_UNSPECIFIED = 0

    # The PROVISIONING state indicates the cluster is being created.
    PROVISIONING = 1

    # The RUNNING state indicates the cluster has been created and is fully
    # usable.
    RUNNING = 2

    # The RECONCILING state indicates that some work is actively being done on
    # the cluster, such as upgrading the master or node software. Details can
    # be found in the `statusMessage` field.
    RECONCILING = 3

    # The STOPPING state indicates the cluster is being deleted.
    STOPPING = 4

    # The ERROR state indicates the cluster is unusable. It will be
    # automatically deleted. Details can be found in the `statusMessage` field.
    ERROR = 5

    # The DEGRADED state indicates the cluster requires user action to restore
    # full functionality. Details can be found in the `statusMessage` field.
    DEGRADED = 6
  end
end