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

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.



2243
2244
2245
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2243

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) 


2223
2224
2225
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2223

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) 


2231
2232
2233
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2231

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) 


2241
2242
2243
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2241

def local_name
  @local_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2248
2249
2250
2251
2252
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2248

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