Class: Google::Apis::GkeonpremV1::BareMetalCluster

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

Resource that represents a bare metal user cluster.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BareMetalCluster

Returns a new instance of BareMetalCluster.



1039
1040
1041
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1039

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. Corresponds to the JSON property adminClusterMembership

Returns:

  • (String) 


867
868
869
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 867

def admin_cluster_membership
  @admin_cluster_membership
end

#admin_cluster_name ⇒ String

Output only. The resource name of the bare metal admin cluster managing this user cluster. Corresponds to the JSON property adminClusterName

Returns:

  • (String) 


873
874
875
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 873

def admin_cluster_name
  @admin_cluster_name
end

#annotations ⇒ Hash<String,String>

Annotations on the bare metal user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


883
884
885
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 883

def annotations
  @annotations
end

#bare_metal_version ⇒ String

Required. The Anthos clusters on bare metal version for your user cluster. Corresponds to the JSON property bareMetalVersion

Returns:

  • (String) 


888
889
890
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 888

def bare_metal_version
  @bare_metal_version
end

#cluster_operations ⇒ Google::Apis::GkeonpremV1::BareMetalClusterOperationsConfig

Specifies the bare metal user cluster's observability infrastructure. Corresponds to the JSON property clusterOperations

Returns:



893
894
895
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 893

def cluster_operations
  @cluster_operations
end

#control_plane ⇒ Google::Apis::GkeonpremV1::BareMetalControlPlaneConfig

Specifies the control plane configuration. Corresponds to the JSON property controlPlane

Returns:



898
899
900
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 898

def control_plane
  @control_plane
end

#create_time ⇒ String

Output only. The time when the bare metal user cluster was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


903
904
905
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 903

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty Corresponds to the JSON property deleteTime

Returns:

  • (String) 


909
910
911
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 909

def delete_time
  @delete_time
end

#description ⇒ String

A human readable description of this bare metal user cluster. Corresponds to the JSON property description

Returns:

  • (String) 


914
915
916
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 914

def description
  @description
end

#endpoint ⇒ String

Output only. The IP address of the bare metal user cluster's API server. Corresponds to the JSON property endpoint

Returns:

  • (String) 


919
920
921
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 919

def endpoint
  @endpoint
end

#etag ⇒ String

Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. Corresponds to the JSON property etag

Returns:

  • (String) 


927
928
929
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 927

def etag
  @etag
end

#fleet ⇒ Google::Apis::GkeonpremV1::Fleet

Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See Anthos Fleets for more details on Anthos multi-cluster capabilities using Fleets. ## Corresponds to the JSON property fleet

Returns:



936
937
938
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 936

def fleet
  @fleet
end

#load_balancer ⇒ Google::Apis::GkeonpremV1::BareMetalLoadBalancerConfig

Specifies the load balancer configuration. Corresponds to the JSON property loadBalancer

Returns:



941
942
943
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 941

def load_balancer
  @load_balancer
end

#local_name ⇒ String

Output only. The object name of the bare metal user cluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the name in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl. Corresponds to the JSON property localName

Returns:

  • (String) 


954
955
956
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 954

def local_name
  @local_name
end

#maintenance_config ⇒ Google::Apis::GkeonpremV1::BareMetalMaintenanceConfig

Specifies configurations to put bare metal nodes in and out of maintenance. Corresponds to the JSON property maintenanceConfig

Returns:



959
960
961
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 959

def maintenance_config
  @maintenance_config
end

#maintenance_status ⇒ Google::Apis::GkeonpremV1::BareMetalMaintenanceStatus

Represents the maintenance status of the bare metal user cluster. Corresponds to the JSON property maintenanceStatus

Returns:



964
965
966
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 964

def maintenance_status
  @maintenance_status
end

#name ⇒ String

Immutable. The bare metal user cluster resource name. Corresponds to the JSON property name

Returns:

  • (String) 


969
970
971
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 969

def name
  @name
end

#network_config ⇒ Google::Apis::GkeonpremV1::BareMetalNetworkConfig

Specifies the cluster network configuration. Corresponds to the JSON property networkConfig

Returns:



974
975
976
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 974

def network_config
  @network_config
end

#node_access_config ⇒ Google::Apis::GkeonpremV1::BareMetalNodeAccessConfig

Specifies the node access related settings for the bare metal user cluster. Corresponds to the JSON property nodeAccessConfig

Returns:



979
980
981
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 979

