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

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.

[View source]

2436
2437
2438
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2436

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) 

2410
2411
2412
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2410

def admin_cluster_membership
  @admin_cluster_membership
end

#local_name ⇒ String

Optional. 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) 

2420
2421
2422
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2420

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) 

2425
2426
2427
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2425

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. (https://tools. ietf.org/html/rfc1123) format. Corresponds to the JSON property vmwareClusterId

Returns:

  • (String) 

2434
2435
2436
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2434

def vmware_cluster_id
  @vmware_cluster_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

2441
2442
2443
2444
2445
2446
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 2441

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