Class: Google::Apis::ContainerV1::ClusterUpdate

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/container_v1/classes.rb,
generated/google/apis/container_v1/representations.rb,
generated/google/apis/container_v1/representations.rb

Overview

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ClusterUpdate

Returns a new instance of ClusterUpdate



602
603
604
 
# File 'generated/google/apis/container_v1/classes.rb', line 602

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

Instance Attribute Details

#desired_addons_config ⇒ Google::Apis::ContainerV1::AddonsConfig

Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. Corresponds to the JSON property desiredAddonsConfig

Returns:



528
529
530
 
# File 'generated/google/apis/container_v1/classes.rb', line 528

def desired_addons_config
  @desired_addons_config
end

#desired_image_type ⇒ String

The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well. Corresponds to the JSON property desiredImageType

Returns:

  • (String) 


534
535
536
 
# File 'generated/google/apis/container_v1/classes.rb', line 534

def desired_image_type
  @desired_image_type
end

#desired_locations ⇒ Array<String>

The desired list of Google Compute Engine locations in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. Corresponds to the JSON property desiredLocations

Returns:

  • (Array<String>) 


544
545
546
 
# File 'generated/google/apis/container_v1/classes.rb', line 544

def desired_locations
  @desired_locations
end

#desired_master_authorized_networks_config ⇒ Google::Apis::ContainerV1::MasterAuthorizedNetworksConfig

Master authorized networks is a Beta feature. Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. Corresponds to the JSON property desiredMasterAuthorizedNetworksConfig

Returns:



553
554
555
 
# File 'generated/google/apis/container_v1/classes.rb', line 553

def desired_master_authorized_networks_config
  @desired_master_authorized_networks_config
end

#desired_master_version ⇒ String

The Kubernetes version to change the master to. 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 Corresponds to the JSON property desiredMasterVersion

Returns:

  • (String) 


565
566
567
 
# File 'generated/google/apis/container_v1/classes.rb', line 565

def desired_master_version
  @desired_master_version
end

#desired_monitoring_service ⇒ String

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

  • "monitoring.googleapis.com" - the Google Cloud Monitoring service
  • "none" - no metrics will be exported from the cluster Corresponds to the JSON property desiredMonitoringService

Returns:

  • (String) 


573
574
575
 
# File 'generated/google/apis/container_v1/classes.rb', line 573

def desired_monitoring_service
  @desired_monitoring_service
end

#desired_node_pool_autoscaling ⇒ Google::Apis::ContainerV1::NodePoolAutoscaling

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Corresponds to the JSON property desiredNodePoolAutoscaling

Returns:



579
580
581
 
# File 'generated/google/apis/container_v1/classes.rb', line 579

def desired_node_pool_autoscaling
  @desired_node_pool_autoscaling
end

#desired_node_pool_id ⇒ String

The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster. Corresponds to the JSON property desiredNodePoolId

Returns:

  • (String) 


587
588
589
 
# File 'generated/google/apis/container_v1/classes.rb', line 587

def desired_node_pool_id
  @desired_node_pool_id
end

#desired_node_version ⇒ String

The Kubernetes version to change the nodes to (typically an upgrade). 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 Kubernetes master version Corresponds to the JSON property desiredNodeVersion

Returns:

  • (String) 


600
601
602
 
# File 'generated/google/apis/container_v1/classes.rb', line 600

def desired_node_version
  @desired_node_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



607
608
609
610
611
612
613
614
615
616
617
 
# File 'generated/google/apis/container_v1/classes.rb', line 607

def update!(**args)
  @desired_addons_config = args[:desired_addons_config] if args.key?(:desired_addons_config)
  @desired_image_type = args[:desired_image_type] if args.key?(:desired_image_type)
  @desired_locations = args[:desired_locations] if args.key?(:desired_locations)
  @desired_master_authorized_networks_config = args[:desired_master_authorized_networks_config] if args.key?(:desired_master_authorized_networks_config)
  @desired_master_version = args[:desired_master_version] if args.key?(:desired_master_version)
  @desired_monitoring_service = args[:desired_monitoring_service] if args.key?(:desired_monitoring_service)
  @desired_node_pool_autoscaling = args[:desired_node_pool_autoscaling] if args.key?(:desired_node_pool_autoscaling)
  @desired_node_pool_id = args[:desired_node_pool_id] if args.key?(:desired_node_pool_id)
  @desired_node_version = args[:desired_node_version] if args.key?(:desired_node_version)
end