Class: Google::Apis::ContainerV1beta1::Cluster

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

Instance Attribute Summary collapse

Instance Method Summary collapse

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

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Cluster

Returns a new instance of Cluster.


154
155
156
# File 'generated/google/apis/container_v1beta1/classes.rb', line 154

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

Instance Attribute Details

#cluster_api_versionString

The API version of the Kubernetes master and kubelets running in this cluster. Leave blank to pick up the latest stable release, or specify a version of the form "x.y.z". The Google Container Engine release notes lists the currently supported versions. If an incorrect version is specified, the server returns an error listing the currently supported versions. Corresponds to the JSON property clusterApiVersion

Returns:

  • (String)

36
37
38
# File 'generated/google/apis/container_v1beta1/classes.rb', line 36

def cluster_api_version
  @cluster_api_version
end

#container_ipv4_cidrString

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 or 172.16.0.0/12. Corresponds to the JSON property containerIpv4Cidr

Returns:

  • (String)

43
44
45
# File 'generated/google/apis/container_v1beta1/classes.rb', line 43

def container_ipv4_cidr
  @container_ipv4_cidr
end

#creation_timestampString

[Output only] The time the cluster was created, in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)

48
49
50
# File 'generated/google/apis/container_v1beta1/classes.rb', line 48

def creation_timestamp
  @creation_timestamp
end

#descriptionString

An optional description of this cluster. Corresponds to the JSON property description

Returns:

  • (String)

53
54
55
# File 'generated/google/apis/container_v1beta1/classes.rb', line 53

def description
  @description
end

#enable_cloud_loggingBoolean Also known as: enable_cloud_logging?

Whether logs from the cluster should be made available via the Google Cloud Logging service. This includes both logs from your applications running in the cluster as well as logs from the Kubernetes components themselves. Corresponds to the JSON property enableCloudLogging

Returns:

  • (Boolean)

60
61
62
# File 'generated/google/apis/container_v1beta1/classes.rb', line 60

def enable_cloud_logging
  @enable_cloud_logging
end

#enable_cloud_monitoringBoolean Also known as: enable_cloud_monitoring?

Whether metrics from the cluster should be made available via the Google Cloud Monitoring service. Corresponds to the JSON property enableCloudMonitoring

Returns:

  • (Boolean)

67
68
69
# File 'generated/google/apis/container_v1beta1/classes.rb', line 67

def enable_cloud_monitoring
  @enable_cloud_monitoring
end

#endpointString

[Output only] The IP address of this cluster's Kubernetes master. The endpoint can be accessed from the internet at https://username:[email protected]/. See the masterAuth property of this resource for username and password information. Corresponds to the JSON property endpoint

Returns:

  • (String)

76
77
78
# File 'generated/google/apis/container_v1beta1/classes.rb', line 76

def endpoint
  @endpoint
end

#instance_group_urlsArray<String>

[Output only] The resource URLs of instance groups associated with this cluster. Corresponds to the JSON property instanceGroupUrls

Returns:

  • (Array<String>)

82
83
84
# File 'generated/google/apis/container_v1beta1/classes.rb', line 82

def instance_group_urls
  @instance_group_urls
end

#master_authGoogle::Apis::ContainerV1beta1::MasterAuth

The authentication information for accessing the master. Authentication is either done using HTTP basic authentication or using a bearer token. Corresponds to the JSON property masterAuth


88
89
90
# File 'generated/google/apis/container_v1beta1/classes.rb', line 88

def master_auth
  @master_auth
end

#nameString

The name of this cluster. The name must be unique within this project and zone, 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. Corresponds to the JSON property name

Returns:

  • (String)

97
98
99
# File 'generated/google/apis/container_v1beta1/classes.rb', line 97

def name
  @name
end

#networkString

The name of the Google Compute Engine network to which the cluster is connected. Corresponds to the JSON property network

Returns:

  • (String)

