Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.ClustersResource

The "clusters" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.ClustersResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Container.v1
Assembly: Google.Apis.Container.v1.dll
Syntax
public class ProjectsResource.LocationsResource.ClustersResource

Constructors

ClustersResource(IClientService)

Constructs a new resource.

Declaration
public ClustersResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

NodePools

Gets the NodePools resource.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.NodePoolsResource NodePools { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.ClustersResource.NodePoolsResource

WellKnown

Gets the WellKnown resource.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.WellKnownResource WellKnown { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.ClustersResource.WellKnownResource

Methods

CheckAutopilotCompatibility(string)

Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.CheckAutopilotCompatibilityRequest CheckAutopilotCompatibility(string name)
Parameters
Type Name Description
string name

The name (project, location, cluster) of the cluster to retrieve. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.CheckAutopilotCompatibilityRequest

CompleteIpRotation(CompleteIPRotationRequest, string)

Completes master IP rotation.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.CompleteIpRotationRequest CompleteIpRotation(CompleteIPRotationRequest body, string name)
Parameters
Type Name Description
CompleteIPRotationRequest body

The body of the request.

string name

The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.CompleteIpRotationRequest

Create(CreateClusterRequest, string)

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's default network. One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.CreateRequest Create(CreateClusterRequest body, string parent)
Parameters
Type Name Description
CreateClusterRequest body

The body of the request.

string parent

The parent (project and location) where the cluster will be created. Specified in the format projects/*/locations/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.CreateRequest

Delete(string)

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

The name (project, location, cluster) of the cluster to delete. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.DeleteRequest

FetchClusterUpgradeInfo(string)

Fetch upgrade information of a specific cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.FetchClusterUpgradeInfoRequest FetchClusterUpgradeInfo(string name)
Parameters
Type Name Description
string name

Required. The name (project, location, cluster) of the cluster to get. Specified in the format projects/*/locations/*/clusters/* or projects/*/zones/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.FetchClusterUpgradeInfoRequest

Get(string)

Gets the details of a specific cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

The name (project, location, cluster) of the cluster to retrieve. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.GetRequest

GetJwks(string)

Gets the public component of the cluster signing keys in JSON Web Key format.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.GetJwksRequest GetJwks(string parent)
Parameters
Type Name Description
string parent

The cluster (project, location, cluster name) to get keys for. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.GetJwksRequest

List(string)

Lists all clusters owned by a project in either the specified zone or all zones.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

The parent (project and location) where the clusters will be listed. Specified in the format projects/*/locations/*. Location "-" matches all zones and all regions.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.ListRequest

SetAddons(SetAddonsConfigRequest, string)

Sets the addons for a specific cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.SetAddonsRequest SetAddons(SetAddonsConfigRequest body, string name)
Parameters
Type Name Description
SetAddonsConfigRequest body

The body of the request.

string name

The name (project, location, cluster) of the cluster to set addons. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.SetAddonsRequest

SetLegacyAbac(SetLegacyAbacRequest, string)

Enables or disables the ABAC authorization mechanism on a cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.SetLegacyAbacRequest SetLegacyAbac(SetLegacyAbacRequest body, string name)
Parameters
Type Name Description
SetLegacyAbacRequest body

The body of the request.

string name

The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.SetLegacyAbacRequest

SetLocations(SetLocationsRequest, string)

Sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.SetLocationsRequest SetLocations(SetLocationsRequest body, string name)
Parameters
Type Name Description
SetLocationsRequest body

The body of the request.

string name

The name (project, location, cluster) of the cluster to set locations. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.SetLocationsRequest

SetLogging(SetLoggingServiceRequest, string)

Sets the logging service for a specific cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.SetLoggingRequest SetLogging(SetLoggingServiceRequest body, string name)
Parameters
Type Name Description
SetLoggingServiceRequest body

The body of the request.

string name

The name (project, location, cluster) of the cluster to set logging. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.SetLoggingRequest

SetMaintenancePolicy(SetMaintenancePolicyRequest, string)

Sets the maintenance policy for a cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.SetMaintenancePolicyRequest SetMaintenancePolicy(SetMaintenancePolicyRequest body, string name)
Parameters
Type Name Description
SetMaintenancePolicyRequest body

The body of the request.

string name

The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.SetMaintenancePolicyRequest

SetMasterAuth(SetMasterAuthRequest, string)

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.SetMasterAuthRequest SetMasterAuth(SetMasterAuthRequest body, string name)
Parameters
Type Name Description
SetMasterAuthRequest body

The body of the request.

string name

The name (project, location, cluster) of the cluster to set auth. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.SetMasterAuthRequest

SetMonitoring(SetMonitoringServiceRequest, string)

Sets the monitoring service for a specific cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.SetMonitoringRequest SetMonitoring(SetMonitoringServiceRequest body, string name)
Parameters
Type Name Description
SetMonitoringServiceRequest body

The body of the request.

string name

The name (project, location, cluster) of the cluster to set monitoring. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.SetMonitoringRequest

SetNetworkPolicy(SetNetworkPolicyRequest, string)

Enables or disables Network Policy for a cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.SetNetworkPolicyRequest SetNetworkPolicy(SetNetworkPolicyRequest body, string name)
Parameters
Type Name Description
SetNetworkPolicyRequest body

The body of the request.

string name

The name (project, location, cluster name) of the cluster to set networking policy. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.SetNetworkPolicyRequest

SetResourceLabels(SetLabelsRequest, string)

Sets labels on a cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.SetResourceLabelsRequest SetResourceLabels(SetLabelsRequest body, string name)
Parameters
Type Name Description
SetLabelsRequest body

The body of the request.

string name

The name (project, location, cluster name) of the cluster to set labels. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.SetResourceLabelsRequest

StartIpRotation(StartIPRotationRequest, string)

Starts master IP rotation.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.StartIpRotationRequest StartIpRotation(StartIPRotationRequest body, string name)
Parameters
Type Name Description
StartIPRotationRequest body

The body of the request.

string name

The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.StartIpRotationRequest

Update(UpdateClusterRequest, string)

Updates the settings of a specific cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.UpdateRequest Update(UpdateClusterRequest body, string name)
Parameters
Type Name Description
UpdateClusterRequest body

The body of the request.

string name

The name (project, location, cluster) of the cluster to update. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.UpdateRequest

UpdateMaster(UpdateMasterRequest, string)

Updates the master for a specific cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.UpdateMasterRequest UpdateMaster(UpdateMasterRequest body, string name)
Parameters
Type Name Description
UpdateMasterRequest body

The body of the request.

string name

The name (project, location, cluster) of the cluster to update. Specified in the format projects/*/locations/*/clusters/*.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.UpdateMasterRequest
In this article
Back to top Generated by DocFX