Class ProjectsResource.LocationsResource.BareMetalAdminClustersResource.UnenrollRequest
Unenrolls an existing bare metal admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.
Inheritance
Inherited Members
Namespace: Google.Apis.GKEOnPrem.v1
Assembly: Google.Apis.GKEOnPrem.v1.dll
Syntax
public class ProjectsResource.LocationsResource.BareMetalAdminClustersResource.UnenrollRequest : GKEOnPremBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest
Constructors
UnenrollRequest(IClientService, string)
Constructs a new Unenroll request.
Declaration
public UnenrollRequest(IClientService service, string name)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | name |
Properties
AllowMissing
If set to true, and the bare metal admin cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.
Declaration
[RequestParameter("allowMissing", RequestParameterType.Query)]
public virtual bool? AllowMissing { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Etag
The current etag of the bare metal admin cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.
Declaration
[RequestParameter("etag", RequestParameterType.Query)]
public virtual string Etag { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
IgnoreErrors
If set to true, the unenrollment of a bare metal admin cluster resource will succeed even if errors occur during unenrollment. This parameter can be used when you want to unenroll admin cluster resource and the on-prem admin cluster is disconnected / unreachable. WARNING: Using this parameter when your admin cluster still exists may result in a deleted GCP admin cluster but existing resourcelink in on-prem admin cluster and membership.
Declaration
[RequestParameter("ignoreErrors", RequestParameterType.Query)]
public virtual bool? IgnoreErrors { get; set; }
Property Value
Type | Description |
---|---|
bool? |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Name
Required. Name of the bare metal admin cluster to be unenrolled. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{cluster}"
Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
ValidateOnly
Validate the request without actually doing any updates.
Declaration
[RequestParameter("validateOnly", RequestParameterType.Query)]
public virtual bool? ValidateOnly { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Methods
InitParameters()
Initializes Unenroll parameter list.
Declaration
protected override void InitParameters()