def node_access_config
  @node_access_config
end

#node_config ⇒ Google::Apis::GkeonpremV1::BareMetalWorkloadNodeConfig

Specifies the workload node configurations. Corresponds to the JSON property nodeConfig

Returns:



984
985
986
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 984

def node_config
  @node_config
end

#os_environment_config ⇒ Google::Apis::GkeonpremV1::BareMetalOsEnvironmentConfig

Specifies operating system settings for cluster provisioning. Corresponds to the JSON property osEnvironmentConfig

Returns:



989
990
991
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 989

def os_environment_config
  @os_environment_config
end

#proxy ⇒ Google::Apis::GkeonpremV1::BareMetalProxyConfig

Specifies the cluster proxy configuration. Corresponds to the JSON property proxy

Returns:



994
995
996
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 994

def proxy
  @proxy
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. If set, there are currently changes in flight to the bare metal user cluster. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 


1000
1001
1002
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1000

def reconciling
  @reconciling
end

#security_config ⇒ Google::Apis::GkeonpremV1::BareMetalSecurityConfig

Specifies the security related settings for the bare metal user cluster. Corresponds to the JSON property securityConfig

Returns:



1006
1007
1008
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1006

def security_config
  @security_config
end

#state ⇒ String

Output only. The current state of the bare metal user cluster. Corresponds to the JSON property state

Returns:

  • (String) 


1011
1012
1013
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1011

def state
  @state
end

#status ⇒ Google::Apis::GkeonpremV1::ResourceStatus

ResourceStatus describes why a cluster or node pool has a certain status. (e.g. , ERROR or DEGRADED). Corresponds to the JSON property status

Returns:



1017
1018
1019
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1017

def status
  @status
end

#storage ⇒ Google::Apis::GkeonpremV1::BareMetalStorageConfig

BareMetalStorageConfig specifies the cluster storage configuration. Corresponds to the JSON property storage

Returns:



1022
1023
1024
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1022

def storage
  @storage
end

#uid ⇒ String

Output only. The unique identifier of the bare metal user cluster. Corresponds to the JSON property uid

Returns:

  • (String) 


1027
1028
1029
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1027

def uid
  @uid
end

#update_time ⇒ String

Output only. The time when the bare metal user cluster was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1032
1033
1034
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1032

def update_time
  @update_time
end

#validation_check ⇒ Google::Apis::GkeonpremV1::ValidationCheck

ValidationCheck represents the result of preflight check. Corresponds to the JSON property validationCheck

Returns:



1037
1038
1039
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1037

def validation_check
  @validation_check
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
 
# File 'lib/google/apis/gkeonprem_v1/classes.rb', line 1044

def update!(**args)
  @admin_cluster_membership = args[:admin_cluster_membership] if args.key?(:admin_cluster_membership)
  @admin_cluster_name = args[:admin_cluster_name] if args.key?(:admin_cluster_name)
  @annotations = args[:annotations] if args.key?(:annotations)
  @bare_metal_version = args[:bare_metal_version] if args.key?(:bare_metal_version)
  @cluster_operations = args[:cluster_operations] if args.key?(:cluster_operations)
  @control_plane = args[:control_plane] if args.key?(:control_plane)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @description = args[:description] if args.key?(:description)
  @endpoint = args[:endpoint] if args.key?(:endpoint)
  @etag = args[:etag] if args.key?(:etag)
  @fleet = args[:fleet] if args.key?(:fleet)
  @load_balancer = args[:load_balancer] if args.key?(:load_balancer)
  @local_name = args[:local_name] if args.key?(:local_name)
  @maintenance_config = args[:maintenance_config] if args.key?(:maintenance_config)
  @maintenance_status = args[:maintenance_status] if args.key?(:maintenance_status)
  @name = args[:name] if args.key?(:name)
  @network_config = args[:network_config] if args.key?(:network_config)
  @node_access_config = args[:node_access_config] if args.key?(:node_access_config)
  @node_config = args[:node_config] if args.key?(:node_config)
  @os_environment_config = args[:os_environment_config] if args.key?(:os_environment_config)
  @proxy = args[:proxy] if args.key?(:proxy)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @security_config = args[:security_config] if args.key?(:security_config)
  @state = args[:state] if args.key?(:state)
  @status = args[:status] if args.key?(:status)
  @storage = args[:storage] if args.key?(:storage)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @validation_check = args[:validation_check] if args.key?(:validation_check)
end