Show / Hide Table of Contents

Class BareMetalCluster

Resource that represents a bare metal user cluster.

Inheritance
object
BareMetalCluster
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.GKEOnPrem.v1.Data
Assembly: Google.Apis.GKEOnPrem.v1.dll
Syntax
public class BareMetalCluster : IDirectResponseSchema

Properties

AdminClusterMembership

Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership.

Declaration
[JsonProperty("adminClusterMembership")]
public virtual string AdminClusterMembership { get; set; }
Property Value
Type Description
string

AdminClusterName

Output only. The resource name of the bare metal admin cluster managing this user cluster.

Declaration
[JsonProperty("adminClusterName")]
public virtual string AdminClusterName { get; set; }
Property Value
Type Description
string

Annotations

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.

Declaration
[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }
Property Value
Type Description
IDictionary<string, string>

BareMetalVersion

Required. The Anthos clusters on bare metal version for your user cluster.

Declaration
[JsonProperty("bareMetalVersion")]
public virtual string BareMetalVersion { get; set; }
Property Value
Type Description
string

BinaryAuthorization

Binary Authorization related configurations.

Declaration
[JsonProperty("binaryAuthorization")]
public virtual BinaryAuthorization BinaryAuthorization { get; set; }
Property Value
Type Description
BinaryAuthorization

ClusterOperations

Cluster operations configuration.

Declaration
[JsonProperty("clusterOperations")]
public virtual BareMetalClusterOperationsConfig ClusterOperations { get; set; }
Property Value
Type Description
BareMetalClusterOperationsConfig

ControlPlane

Required. Control plane configuration.

Declaration
[JsonProperty("controlPlane")]
public virtual BareMetalControlPlaneConfig ControlPlane { get; set; }
Property Value
Type Description
BareMetalControlPlaneConfig

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The time when the bare metal user cluster was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DeleteTime

object representation of DeleteTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeleteTimeDateTimeOffset instead.")]
public virtual object DeleteTime { get; set; }
Property Value
Type Description
object

DeleteTimeDateTimeOffset

DateTimeOffset representation of DeleteTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? DeleteTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

DeleteTimeRaw

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

Declaration
[JsonProperty("deleteTime")]
public virtual string DeleteTimeRaw { get; set; }
Property Value
Type Description
string

Description

A human readable description of this bare metal user cluster.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

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.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

Endpoint

Output only. The IP address of the bare metal user cluster's API server.

Declaration
[JsonProperty("endpoint")]
public virtual string Endpoint { get; set; }
Property Value
Type Description
string

Fleet

Output only. Fleet configuration for the cluster.

Declaration
[JsonProperty("fleet")]
public virtual Fleet Fleet { get; set; }
Property Value
Type Description
Fleet

LoadBalancer

Required. Load balancer configuration.

Declaration
[JsonProperty("loadBalancer")]
public virtual BareMetalLoadBalancerConfig LoadBalancer { get; set; }
Property Value
Type Description
BareMetalLoadBalancerConfig

LocalName

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.

Declaration
[JsonProperty("localName")]
public virtual string LocalName { get; set; }
Property Value
Type Description
string

LocalNamespace

Output only. The namespace of the cluster.

Declaration
[JsonProperty("localNamespace")]
public virtual string LocalNamespace { get; set; }
Property Value
Type Description
string

MaintenanceConfig

Maintenance configuration.

Declaration
[JsonProperty("maintenanceConfig")]
public virtual BareMetalMaintenanceConfig MaintenanceConfig { get; set; }
Property Value
Type Description
BareMetalMaintenanceConfig

MaintenanceStatus

Output only. Status of on-going maintenance tasks.

Declaration
[JsonProperty("maintenanceStatus")]
public virtual BareMetalMaintenanceStatus MaintenanceStatus { get; set; }
Property Value
Type Description
BareMetalMaintenanceStatus

Name

Immutable. The bare metal user cluster resource name.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NetworkConfig

Required. Network configuration.

Declaration
[JsonProperty("networkConfig")]
public virtual BareMetalNetworkConfig NetworkConfig { get; set; }
Property Value
Type Description
BareMetalNetworkConfig

NodeAccessConfig

Node access related configurations.

Declaration
[JsonProperty("nodeAccessConfig")]
public virtual BareMetalNodeAccessConfig NodeAccessConfig { get; set; }
Property Value
Type Description
BareMetalNodeAccessConfig

NodeConfig

Workload node configuration.

Declaration
[JsonProperty("nodeConfig")]
public virtual BareMetalWorkloadNodeConfig NodeConfig { get; set; }
Property Value
Type Description
BareMetalWorkloadNodeConfig

OsEnvironmentConfig

OS environment related configurations.

Declaration
[JsonProperty("osEnvironmentConfig")]
public virtual BareMetalOsEnvironmentConfig OsEnvironmentConfig { get; set; }
Property Value
Type Description
BareMetalOsEnvironmentConfig

Proxy

Proxy configuration.

Declaration
[JsonProperty("proxy")]
public virtual BareMetalProxyConfig Proxy { get; set; }
Property Value
Type Description
BareMetalProxyConfig

Reconciling

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

Declaration
[JsonProperty("reconciling")]
public virtual bool? Reconciling { get; set; }
Property Value
Type Description
bool?

SecurityConfig

Security related setting configuration.

Declaration
[JsonProperty("securityConfig")]
public virtual BareMetalSecurityConfig SecurityConfig { get; set; }
Property Value
Type Description
BareMetalSecurityConfig

State

Output only. The current state of the bare metal user cluster.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Status

Output only. Detailed cluster status.

Declaration
[JsonProperty("status")]
public virtual ResourceStatus Status { get; set; }
Property Value
Type Description
ResourceStatus

Storage

Required. Storage configuration.

Declaration
[JsonProperty("storage")]
public virtual BareMetalStorageConfig Storage { get; set; }
Property Value
Type Description
BareMetalStorageConfig

Uid

Output only. The unique identifier of the bare metal user cluster.

Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. The time when the bare metal user cluster was last updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

UpgradePolicy

The cluster upgrade policy.

Declaration
[JsonProperty("upgradePolicy")]
public virtual BareMetalClusterUpgradePolicy UpgradePolicy { get; set; }
Property Value
Type Description
BareMetalClusterUpgradePolicy

ValidationCheck

Output only. The result of the preflight check.

Declaration
[JsonProperty("validationCheck")]
public virtual ValidationCheck ValidationCheck { get; set; }
Property Value
Type Description
ValidationCheck

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX