Class: Google::Apis::GkeonpremV1::EnrollVmwareClusterRequest

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 VMware cluster to the Anthos On-Prem API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnrollVmwareClusterRequest

Returns a new instance of EnrollVmwareClusterRequest.



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

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

Instance Attribute Details

#admin_cluster_membership ⇒ String

Required. The admin cluster this VMware 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) 


2286
2287
2288
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2286

def admin_cluster_membership
  @admin_cluster_membership
end

#local_name ⇒ String

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

Returns:

  • (String) 


2296
2297
2298
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2296

def local_name
  @local_name
end

#validate_only ⇒ Boolean Also known as: validate_only?

Validate the request without actually doing any updates. Corresponds to the JSON property validateOnly

Returns:

  • (Boolean) 


2301
2302
2303
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2301

def validate_only
  @validate_only
end

#vmware_cluster_id ⇒ String

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 vmwareClusterId

Returns:

  • (String) 


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

def vmware_cluster_id
  @vmware_cluster_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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