package container
import "cloud.google.com/go/container/apiv1"
Package container is an auto-generated package for the Kubernetes Engine API.
Builds and manages container-based applications, powered by the open source Kubernetes technology.
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/container/apiv1@latest ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := container.NewClusterManagerClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client, mentioned above.
req := &containerpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. }
Use of Context
The ctx passed to NewClusterManagerClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Index ¶
- func DefaultAuthScopes() []string
- type ClusterManagerCallOptions
- type ClusterManagerClient
- func NewClusterManagerClient(ctx context.Context, opts ...option.ClientOption) (*ClusterManagerClient, error)
- func NewClusterManagerRESTClient(ctx context.Context, opts ...option.ClientOption) (*ClusterManagerClient, error)
- func (c *ClusterManagerClient) CancelOperation(ctx context.Context, req *containerpb.CancelOperationRequest, opts ...gax.CallOption) error
- func (c *ClusterManagerClient) CheckAutopilotCompatibility(ctx context.Context, req *containerpb.CheckAutopilotCompatibilityRequest, opts ...gax.CallOption) (*containerpb.CheckAutopilotCompatibilityResponse, error)
- func (c *ClusterManagerClient) Close() error
- func (c *ClusterManagerClient) CompleteIPRotation(ctx context.Context, req *containerpb.CompleteIPRotationRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) CompleteNodePoolUpgrade(ctx context.Context, req *containerpb.CompleteNodePoolUpgradeRequest, opts ...gax.CallOption) error
- func (c *ClusterManagerClient) Connection() *grpc.ClientConn
- func (c *ClusterManagerClient) CreateCluster(ctx context.Context, req *containerpb.CreateClusterRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) CreateNodePool(ctx context.Context, req *containerpb.CreateNodePoolRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) DeleteCluster(ctx context.Context, req *containerpb.DeleteClusterRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) DeleteNodePool(ctx context.Context, req *containerpb.DeleteNodePoolRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) GetCluster(ctx context.Context, req *containerpb.GetClusterRequest, opts ...gax.CallOption) (*containerpb.Cluster, error)
- func (c *ClusterManagerClient) GetJSONWebKeys(ctx context.Context, req *containerpb.GetJSONWebKeysRequest, opts ...gax.CallOption) (*containerpb.GetJSONWebKeysResponse, error)
- func (c *ClusterManagerClient) GetNodePool(ctx context.Context, req *containerpb.GetNodePoolRequest, opts ...gax.CallOption) (*containerpb.NodePool, error)
- func (c *ClusterManagerClient) GetOperation(ctx context.Context, req *containerpb.GetOperationRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) GetServerConfig(ctx context.Context, req *containerpb.GetServerConfigRequest, opts ...gax.CallOption) (*containerpb.ServerConfig, error)
- func (c *ClusterManagerClient) ListClusters(ctx context.Context, req *containerpb.ListClustersRequest, opts ...gax.CallOption) (*containerpb.ListClustersResponse, error)
- func (c *ClusterManagerClient) ListNodePools(ctx context.Context, req *containerpb.ListNodePoolsRequest, opts ...gax.CallOption) (*containerpb.ListNodePoolsResponse, error)
- func (c *ClusterManagerClient) ListOperations(ctx context.Context, req *containerpb.ListOperationsRequest, opts ...gax.CallOption) (*containerpb.ListOperationsResponse, error)
- func (c *ClusterManagerClient) ListUsableSubnetworks(ctx context.Context, req *containerpb.ListUsableSubnetworksRequest, opts ...gax.CallOption) *UsableSubnetworkIterator
- func (c *ClusterManagerClient) RollbackNodePoolUpgrade(ctx context.Context, req *containerpb.RollbackNodePoolUpgradeRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetAddonsConfig(ctx context.Context, req *containerpb.SetAddonsConfigRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetLabels(ctx context.Context, req *containerpb.SetLabelsRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetLegacyAbac(ctx context.Context, req *containerpb.SetLegacyAbacRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetLocations(ctx context.Context, req *containerpb.SetLocationsRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetLoggingService(ctx context.Context, req *containerpb.SetLoggingServiceRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetMaintenancePolicy(ctx context.Context, req *containerpb.SetMaintenancePolicyRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetMasterAuth(ctx context.Context, req *containerpb.SetMasterAuthRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetMonitoringService(ctx context.Context, req *containerpb.SetMonitoringServiceRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetNetworkPolicy(ctx context.Context, req *containerpb.SetNetworkPolicyRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetNodePoolAutoscaling(ctx context.Context, req *containerpb.SetNodePoolAutoscalingRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetNodePoolManagement(ctx context.Context, req *containerpb.SetNodePoolManagementRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) SetNodePoolSize(ctx context.Context, req *containerpb.SetNodePoolSizeRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) StartIPRotation(ctx context.Context, req *containerpb.StartIPRotationRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) UpdateCluster(ctx context.Context, req *containerpb.UpdateClusterRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) UpdateMaster(ctx context.Context, req *containerpb.UpdateMasterRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- func (c *ClusterManagerClient) UpdateNodePool(ctx context.Context, req *containerpb.UpdateNodePoolRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
- type UsableSubnetworkIterator
Examples ¶
- ClusterManagerClient.CancelOperation
- ClusterManagerClient.CheckAutopilotCompatibility
- ClusterManagerClient.CompleteIPRotation
- ClusterManagerClient.CompleteNodePoolUpgrade
- ClusterManagerClient.CreateCluster
- ClusterManagerClient.CreateNodePool
- ClusterManagerClient.DeleteCluster
- ClusterManagerClient.DeleteNodePool
- ClusterManagerClient.GetCluster
- ClusterManagerClient.GetJSONWebKeys
- ClusterManagerClient.GetNodePool
- ClusterManagerClient.GetOperation
- ClusterManagerClient.GetServerConfig
- ClusterManagerClient.ListClusters
- ClusterManagerClient.ListNodePools
- ClusterManagerClient.ListOperations
- ClusterManagerClient.ListUsableSubnetworks
- ClusterManagerClient.ListUsableSubnetworks (All)
- ClusterManagerClient.RollbackNodePoolUpgrade
- ClusterManagerClient.SetAddonsConfig
- ClusterManagerClient.SetLabels
- ClusterManagerClient.SetLegacyAbac
- ClusterManagerClient.SetLocations
- ClusterManagerClient.SetLoggingService
- ClusterManagerClient.SetMaintenancePolicy
- ClusterManagerClient.SetMasterAuth
- ClusterManagerClient.SetMonitoringService
- ClusterManagerClient.SetNetworkPolicy
- ClusterManagerClient.SetNodePoolAutoscaling
- ClusterManagerClient.SetNodePoolManagement
- ClusterManagerClient.SetNodePoolSize
- ClusterManagerClient.StartIPRotation
- ClusterManagerClient.UpdateCluster
- ClusterManagerClient.UpdateMaster
- ClusterManagerClient.UpdateNodePool
- NewClusterManagerClient
- NewClusterManagerRESTClient
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type ClusterManagerCallOptions ¶
type ClusterManagerCallOptions struct { ListClusters []gax.CallOption GetCluster []gax.CallOption CreateCluster []gax.CallOption UpdateCluster []gax.CallOption UpdateNodePool []gax.CallOption SetNodePoolAutoscaling []gax.CallOption SetLoggingService []gax.CallOption SetMonitoringService []gax.CallOption SetAddonsConfig []gax.CallOption SetLocations []gax.CallOption UpdateMaster []gax.CallOption SetMasterAuth []gax.CallOption DeleteCluster []gax.CallOption ListOperations []gax.CallOption GetOperation []gax.CallOption CancelOperation []gax.CallOption GetServerConfig []gax.CallOption GetJSONWebKeys []gax.CallOption ListNodePools []gax.CallOption GetNodePool []gax.CallOption CreateNodePool []gax.CallOption DeleteNodePool []gax.CallOption CompleteNodePoolUpgrade []gax.CallOption RollbackNodePoolUpgrade []gax.CallOption SetNodePoolManagement []gax.CallOption SetLabels []gax.CallOption SetLegacyAbac []gax.CallOption StartIPRotation []gax.CallOption CompleteIPRotation []gax.CallOption SetNodePoolSize []gax.CallOption SetNetworkPolicy []gax.CallOption SetMaintenancePolicy []gax.CallOption ListUsableSubnetworks []gax.CallOption CheckAutopilotCompatibility []gax.CallOption }
ClusterManagerCallOptions contains the retry settings for each method of ClusterManagerClient.
type ClusterManagerClient ¶
type ClusterManagerClient struct { // The call options for this service. CallOptions *ClusterManagerCallOptions // contains filtered or unexported fields }
ClusterManagerClient is a client for interacting with Kubernetes Engine API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Google Kubernetes Engine Cluster Manager v1
func NewClusterManagerClient ¶
func NewClusterManagerClient(ctx context.Context, opts ...option.ClientOption) (*ClusterManagerClient, error)
NewClusterManagerClient creates a new cluster manager client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Google Kubernetes Engine Cluster Manager v1
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewClusterManagerRESTClient ¶
func NewClusterManagerRESTClient(ctx context.Context, opts ...option.ClientOption) (*ClusterManagerClient, error)
NewClusterManagerRESTClient creates a new cluster manager rest client.
Google Kubernetes Engine Cluster Manager v1
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*ClusterManagerClient) CancelOperation ¶
func (c *ClusterManagerClient) CancelOperation(ctx context.Context, req *containerpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation cancels the specified operation.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.CancelOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#CancelOperationRequest.
}
err = c.CancelOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*ClusterManagerClient) CheckAutopilotCompatibility ¶
func (c *ClusterManagerClient) CheckAutopilotCompatibility(ctx context.Context, req *containerpb.CheckAutopilotCompatibilityRequest, opts ...gax.CallOption) (*containerpb.CheckAutopilotCompatibilityResponse, error)
CheckAutopilotCompatibility checks the cluster compatibility with Autopilot mode, and returns a list of
compatibility issues.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.CheckAutopilotCompatibilityRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#CheckAutopilotCompatibilityRequest.
}
resp, err := c.CheckAutopilotCompatibility(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) Close ¶
func (c *ClusterManagerClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*ClusterManagerClient) CompleteIPRotation ¶
func (c *ClusterManagerClient) CompleteIPRotation(ctx context.Context, req *containerpb.CompleteIPRotationRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
CompleteIPRotation completes master IP rotation.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.CompleteIPRotationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#CompleteIPRotationRequest.
}
resp, err := c.CompleteIPRotation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) CompleteNodePoolUpgrade ¶
func (c *ClusterManagerClient) CompleteNodePoolUpgrade(ctx context.Context, req *containerpb.CompleteNodePoolUpgradeRequest, opts ...gax.CallOption) error
CompleteNodePoolUpgrade completeNodePoolUpgrade will signal an on-going node pool upgrade to
complete.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.CompleteNodePoolUpgradeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#CompleteNodePoolUpgradeRequest.
}
err = c.CompleteNodePoolUpgrade(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*ClusterManagerClient) Connection ¶
func (c *ClusterManagerClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*ClusterManagerClient) CreateCluster ¶
func (c *ClusterManagerClient) CreateCluster(ctx context.Context, req *containerpb.CreateClusterRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
CreateCluster 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 (at https://cloud.google.com/compute/docs/networks-and-firewalls#networks).
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.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.CreateClusterRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#CreateClusterRequest.
}
resp, err := c.CreateCluster(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) CreateNodePool ¶
func (c *ClusterManagerClient) CreateNodePool(ctx context.Context, req *containerpb.CreateNodePoolRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
CreateNodePool creates a node pool for a cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.CreateNodePoolRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#CreateNodePoolRequest.
}
resp, err := c.CreateNodePool(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) DeleteCluster ¶
func (c *ClusterManagerClient) DeleteCluster(ctx context.Context, req *containerpb.DeleteClusterRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
DeleteCluster 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.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.DeleteClusterRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#DeleteClusterRequest.
}
resp, err := c.DeleteCluster(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) DeleteNodePool ¶
func (c *ClusterManagerClient) DeleteNodePool(ctx context.Context, req *containerpb.DeleteNodePoolRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
DeleteNodePool deletes a node pool from a cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.DeleteNodePoolRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#DeleteNodePoolRequest.
}
resp, err := c.DeleteNodePool(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) GetCluster ¶
func (c *ClusterManagerClient) GetCluster(ctx context.Context, req *containerpb.GetClusterRequest, opts ...gax.CallOption) (*containerpb.Cluster, error)
GetCluster gets the details of a specific cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.GetClusterRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#GetClusterRequest.
}
resp, err := c.GetCluster(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) GetJSONWebKeys ¶
func (c *ClusterManagerClient) GetJSONWebKeys(ctx context.Context, req *containerpb.GetJSONWebKeysRequest, opts ...gax.CallOption) (*containerpb.GetJSONWebKeysResponse, error)
GetJSONWebKeys gets the public component of the cluster signing keys in
JSON Web Key format.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.GetJSONWebKeysRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#GetJSONWebKeysRequest.
}
resp, err := c.GetJSONWebKeys(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) GetNodePool ¶
func (c *ClusterManagerClient) GetNodePool(ctx context.Context, req *containerpb.GetNodePoolRequest, opts ...gax.CallOption) (*containerpb.NodePool, error)
GetNodePool retrieves the requested node pool.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.GetNodePoolRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#GetNodePoolRequest.
}
resp, err := c.GetNodePool(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) GetOperation ¶
func (c *ClusterManagerClient) GetOperation(ctx context.Context, req *containerpb.GetOperationRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
GetOperation gets the specified operation.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.GetOperationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#GetOperationRequest.
}
resp, err := c.GetOperation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) GetServerConfig ¶
func (c *ClusterManagerClient) GetServerConfig(ctx context.Context, req *containerpb.GetServerConfigRequest, opts ...gax.CallOption) (*containerpb.ServerConfig, error)
GetServerConfig returns configuration info about the Google Kubernetes Engine service.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.GetServerConfigRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#GetServerConfigRequest.
}
resp, err := c.GetServerConfig(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) ListClusters ¶
func (c *ClusterManagerClient) ListClusters(ctx context.Context, req *containerpb.ListClustersRequest, opts ...gax.CallOption) (*containerpb.ListClustersResponse, error)
ListClusters lists all clusters owned by a project in either the specified zone or all
zones.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.ListClustersRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#ListClustersRequest.
}
resp, err := c.ListClusters(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) ListNodePools ¶
func (c *ClusterManagerClient) ListNodePools(ctx context.Context, req *containerpb.ListNodePoolsRequest, opts ...gax.CallOption) (*containerpb.ListNodePoolsResponse, error)
ListNodePools lists the node pools for a cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.ListNodePoolsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#ListNodePoolsRequest.
}
resp, err := c.ListNodePools(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) ListOperations ¶
func (c *ClusterManagerClient) ListOperations(ctx context.Context, req *containerpb.ListOperationsRequest, opts ...gax.CallOption) (*containerpb.ListOperationsResponse, error)
ListOperations lists all operations in a project in a specific zone or all zones.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.ListOperationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#ListOperationsRequest.
}
resp, err := c.ListOperations(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) ListUsableSubnetworks ¶
func (c *ClusterManagerClient) ListUsableSubnetworks(ctx context.Context, req *containerpb.ListUsableSubnetworksRequest, opts ...gax.CallOption) *UsableSubnetworkIterator
ListUsableSubnetworks lists subnetworks that are usable for creating clusters in a project.
Code:play
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.ListUsableSubnetworksRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#ListUsableSubnetworksRequest.
}
it := c.ListUsableSubnetworks(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*containerpb.ListUsableSubnetworksResponse)
}
}
Example (All)¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.ListUsableSubnetworksRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#ListUsableSubnetworksRequest.
}
for resp, err := range c.ListUsableSubnetworks(ctx, req).All() {
if err != nil {
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ClusterManagerClient) RollbackNodePoolUpgrade ¶
func (c *ClusterManagerClient) RollbackNodePoolUpgrade(ctx context.Context, req *containerpb.RollbackNodePoolUpgradeRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
RollbackNodePoolUpgrade rolls back a previously Aborted or Failed NodePool upgrade.
This makes no changes if the last upgrade successfully completed.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.RollbackNodePoolUpgradeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#RollbackNodePoolUpgradeRequest.
}
resp, err := c.RollbackNodePoolUpgrade(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetAddonsConfig ¶
func (c *ClusterManagerClient) SetAddonsConfig(ctx context.Context, req *containerpb.SetAddonsConfigRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetAddonsConfig sets the addons for a specific cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetAddonsConfigRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetAddonsConfigRequest.
}
resp, err := c.SetAddonsConfig(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetLabels ¶
func (c *ClusterManagerClient) SetLabels(ctx context.Context, req *containerpb.SetLabelsRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetLabels sets labels on a cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetLabelsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetLabelsRequest.
}
resp, err := c.SetLabels(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetLegacyAbac ¶
func (c *ClusterManagerClient) SetLegacyAbac(ctx context.Context, req *containerpb.SetLegacyAbacRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetLegacyAbac enables or disables the ABAC authorization mechanism on a cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetLegacyAbacRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetLegacyAbacRequest.
}
resp, err := c.SetLegacyAbac(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetLocations ¶
func (c *ClusterManagerClient) SetLocations(ctx context.Context, req *containerpb.SetLocationsRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetLocations sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update (at https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
Deprecated: SetLocations may be removed in a future version.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetLocationsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetLocationsRequest.
}
resp, err := c.SetLocations(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetLoggingService ¶
func (c *ClusterManagerClient) SetLoggingService(ctx context.Context, req *containerpb.SetLoggingServiceRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetLoggingService sets the logging service for a specific cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetLoggingServiceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetLoggingServiceRequest.
}
resp, err := c.SetLoggingService(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetMaintenancePolicy ¶
func (c *ClusterManagerClient) SetMaintenancePolicy(ctx context.Context, req *containerpb.SetMaintenancePolicyRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetMaintenancePolicy sets the maintenance policy for a cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetMaintenancePolicyRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetMaintenancePolicyRequest.
}
resp, err := c.SetMaintenancePolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetMasterAuth ¶
func (c *ClusterManagerClient) SetMasterAuth(ctx context.Context, req *containerpb.SetMasterAuthRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetMasterAuth sets master auth materials. Currently supports changing the admin password
or a specific cluster, either via password generation or explicitly setting
the password.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetMasterAuthRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetMasterAuthRequest.
}
resp, err := c.SetMasterAuth(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetMonitoringService ¶
func (c *ClusterManagerClient) SetMonitoringService(ctx context.Context, req *containerpb.SetMonitoringServiceRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetMonitoringService sets the monitoring service for a specific cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetMonitoringServiceRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetMonitoringServiceRequest.
}
resp, err := c.SetMonitoringService(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetNetworkPolicy ¶
func (c *ClusterManagerClient) SetNetworkPolicy(ctx context.Context, req *containerpb.SetNetworkPolicyRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetNetworkPolicy enables or disables Network Policy for a cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetNetworkPolicyRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetNetworkPolicyRequest.
}
resp, err := c.SetNetworkPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetNodePoolAutoscaling ¶
func (c *ClusterManagerClient) SetNodePoolAutoscaling(ctx context.Context, req *containerpb.SetNodePoolAutoscalingRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetNodePoolAutoscaling sets the autoscaling settings for the specified node pool.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetNodePoolAutoscalingRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetNodePoolAutoscalingRequest.
}
resp, err := c.SetNodePoolAutoscaling(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetNodePoolManagement ¶
func (c *ClusterManagerClient) SetNodePoolManagement(ctx context.Context, req *containerpb.SetNodePoolManagementRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetNodePoolManagement sets the NodeManagement options for a node pool.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetNodePoolManagementRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetNodePoolManagementRequest.
}
resp, err := c.SetNodePoolManagement(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) SetNodePoolSize ¶
func (c *ClusterManagerClient) SetNodePoolSize(ctx context.Context, req *containerpb.SetNodePoolSizeRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
SetNodePoolSize sets the size for a specific node pool. The new size will be used for all
replicas, including future replicas created by modifying
NodePool.locations.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.SetNodePoolSizeRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#SetNodePoolSizeRequest.
}
resp, err := c.SetNodePoolSize(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) StartIPRotation ¶
func (c *ClusterManagerClient) StartIPRotation(ctx context.Context, req *containerpb.StartIPRotationRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
StartIPRotation starts master IP rotation.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.StartIPRotationRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#StartIPRotationRequest.
}
resp, err := c.StartIPRotation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) UpdateCluster ¶
func (c *ClusterManagerClient) UpdateCluster(ctx context.Context, req *containerpb.UpdateClusterRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
UpdateCluster updates the settings of a specific cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.UpdateClusterRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#UpdateClusterRequest.
}
resp, err := c.UpdateCluster(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) UpdateMaster ¶
func (c *ClusterManagerClient) UpdateMaster(ctx context.Context, req *containerpb.UpdateMasterRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
UpdateMaster updates the master for a specific cluster.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.UpdateMasterRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#UpdateMasterRequest.
}
resp, err := c.UpdateMaster(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ClusterManagerClient) UpdateNodePool ¶
func (c *ClusterManagerClient) UpdateNodePool(ctx context.Context, req *containerpb.UpdateNodePoolRequest, opts ...gax.CallOption) (*containerpb.Operation, error)
UpdateNodePool updates the version and/or image type for the specified node pool.
Code:play
Example¶
package main
import (
"context"
container "cloud.google.com/go/container/apiv1"
containerpb "cloud.google.com/go/container/apiv1/containerpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := container.NewClusterManagerClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &containerpb.UpdateNodePoolRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/container/apiv1/containerpb#UpdateNodePoolRequest.
}
resp, err := c.UpdateNodePool(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
type UsableSubnetworkIterator ¶
type UsableSubnetworkIterator struct { // Response is the raw response for the current page. // It must be cast to the RPC response type. // Calling Next() or InternalFetch() updates this value. Response interface{} // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*containerpb.UsableSubnetwork, nextPageToken string, err error) // contains filtered or unexported fields }
UsableSubnetworkIterator manages a stream of *containerpb.UsableSubnetwork.
func (*UsableSubnetworkIterator) All ¶
func (it *UsableSubnetworkIterator) All() iter.Seq2[*containerpb.UsableSubnetwork, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*UsableSubnetworkIterator) Next ¶
func (it *UsableSubnetworkIterator) Next() (*containerpb.UsableSubnetwork, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*UsableSubnetworkIterator) PageInfo ¶
func (it *UsableSubnetworkIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
Source Files ¶
auxiliary.go auxiliary_go123.go cluster_manager_client.go doc.go helpers.go version.go
Directories ¶
Path | Synopsis |
---|---|
apiv1/containerpb |
- Version
- v1.42.2 (latest)
- Published
- Jan 30, 2025
- Platform
- linux/amd64
- Imports
- 26 packages
- Last checked
- 5 days ago –
Tools for package owners.