103
104
105
# File 'generated/google/apis/container_v1beta1/classes.rb', line 103

def network
  @network
end

#node_configGoogle::Apis::ContainerV1beta1::NodeConfig

The machine type and image to use for all nodes in this cluster. See the descriptions of the child properties of nodeConfig. Corresponds to the JSON property nodeConfig


109
110
111
# File 'generated/google/apis/container_v1beta1/classes.rb', line 109

def node_config
  @node_config
end

#node_routing_prefix_sizeFixnum

[Output only] The size of the address space on each node for hosting containers. Corresponds to the JSON property nodeRoutingPrefixSize

Returns:

  • (Fixnum)

115
116
117
# File 'generated/google/apis/container_v1beta1/classes.rb', line 115

def node_routing_prefix_size
  @node_routing_prefix_size
end

#num_nodesFixnum

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 plus one (to include the master). You must also have available firewall and routes quota. Corresponds to the JSON property numNodes

Returns:

  • (Fixnum)

123
124
125
# File 'generated/google/apis/container_v1beta1/classes.rb', line 123

def num_nodes
  @num_nodes
end

[Output only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String)

128
129
130
# File 'generated/google/apis/container_v1beta1/classes.rb', line 128

def self_link
  @self_link
end

#services_ipv4_cidrString

[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. Corresponds to the JSON property servicesIpv4Cidr

Returns:

  • (String)

135
136
137
# File 'generated/google/apis/container_v1beta1/classes.rb', line 135

def services_ipv4_cidr
  @services_ipv4_cidr
end

#statusString

[Output only] The current status of this cluster. Corresponds to the JSON property status

Returns:

  • (String)

140
141
142
# File 'generated/google/apis/container_v1beta1/classes.rb', line 140

def status
  @status
end

#status_messageString

[Output only] Additional information about the current status of this cluster, if available. Corresponds to the JSON property statusMessage

Returns:

  • (String)

146
147
148
# File 'generated/google/apis/container_v1beta1/classes.rb', line 146

def status_message
  @status_message
end

#zoneString

[Output only] The name of the Google Compute Engine zone in which the cluster resides. Corresponds to the JSON property zone

Returns:

  • (String)

152
153
154
# File 'generated/google/apis/container_v1beta1/classes.rb', line 152

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'generated/google/apis/container_v1beta1/classes.rb', line 159

def update!(**args)
  @cluster_api_version = args[:cluster_api_version] unless args[:cluster_api_version].nil?
  @container_ipv4_cidr = args[:container_ipv4_cidr] unless args[:container_ipv4_cidr].nil?
  @creation_timestamp = args[:creation_timestamp] unless args[:creation_timestamp].nil?
  @description = args[:description] unless args[:description].nil?
  @enable_cloud_logging = args[:enable_cloud_logging] unless args[:enable_cloud_logging].nil?
  @enable_cloud_monitoring = args[:enable_cloud_monitoring] unless args[:enable_cloud_monitoring].nil?
  @endpoint = args[:endpoint] unless args[:endpoint].nil?
  @instance_group_urls = args[:instance_group_urls] unless args[:instance_group_urls].nil?
  @master_auth = args[:master_auth] unless args[:master_auth].nil?
  @name = args[:name] unless args[:name].nil?
  @network = args[:network] unless args[:network].nil?
  @node_config = args[:node_config] unless args[:node_config].nil?
  @node_routing_prefix_size = args[:node_routing_prefix_size] unless args[:node_routing_prefix_size].nil?
  @num_nodes = args[:num_nodes] unless args[:num_nodes].nil?
  @self_link = args[:self_link] unless args[:self_link].nil?
  @services_ipv4_cidr = args[:services_ipv4_cidr] unless args[:services_ipv4_cidr].nil?
  @status = args[:status] unless args[:status].nil?
  @status_message = args[:status_message] unless args[:status_message].nil?
  @zone = args[:zone] unless args[:zone].nil?
end