Class: Google::Apis::GkeonpremV1::BareMetalAdminCluster

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gkeonprem_v1/classes.rb,
lib/google/apis/gkeonprem_v1/representations.rb,
lib/google/apis/gkeonprem_v1/representations.rb

Overview

Resource that represents a bare metal admin cluster.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BareMetalAdminCluster

Returns a new instance of BareMetalAdminCluster.



248
249
250
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 248

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Annotations on the bare metal admin cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


90
91
92
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 90

def annotations
  @annotations
end

#bare_metal_version ⇒ String

The Anthos clusters on bare metal version for the bare metal admin cluster. Corresponds to the JSON property bareMetalVersion

Returns:

  • (String) 


95
96
97
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 95

def bare_metal_version
  @bare_metal_version
end

#cluster_operations ⇒ Google::Apis::GkeonpremV1::BareMetalAdminClusterOperationsConfig

BareMetalAdminClusterOperationsConfig specifies the admin cluster's observability infrastructure. Corresponds to the JSON property clusterOperations

Returns:



101
102
103
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 101

def cluster_operations
  @cluster_operations
end

#control_plane ⇒ Google::Apis::GkeonpremV1::BareMetalAdminControlPlaneConfig

BareMetalAdminControlPlaneConfig specifies the control plane configuration. Corresponds to the JSON property controlPlane

Returns:



106
107
108
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 106

def control_plane
  @control_plane
end

#create_time ⇒ String

Output only. The time at which this bare metal admin cluster was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


111
112
113
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 111

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. The time at which this bare metal admin cluster was deleted. If the resource is not deleted, this must be empty Corresponds to the JSON property deleteTime

Returns:

  • (String) 


117
118
119
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 117

def delete_time
  @delete_time
end

#description ⇒ String

A human readable description of this bare metal admin cluster. Corresponds to the JSON property description

Returns:

  • (String) 


122
123
124
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 122

def description
  @description
end

#endpoint ⇒ String

Output only. The IP address name of bare metal admin cluster's API server. Corresponds to the JSON property endpoint

Returns:

  • (String) 


127
128
129
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 127

def endpoint
  @endpoint
end

#etag ⇒ String

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up- to-date value before proceeding. Allows clients to perform consistent read- modify-writes through optimistic concurrency control. Corresponds to the JSON property etag

Returns:

  • (String) 


135
136
137
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 135

def etag
  @etag
end

#fleet ⇒ Google::Apis::GkeonpremV1::Fleet

Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See Anthos Fleets for more details on Anthos multi-cluster capabilities using Fleets. ## Corresponds to the JSON property fleet

Returns:



144
145
146
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 144

def fleet
  @fleet
end

#load_balancer ⇒ Google::Apis::GkeonpremV1::BareMetalAdminLoadBalancerConfig

BareMetalAdminLoadBalancerConfig specifies the load balancer configuration. Corresponds to the JSON property loadBalancer

Returns:



149
150
151
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 149

def load_balancer
  @load_balancer
end

#local_name ⇒ String

Output only. The object name of the bare metal cluster custom resource. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs. Corresponds to the JSON property localName

Returns:

  • (String) 


161
162
163
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 161

def local_name
  @local_name
end

#maintenance_config ⇒ Google::Apis::GkeonpremV1::BareMetalAdminMaintenanceConfig

BareMetalAdminMaintenanceConfig specifies configurations to put bare metal Admin cluster CRs nodes in and out of maintenance. Corresponds to the JSON property maintenanceConfig

Returns:



167
168
169
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 167

def maintenance_config
  @maintenance_config
end

#maintenance_status ⇒ Google::Apis::GkeonpremV1::BareMetalAdminMaintenanceStatus

BareMetalAdminMaintenanceStatus represents the maintenance status for bare metal Admin cluster CR's nodes. Corresponds to the JSON property maintenanceStatus

Returns:



173
174
175
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 173

def maintenance_status
  @maintenance_status
end

#name ⇒ String

Immutable. The bare metal admin cluster resource name. Corresponds to the JSON property name

Returns:

  • (String) 


178
179
180
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 178

def name
  @name
end

#network_config ⇒ Google::Apis::GkeonpremV1::BareMetalAdminNetworkConfig

BareMetalAdminNetworkConfig specifies the cluster network configuration. Corresponds to the JSON property networkConfig

Returns:



183
184
185
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 183

def network_config
  @network_config
end

