Class: Google::Apis::GkeonpremV1::EnrollBareMetalAdminClusterRequest

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 admin cluster to the GKE on-prem API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnrollBareMetalAdminClusterRequest

Returns a new instance of EnrollBareMetalAdminClusterRequest.



2152
2153
2154
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2152

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

Instance Attribute Details

#bare_metal_admin_cluster_idString

User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all GKE on-prem clusters within a project and location and will return a 409 if the cluster already exists. This value must be up to 40 characters and follow RFC-1123 (https://tools.ietf.org/html/ rfc1123) format. Corresponds to the JSON property bareMetalAdminClusterId

Returns:

  • (String)


2134
2135
2136
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2134

def bare_metal_admin_cluster_id
  @bare_metal_admin_cluster_id
end

#local_nameString

The object name of the bare metal OnPremAdminCluster 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_admin_cluster_id. Otherwise, it must match the object name of the bare metal OnPremAdminCluster custom resource. It is not modifiable outside / beyond the enrollment operation. Corresponds to the JSON property localName

Returns:

  • (String)


2144
2145
2146
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2144

def local_name
  @local_name
end

#membershipString

Required. This is the full resource name of this admin cluster's fleet membership. Corresponds to the JSON property membership

Returns:

  • (String)


2150
2151
2152
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2150

def membership
  @membership
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2157
2158
2159
2160
2161
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2157

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