Class: Google::Apis::GkeonpremV1::EnrollBareMetalClusterRequest

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 more...

Overview

Message for enrolling an existing bare metal cluster to the Anthos On-Prem API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnrollBareMetalClusterRequest

Returns a new instance of EnrollBareMetalClusterRequest.

[View source]

2332
2333
2334
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2332

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

Instance Attribute Details

#admin_cluster_membership ⇒ String

Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources. Corresponds to the JSON property adminClusterMembership

Returns:

  • (String) 

2312
2313
2314
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2312

def admin_cluster_membership
  @admin_cluster_membership
end

#bare_metal_cluster_id ⇒ String

User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all bare metal clusters within a project and location and will return a 409 if the cluster already exists. (https://tools. ietf.org/html/rfc1123) format. Corresponds to the JSON property bareMetalClusterId

Returns:

  • (String) 

2320
2321
2322
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2320

def bare_metal_cluster_id
  @bare_metal_cluster_id
end

#local_name ⇒ String

Optional. The object name of the bare metal cluster custom resource on the associated admin cluster. This field is used to support conflicting resource names when enrolling existing clusters to the API. When not provided, this field will resolve to the bare_metal_cluster_id. Otherwise, it must match the object name of the bare metal cluster custom resource. It is not modifiable outside / beyond the enrollment operation. Corresponds to the JSON property localName

Returns:

  • (String) 

2330
2331
2332
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2330

def local_name
  @local_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

2337
2338
2339
2340
2341
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2337

def update!(**args)
  @admin_cluster_membership = args[:admin_cluster_membership] if args.key?(:admin_cluster_membership)
  @bare_metal_cluster_id = args[:bare_metal_cluster_id] if args.key?(:bare_metal_cluster_id)
  @local_name = args[:local_name] if args.key?(:local_name)
end