Package: cloud.google.com/go/container/apiv1

package container Import Path cloud.google.com/go/container/apiv1 (on go.dev) Dependency Relation imports 19 packages, and imported by one package Involved Source Files cluster_manager_client.go d➜ doc.go 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. Use of Context The ctx passed to NewClient 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. For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go. Package-Level Type Names (total 5, in which 3 are exported) /* sort exporteds by: alphabet | popularity */ type ClusterManagerCallOptions (struct) ClusterManagerCallOptions contains the retry settings for each method of ClusterManagerClient. Fields (total 31, all are exported) CancelOperation []gax.CallOption CompleteIPRotation []gax.CallOption CreateCluster []gax.CallOption CreateNodePool []gax.CallOption DeleteCluster []gax.CallOption DeleteNodePool []gax.CallOption GetCluster []gax.CallOption GetNodePool []gax.CallOption GetOperation []gax.CallOption GetServerConfig []gax.CallOption ListClusters []gax.CallOption ListNodePools []gax.CallOption ListOperations []gax.CallOption ListUsableSubnetworks []gax.CallOption RollbackNodePoolUpgrade []gax.CallOption SetAddonsConfig []gax.CallOption SetLabels []gax.CallOption SetLegacyAbac []gax.CallOption SetLocations []gax.CallOption SetLoggingService []gax.CallOption SetMaintenancePolicy []gax.CallOption SetMasterAuth []gax.CallOption SetMonitoringService []gax.CallOption SetNetworkPolicy []gax.CallOption SetNodePoolAutoscaling []gax.CallOption SetNodePoolManagement []gax.CallOption SetNodePoolSize []gax.CallOption StartIPRotation []gax.CallOption UpdateCluster []gax.CallOption UpdateMaster []gax.CallOption UpdateNodePool []gax.CallOption As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func defaultClusterManagerCallOptions() *ClusterManagerCallOptions type ClusterManagerClient (struct) 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. Fields (total 5, in which 1 are exported) CallOptions *ClusterManagerCallOptions The call options for this service. /* 4 unexporteds ... *//* 4 unexporteds: */ clusterManagerClient containerpb.ClusterManagerClient The gRPC API client. connPool gtransport.ConnPool Connection pool of gRPC connections to the service. disableDeadlines bool flag to opt out of default deadlines via GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE xGoogMetadata metadata.MD The x-goog-* metadata to be sent with each request. Methods (total 34, in which 33 are exported) (*T) CancelOperation(ctx context.Context, req *containerpb.CancelOperationRequest, opts ...gax.CallOption) error CancelOperation cancels the specified operation. (*T) Close() error Close closes the connection to the API service. The user should invoke this when the client is no longer required. (*T) CompleteIPRotation(ctx context.Context, req *containerpb.CompleteIPRotationRequest, opts ...gax.CallOption) (*containerpb.Operation, error) CompleteIPRotation completes master IP rotation. (*T) Connection() *grpc.ClientConn Connection returns a connection to the API service. Deprecated. (*T) 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. (*T) CreateNodePool(ctx context.Context, req *containerpb.CreateNodePoolRequest, opts ...gax.CallOption) (*containerpb.Operation, error) CreateNodePool creates a node pool for a cluster. (*T) 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. (*T) DeleteNodePool(ctx context.Context, req *containerpb.DeleteNodePoolRequest, opts ...gax.CallOption) (*containerpb.Operation, error) DeleteNodePool deletes a node pool from a cluster. (*T) GetCluster(ctx context.Context, req *containerpb.GetClusterRequest, opts ...gax.CallOption) (*containerpb.Cluster, error) GetCluster gets the details of a specific cluster. (*T) GetNodePool(ctx context.Context, req *containerpb.GetNodePoolRequest, opts ...gax.CallOption) (*containerpb.NodePool, error) GetNodePool retrieves the requested node pool. (*T) GetOperation(ctx context.Context, req *containerpb.GetOperationRequest, opts ...gax.CallOption) (*containerpb.Operation, error) GetOperation gets the specified operation. (*T) GetServerConfig(ctx context.Context, req *containerpb.GetServerConfigRequest, opts ...gax.CallOption) (*containerpb.ServerConfig, error) GetServerConfig returns configuration info about the Google Kubernetes Engine service. (*T) 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. (*T) ListNodePools(ctx context.Context, req *containerpb.ListNodePoolsRequest, opts ...gax.CallOption) (*containerpb.ListNodePoolsResponse, error) ListNodePools lists the node pools for a cluster. (*T) 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. (*T) ListUsableSubnetworks(ctx context.Context, req *containerpb.ListUsableSubnetworksRequest, opts ...gax.CallOption) *UsableSubnetworkIterator ListUsableSubnetworks lists subnetworks that are usable for creating clusters in a project. (*T) 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. (*T) SetAddonsConfig(ctx context.Context, req *containerpb.SetAddonsConfigRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetAddonsConfig sets the addons for a specific cluster. (*T) SetLabels(ctx context.Context, req *containerpb.SetLabelsRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetLabels sets labels on a cluster. (*T) SetLegacyAbac(ctx context.Context, req *containerpb.SetLegacyAbacRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetLegacyAbac enables or disables the ABAC authorization mechanism on a cluster. (*T) SetLocations(ctx context.Context, req *containerpb.SetLocationsRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetLocations sets the locations for a specific cluster. (*T) SetLoggingService(ctx context.Context, req *containerpb.SetLoggingServiceRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetLoggingService sets the logging service for a specific cluster. (*T) SetMaintenancePolicy(ctx context.Context, req *containerpb.SetMaintenancePolicyRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetMaintenancePolicy sets the maintenance policy for a cluster. (*T) 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. (*T) SetMonitoringService(ctx context.Context, req *containerpb.SetMonitoringServiceRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetMonitoringService sets the monitoring service for a specific cluster. (*T) SetNetworkPolicy(ctx context.Context, req *containerpb.SetNetworkPolicyRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetNetworkPolicy enables or disables Network Policy for a cluster. (*T) SetNodePoolAutoscaling(ctx context.Context, req *containerpb.SetNodePoolAutoscalingRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetNodePoolAutoscaling sets the autoscaling settings for the specified node pool. (*T) SetNodePoolManagement(ctx context.Context, req *containerpb.SetNodePoolManagementRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetNodePoolManagement sets the NodeManagement options for a node pool. (*T) SetNodePoolSize(ctx context.Context, req *containerpb.SetNodePoolSizeRequest, opts ...gax.CallOption) (*containerpb.Operation, error) SetNodePoolSize sets the size for a specific node pool. (*T) StartIPRotation(ctx context.Context, req *containerpb.StartIPRotationRequest, opts ...gax.CallOption) (*containerpb.Operation, error) StartIPRotation starts master IP rotation. (*T) UpdateCluster(ctx context.Context, req *containerpb.UpdateClusterRequest, opts ...gax.CallOption) (*containerpb.Operation, error) UpdateCluster updates the settings of a specific cluster. (*T) UpdateMaster(ctx context.Context, req *containerpb.UpdateMasterRequest, opts ...gax.CallOption) (*containerpb.Operation, error) UpdateMaster updates the master for a specific cluster. (*T) 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. /* one unexported ... *//* one unexported: */ (*T) setGoogleClientInfo(keyval ...string) setGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients. Implements (at least one exported) *T : io.Closer As Outputs Of (at least one exported) func NewClusterManagerClient(ctx context.Context, opts ...option.ClientOption) (*ClusterManagerClient, error) type UsableSubnetworkIterator (struct) UsableSubnetworkIterator manages a stream of *containerpb.UsableSubnetwork. Fields (total 5, in which 2 are exported) InternalFetch func(pageSize int, pageToken string) (results []*containerpb.UsableSubnetwork, nextPageToken string, err error) 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. Response interface{} 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. /* 3 unexporteds ... *//* 3 unexporteds: */ items []*containerpb.UsableSubnetwork nextFunc func() error pageInfo *iterator.PageInfo Methods (total 4, in which 2 are exported) (*T) 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. (*T) PageInfo() *iterator.PageInfo PageInfo supports pagination. See the google.golang.org/api/iterator package for details. /* 2 unexporteds ... *//* 2 unexporteds: */ (*T) bufLen() int (*T) takeBuf() interface{} Implements (at least one exported) *T : google.golang.org/api/iterator.Pageable As Outputs Of (at least one exported) func (*ClusterManagerClient).ListUsableSubnetworks(ctx context.Context, req *containerpb.ListUsableSubnetworksRequest, opts ...gax.CallOption) *UsableSubnetworkIterator /* 2 unexporteds ... *//* 2 unexporteds: */ type clientHook (func) As Types Of (only one, which is unexported) /* one unexported ... *//* one unexported: */ var newClusterManagerClientHook type clientHookParams (struct) For more information on implementing a client constructor hook, see https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors. Package-Level Functions (total 7, in which 2 are exported) func DefaultAuthScopes() []string DefaultAuthScopes reports the default set of authentication scopes to use with this package. func NewClusterManagerClient(ctx context.Context, opts ...option.ClientOption) (*ClusterManagerClient, error) NewClusterManagerClient creates a new cluster manager client. Google Kubernetes Engine Cluster Manager v1 /* 5 unexporteds ... *//* 5 unexporteds: */ func checkDisableDeadlines() (bool, error) func defaultClusterManagerCallOptions() *ClusterManagerCallOptions func defaultClusterManagerClientOptions() []option.ClientOption func insertMetadata(ctx context.Context, mds ...metadata.MD) context.Context func versionGo() string versionGo returns the Go runtime version. The returned string has no whitespace, suitable for reporting in header. Package-Level Variables (only one, which is unexported) /* one unexported ... *//* one unexported: */ var newClusterManagerClientHook clientHook Package-Level Constants (only one, which is unexported) /* one unexported ... *//* one unexported: */ const versionClient = "20200912"

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.