#node_access_config ⇒ Google::Apis::GkeonpremV1::BareMetalAdminNodeAccessConfig

Specifies the node access related settings for the bare metal admin cluster. Corresponds to the JSON property nodeAccessConfig

Returns:



188
189
190
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 188

def node_access_config
  @node_access_config
end

#node_config ⇒ Google::Apis::GkeonpremV1::BareMetalAdminWorkloadNodeConfig

BareMetalAdminWorkloadNodeConfig specifies the workload node configurations. Corresponds to the JSON property nodeConfig

Returns:



193
194
195
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 193

def node_config
  @node_config
end

#os_environment_config ⇒ Google::Apis::GkeonpremV1::BareMetalAdminOsEnvironmentConfig

Specifies operating system operation settings for cluster provisioning. Corresponds to the JSON property osEnvironmentConfig

Returns:



198
199
200
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 198

def os_environment_config
  @os_environment_config
end

#proxy ⇒ Google::Apis::GkeonpremV1::BareMetalAdminProxyConfig

BareMetalAdminProxyConfig specifies the cluster proxy configuration. Corresponds to the JSON property proxy

Returns:



203
204
205
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 203

def proxy
  @proxy
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. If set, there are currently changes in flight to the bare metal Admin Cluster. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 


209
210
211
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 209

def reconciling
  @reconciling
end

#security_config ⇒ Google::Apis::GkeonpremV1::BareMetalAdminSecurityConfig

Specifies the security related settings for the bare metal admin cluster. Corresponds to the JSON property securityConfig

Returns:



215
216
217
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 215

def security_config
  @security_config
end

#state ⇒ String

Output only. The current state of the bare metal admin cluster. Corresponds to the JSON property state

Returns:

  • (String) 


220
221
222
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 220

def state
  @state
end

#status ⇒ Google::Apis::GkeonpremV1::ResourceStatus

ResourceStatus describes why a cluster or node pool has a certain status. (e.g. , ERROR or DEGRADED). Corresponds to the JSON property status

Returns:



226
227
228
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 226

def status
  @status
end

#storage ⇒ Google::Apis::GkeonpremV1::BareMetalAdminStorageConfig

BareMetalAdminStorageConfig specifies the cluster storage configuration. Corresponds to the JSON property storage

Returns:



231
232
233
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 231

def storage
  @storage
end

#uid ⇒ String

Output only. The unique identifier of the bare metal admin cluster. Corresponds to the JSON property uid

Returns:

  • (String) 


236
237
238
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 236

def uid
  @uid
end

#update_time ⇒ String

Output only. The time at which this bare metal admin cluster was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


241
242
243
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 241

def update_time
  @update_time
end

#validation_check ⇒ Google::Apis::GkeonpremV1::ValidationCheck

ValidationCheck represents the result of preflight check. Corresponds to the JSON property validationCheck

Returns:



246
247
248
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 246

def validation_check
  @validation_check
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 253

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @bare_metal_version = args[:bare_metal_version] if args.key?(:bare_metal_version)
  @cluster_operations = args[:cluster_operations] if args.key?(:cluster_operations)
  @control_plane = args[:control_plane] if args.key?(:control_plane)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @description = args[:description] if args.key?(:description)
  @endpoint = args[:endpoint] if args.key?(:endpoint)
  @etag = args[:etag] if args.key?(:etag)
  @fleet = args[:fleet] if args.key?(:fleet)
  @load_balancer = args[:load_balancer] if args.key?(:load_balancer)
  @local_name = args[:local_name] if args.key?(:local_name)
  @maintenance_config = args[:maintenance_config] if args.key?(:maintenance_config)
  @maintenance_status = args[:maintenance_status] if args.key?(:maintenance_status)
  @name = args[:name] if args.key?(:name)
  @network_config = args[:network_config] if args.key?(:network_config)
  @node_access_config = args[:node_access_config] if args.key?(:node_access_config)
  @node_config = args[:node_config] if args.key?(:node_config)
  @os_environment_config = args[:os_environment_config] if args.key?(:os_environment_config)
  @proxy = args[:proxy] if args.key?(:proxy)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @security_config = args[:security_config] if args.key?(:security_config)
  @state = args[:state] if args.key?(:state)
  @status = args[:status] if args.key?(:status)
  @storage = args[:storage] if args.key?(:storage)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @validation_check = args[:validation_check] if args.key?(:validation_check)
end