Package cloud.google.com/go/gkemulticloud/apiv1 (v0.2.0)

Package gkemulticloud is an auto-generated package for the Anthos Multi-Cloud API.

Anthos Multi-Cloud provides a way to manage Kubernetes clusters that run on AWS and Azure infrastructure using the Anthos Multi-Cloud API. Combined with Connect, you can manage Kubernetes clusters on Google Cloud, AWS, and Azure from the Google Cloud Console. When you create a cluster with Anthos Multi-Cloud, Google creates the resources needed and brings up a cluster on your behalf. You can deploy workloads with the Anthos Multi-Cloud API or the gcloud and kubectl command-line tools.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

Example usage

To get started with this package, create a client.

ctx := context.Background()
c, err := gkemulticloud.NewAwsClustersClient(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.

ctx := context.Background()
c, err := gkemulticloud.NewAwsClustersClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &gkemulticloudpb.CreateAwsClusterRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#CreateAwsClusterRequest.
}
op, err := c.CreateAwsCluster(ctx, req)
if err != nil {
    // TODO: Handle error.
}

resp, err := op.Wait(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

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 https://pkg.go.dev/cloud.google.com/go.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

AwsClusterIterator

type AwsClusterIterator 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 []*gkemulticloudpb.AwsCluster, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AwsClusterIterator manages a stream of *gkemulticloudpb.AwsCluster.

func (*AwsClusterIterator) Next

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 (*AwsClusterIterator) PageInfo

func (it *AwsClusterIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

AwsClustersCallOptions

type AwsClustersCallOptions struct {
	CreateAwsCluster       []gax.CallOption
	UpdateAwsCluster       []gax.CallOption
	GetAwsCluster          []gax.CallOption
	ListAwsClusters        []gax.CallOption
	DeleteAwsCluster       []gax.CallOption
	GenerateAwsAccessToken []gax.CallOption
	CreateAwsNodePool      []gax.CallOption
	UpdateAwsNodePool      []gax.CallOption
	GetAwsNodePool         []gax.CallOption
	ListAwsNodePools       []gax.CallOption
	DeleteAwsNodePool      []gax.CallOption
	GetAwsServerConfig     []gax.CallOption
}

AwsClustersCallOptions contains the retry settings for each method of AwsClustersClient.

AwsClustersClient

type AwsClustersClient struct {

	// The call options for this service.
	CallOptions *AwsClustersCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

AwsClustersClient is a client for interacting with Anthos Multi-Cloud API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS infrastructure.

func NewAwsClustersClient

func NewAwsClustersClient(ctx context.Context, opts ...option.ClientOption) (*AwsClustersClient, error)

NewAwsClustersClient creates a new aws clusters client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS infrastructure.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*AwsClustersClient) Close

func (c *AwsClustersClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*AwsClustersClient) Connection

func (c *AwsClustersClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*AwsClustersClient) CreateAwsCluster

CreateAwsCluster creates a new AwsCluster resource on a given GCP project and region.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.CreateAwsClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#CreateAwsClusterRequest.
	}
	op, err := c.CreateAwsCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AwsClustersClient) CreateAwsClusterOperation

func (c *AwsClustersClient) CreateAwsClusterOperation(name string) *CreateAwsClusterOperation

CreateAwsClusterOperation returns a new CreateAwsClusterOperation from a given name. The name must be that of a previously created CreateAwsClusterOperation, possibly from a different process.

func (*AwsClustersClient) CreateAwsNodePool

CreateAwsNodePool creates a new AwsNodePool, attached to a given AwsCluster.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.CreateAwsNodePoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#CreateAwsNodePoolRequest.
	}
	op, err := c.CreateAwsNodePool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AwsClustersClient) CreateAwsNodePoolOperation

func (c *AwsClustersClient) CreateAwsNodePoolOperation(name string) *CreateAwsNodePoolOperation

CreateAwsNodePoolOperation returns a new CreateAwsNodePoolOperation from a given name. The name must be that of a previously created CreateAwsNodePoolOperation, possibly from a different process.

func (*AwsClustersClient) DeleteAwsCluster

DeleteAwsCluster deletes a specific AwsCluster resource.

Fails if the cluster has one or more associated AwsNodePool resources.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.DeleteAwsClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#DeleteAwsClusterRequest.
	}
	op, err := c.DeleteAwsCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*AwsClustersClient) DeleteAwsClusterOperation

func (c *AwsClustersClient) DeleteAwsClusterOperation(name string) *DeleteAwsClusterOperation

DeleteAwsClusterOperation returns a new DeleteAwsClusterOperation from a given name. The name must be that of a previously created DeleteAwsClusterOperation, possibly from a different process.

func (*AwsClustersClient) DeleteAwsNodePool

DeleteAwsNodePool deletes a specific AwsNodePool resource.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.DeleteAwsNodePoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#DeleteAwsNodePoolRequest.
	}
	op, err := c.DeleteAwsNodePool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*AwsClustersClient) DeleteAwsNodePoolOperation

func (c *AwsClustersClient) DeleteAwsNodePoolOperation(name string) *DeleteAwsNodePoolOperation

DeleteAwsNodePoolOperation returns a new DeleteAwsNodePoolOperation from a given name. The name must be that of a previously created DeleteAwsNodePoolOperation, possibly from a different process.

func (*AwsClustersClient) GenerateAwsAccessToken

GenerateAwsAccessToken generates a short-lived access token to authenticate to a given AwsCluster resource.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.GenerateAwsAccessTokenRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#GenerateAwsAccessTokenRequest.
	}
	resp, err := c.GenerateAwsAccessToken(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AwsClustersClient) GetAwsCluster

GetAwsCluster describes a specific AwsCluster resource.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.GetAwsClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#GetAwsClusterRequest.
	}
	resp, err := c.GetAwsCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AwsClustersClient) GetAwsNodePool

GetAwsNodePool describes a specific AwsNodePool resource.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.GetAwsNodePoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#GetAwsNodePoolRequest.
	}
	resp, err := c.GetAwsNodePool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AwsClustersClient) GetAwsServerConfig

GetAwsServerConfig returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.GetAwsServerConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#GetAwsServerConfigRequest.
	}
	resp, err := c.GetAwsServerConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AwsClustersClient) ListAwsClusters

ListAwsClusters lists all AwsCluster resources on a given Google Cloud project and region.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	"google.golang.org/api/iterator"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.ListAwsClustersRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#ListAwsClustersRequest.
	}
	it := c.ListAwsClusters(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*AwsClustersClient) ListAwsNodePools

ListAwsNodePools lists all AwsNodePool resources on a given AwsCluster.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	"google.golang.org/api/iterator"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.ListAwsNodePoolsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#ListAwsNodePoolsRequest.
	}
	it := c.ListAwsNodePools(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*AwsClustersClient) UpdateAwsCluster

UpdateAwsCluster updates an AwsCluster.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.UpdateAwsClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#UpdateAwsClusterRequest.
	}
	op, err := c.UpdateAwsCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AwsClustersClient) UpdateAwsClusterOperation

func (c *AwsClustersClient) UpdateAwsClusterOperation(name string) *UpdateAwsClusterOperation

UpdateAwsClusterOperation returns a new UpdateAwsClusterOperation from a given name. The name must be that of a previously created UpdateAwsClusterOperation, possibly from a different process.

func (*AwsClustersClient) UpdateAwsNodePool

UpdateAwsNodePool updates an AwsNodePool.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAwsClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.UpdateAwsNodePoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#UpdateAwsNodePoolRequest.
	}
	op, err := c.UpdateAwsNodePool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AwsClustersClient) UpdateAwsNodePoolOperation

func (c *AwsClustersClient) UpdateAwsNodePoolOperation(name string) *UpdateAwsNodePoolOperation

UpdateAwsNodePoolOperation returns a new UpdateAwsNodePoolOperation from a given name. The name must be that of a previously created UpdateAwsNodePoolOperation, possibly from a different process.

AwsNodePoolIterator

type AwsNodePoolIterator 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 []*gkemulticloudpb.AwsNodePool, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AwsNodePoolIterator manages a stream of *gkemulticloudpb.AwsNodePool.

func (*AwsNodePoolIterator) Next

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 (*AwsNodePoolIterator) PageInfo

func (it *AwsNodePoolIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

AzureClientIterator

type AzureClientIterator 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 []*gkemulticloudpb.AzureClient, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AzureClientIterator manages a stream of *gkemulticloudpb.AzureClient.

func (*AzureClientIterator) Next

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 (*AzureClientIterator) PageInfo

func (it *AzureClientIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

AzureClusterIterator

type AzureClusterIterator 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 []*gkemulticloudpb.AzureCluster, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AzureClusterIterator manages a stream of *gkemulticloudpb.AzureCluster.

func (*AzureClusterIterator) Next

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 (*AzureClusterIterator) PageInfo

func (it *AzureClusterIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

AzureClustersCallOptions

type AzureClustersCallOptions struct {
	CreateAzureClient        []gax.CallOption
	GetAzureClient           []gax.CallOption
	ListAzureClients         []gax.CallOption
	DeleteAzureClient        []gax.CallOption
	CreateAzureCluster       []gax.CallOption
	UpdateAzureCluster       []gax.CallOption
	GetAzureCluster          []gax.CallOption
	ListAzureClusters        []gax.CallOption
	DeleteAzureCluster       []gax.CallOption
	GenerateAzureAccessToken []gax.CallOption
	CreateAzureNodePool      []gax.CallOption
	UpdateAzureNodePool      []gax.CallOption
	GetAzureNodePool         []gax.CallOption
	ListAzureNodePools       []gax.CallOption
	DeleteAzureNodePool      []gax.CallOption
	GetAzureServerConfig     []gax.CallOption
}

AzureClustersCallOptions contains the retry settings for each method of AzureClustersClient.

AzureClustersClient

type AzureClustersClient struct {

	// The call options for this service.
	CallOptions *AzureClustersCallOptions

	// LROClient is used internally to handle long-running operations.
	// It is exposed so that its CallOptions can be modified if required.
	// Users should not Close this client.
	LROClient *lroauto.OperationsClient
	// contains filtered or unexported fields
}

AzureClustersClient is a client for interacting with Anthos Multi-Cloud API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

The AzureClusters API provides a single centrally managed service to create and manage Anthos clusters that run on Azure infrastructure.

func NewAzureClustersClient

func NewAzureClustersClient(ctx context.Context, opts ...option.ClientOption) (*AzureClustersClient, error)

NewAzureClustersClient creates a new azure clusters client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

The AzureClusters API provides a single centrally managed service to create and manage Anthos clusters that run on Azure infrastructure.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*AzureClustersClient) Close

func (c *AzureClustersClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*AzureClustersClient) Connection

func (c *AzureClustersClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*AzureClustersClient) CreateAzureClient

CreateAzureClient creates a new AzureClient resource on a given Google Cloud project and region.

AzureClient resources hold client authentication information needed by the Anthos Multicloud API to manage Azure resources on your Azure subscription on your behalf.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.CreateAzureClientRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#CreateAzureClientRequest.
	}
	op, err := c.CreateAzureClient(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AzureClustersClient) CreateAzureClientOperation

func (c *AzureClustersClient) CreateAzureClientOperation(name string) *CreateAzureClientOperation

CreateAzureClientOperation returns a new CreateAzureClientOperation from a given name. The name must be that of a previously created CreateAzureClientOperation, possibly from a different process.

func (*AzureClustersClient) CreateAzureCluster

CreateAzureCluster creates a new AzureCluster resource on a given GCP project and region.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.CreateAzureClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#CreateAzureClusterRequest.
	}
	op, err := c.CreateAzureCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AzureClustersClient) CreateAzureClusterOperation

func (c *AzureClustersClient) CreateAzureClusterOperation(name string) *CreateAzureClusterOperation

CreateAzureClusterOperation returns a new CreateAzureClusterOperation from a given name. The name must be that of a previously created CreateAzureClusterOperation, possibly from a different process.

func (*AzureClustersClient) CreateAzureNodePool

CreateAzureNodePool creates a new AzureNodePool, attached to a given AzureCluster.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.CreateAzureNodePoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#CreateAzureNodePoolRequest.
	}
	op, err := c.CreateAzureNodePool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AzureClustersClient) CreateAzureNodePoolOperation

func (c *AzureClustersClient) CreateAzureNodePoolOperation(name string) *CreateAzureNodePoolOperation

CreateAzureNodePoolOperation returns a new CreateAzureNodePoolOperation from a given name. The name must be that of a previously created CreateAzureNodePoolOperation, possibly from a different process.

func (*AzureClustersClient) DeleteAzureClient

DeleteAzureClient deletes a specific AzureClient resource.

If the client is used by one or more clusters, deletion will fail and a FAILED_PRECONDITION error will be returned.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.DeleteAzureClientRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#DeleteAzureClientRequest.
	}
	op, err := c.DeleteAzureClient(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*AzureClustersClient) DeleteAzureClientOperation

func (c *AzureClustersClient) DeleteAzureClientOperation(name string) *DeleteAzureClientOperation

DeleteAzureClientOperation returns a new DeleteAzureClientOperation from a given name. The name must be that of a previously created DeleteAzureClientOperation, possibly from a different process.

func (*AzureClustersClient) DeleteAzureCluster

DeleteAzureCluster deletes a specific AzureCluster resource.

Fails if the cluster has one or more associated AzureNodePool resources.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.DeleteAzureClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#DeleteAzureClusterRequest.
	}
	op, err := c.DeleteAzureCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*AzureClustersClient) DeleteAzureClusterOperation

func (c *AzureClustersClient) DeleteAzureClusterOperation(name string) *DeleteAzureClusterOperation

DeleteAzureClusterOperation returns a new DeleteAzureClusterOperation from a given name. The name must be that of a previously created DeleteAzureClusterOperation, possibly from a different process.

func (*AzureClustersClient) DeleteAzureNodePool

DeleteAzureNodePool deletes a specific AzureNodePool resource.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.DeleteAzureNodePoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#DeleteAzureNodePoolRequest.
	}
	op, err := c.DeleteAzureNodePool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*AzureClustersClient) DeleteAzureNodePoolOperation

func (c *AzureClustersClient) DeleteAzureNodePoolOperation(name string) *DeleteAzureNodePoolOperation

DeleteAzureNodePoolOperation returns a new DeleteAzureNodePoolOperation from a given name. The name must be that of a previously created DeleteAzureNodePoolOperation, possibly from a different process.

func (*AzureClustersClient) GenerateAzureAccessToken

GenerateAzureAccessToken generates a short-lived access token to authenticate to a given AzureCluster resource.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.GenerateAzureAccessTokenRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#GenerateAzureAccessTokenRequest.
	}
	resp, err := c.GenerateAzureAccessToken(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AzureClustersClient) GetAzureClient

GetAzureClient describes a specific AzureClient resource.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.GetAzureClientRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#GetAzureClientRequest.
	}
	resp, err := c.GetAzureClient(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AzureClustersClient) GetAzureCluster

GetAzureCluster describes a specific AzureCluster resource.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.GetAzureClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#GetAzureClusterRequest.
	}
	resp, err := c.GetAzureCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AzureClustersClient) GetAzureNodePool

GetAzureNodePool describes a specific AzureNodePool resource.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.GetAzureNodePoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#GetAzureNodePoolRequest.
	}
	resp, err := c.GetAzureNodePool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AzureClustersClient) GetAzureServerConfig

GetAzureServerConfig returns information, such as supported Azure regions and Kubernetes versions, on a given Google Cloud location.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.GetAzureServerConfigRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#GetAzureServerConfigRequest.
	}
	resp, err := c.GetAzureServerConfig(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AzureClustersClient) ListAzureClients

ListAzureClients lists all AzureClient resources on a given Google Cloud project and region.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	"google.golang.org/api/iterator"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.ListAzureClientsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#ListAzureClientsRequest.
	}
	it := c.ListAzureClients(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*AzureClustersClient) ListAzureClusters

ListAzureClusters lists all AzureCluster resources on a given Google Cloud project and region.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	"google.golang.org/api/iterator"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.ListAzureClustersRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#ListAzureClustersRequest.
	}
	it := c.ListAzureClusters(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*AzureClustersClient) ListAzureNodePools

ListAzureNodePools lists all AzureNodePool resources on a given AzureCluster.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	"google.golang.org/api/iterator"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.ListAzureNodePoolsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#ListAzureNodePoolsRequest.
	}
	it := c.ListAzureNodePools(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*AzureClustersClient) UpdateAzureCluster

UpdateAzureCluster updates an AzureCluster.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.UpdateAzureClusterRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#UpdateAzureClusterRequest.
	}
	op, err := c.UpdateAzureCluster(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AzureClustersClient) UpdateAzureClusterOperation

func (c *AzureClustersClient) UpdateAzureClusterOperation(name string) *UpdateAzureClusterOperation

UpdateAzureClusterOperation returns a new UpdateAzureClusterOperation from a given name. The name must be that of a previously created UpdateAzureClusterOperation, possibly from a different process.

func (*AzureClustersClient) UpdateAzureNodePool

UpdateAzureNodePool updates an AzureNodePool.

Example

package main

import (
	gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1"
	"context"
	gkemulticloudpb "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1"
)

func main() {
	ctx := context.Background()
	c, err := gkemulticloud.NewAzureClustersClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &gkemulticloudpb.UpdateAzureNodePoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1#UpdateAzureNodePoolRequest.
	}
	op, err := c.UpdateAzureNodePool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AzureClustersClient) UpdateAzureNodePoolOperation

func (c *AzureClustersClient) UpdateAzureNodePoolOperation(name string) *UpdateAzureNodePoolOperation

UpdateAzureNodePoolOperation returns a new UpdateAzureNodePoolOperation from a given name. The name must be that of a previously created UpdateAzureNodePoolOperation, possibly from a different process.

AzureNodePoolIterator

type AzureNodePoolIterator 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 []*gkemulticloudpb.AzureNodePool, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AzureNodePoolIterator manages a stream of *gkemulticloudpb.AzureNodePool.

func (*AzureNodePoolIterator) Next

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 (*AzureNodePoolIterator) PageInfo

func (it *AzureNodePoolIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

CreateAwsClusterOperation

type CreateAwsClusterOperation struct {
	// contains filtered or unexported fields
}

CreateAwsClusterOperation manages a long-running operation from CreateAwsCluster.

func (*CreateAwsClusterOperation) Done

func (op *CreateAwsClusterOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateAwsClusterOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateAwsClusterOperation) Name

func (op *CreateAwsClusterOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateAwsClusterOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateAwsClusterOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

CreateAwsNodePoolOperation

type CreateAwsNodePoolOperation struct {
	// contains filtered or unexported fields
}

CreateAwsNodePoolOperation manages a long-running operation from CreateAwsNodePool.

func (*CreateAwsNodePoolOperation) Done

func (op *CreateAwsNodePoolOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateAwsNodePoolOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateAwsNodePoolOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateAwsNodePoolOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateAwsNodePoolOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

CreateAzureClientOperation

type CreateAzureClientOperation struct {
	// contains filtered or unexported fields
}

CreateAzureClientOperation manages a long-running operation from CreateAzureClient.

func (*CreateAzureClientOperation) Done

func (op *CreateAzureClientOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateAzureClientOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateAzureClientOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateAzureClientOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateAzureClientOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

CreateAzureClusterOperation

type CreateAzureClusterOperation struct {
	// contains filtered or unexported fields
}

CreateAzureClusterOperation manages a long-running operation from CreateAzureCluster.

func (*CreateAzureClusterOperation) Done

func (op *CreateAzureClusterOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateAzureClusterOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateAzureClusterOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateAzureClusterOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateAzureClusterOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

CreateAzureNodePoolOperation

type CreateAzureNodePoolOperation struct {
	// contains filtered or unexported fields
}

CreateAzureNodePoolOperation manages a long-running operation from CreateAzureNodePool.

func (*CreateAzureNodePoolOperation) Done

Done reports whether the long-running operation has completed.

func (*CreateAzureNodePoolOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateAzureNodePoolOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateAzureNodePoolOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateAzureNodePoolOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteAwsClusterOperation

type DeleteAwsClusterOperation struct {
	// contains filtered or unexported fields
}

DeleteAwsClusterOperation manages a long-running operation from DeleteAwsCluster.

func (*DeleteAwsClusterOperation) Done

func (op *DeleteAwsClusterOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteAwsClusterOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeleteAwsClusterOperation) Name

func (op *DeleteAwsClusterOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteAwsClusterOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeleteAwsClusterOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteAwsNodePoolOperation

type DeleteAwsNodePoolOperation struct {
	// contains filtered or unexported fields
}

DeleteAwsNodePoolOperation manages a long-running operation from DeleteAwsNodePool.

func (*DeleteAwsNodePoolOperation) Done

func (op *DeleteAwsNodePoolOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteAwsNodePoolOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeleteAwsNodePoolOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteAwsNodePoolOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeleteAwsNodePoolOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteAzureClientOperation

type DeleteAzureClientOperation struct {
	// contains filtered or unexported fields
}

DeleteAzureClientOperation manages a long-running operation from DeleteAzureClient.

func (*DeleteAzureClientOperation) Done

func (op *DeleteAzureClientOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteAzureClientOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeleteAzureClientOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteAzureClientOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeleteAzureClientOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteAzureClusterOperation

type DeleteAzureClusterOperation struct {
	// contains filtered or unexported fields
}

DeleteAzureClusterOperation manages a long-running operation from DeleteAzureCluster.

func (*DeleteAzureClusterOperation) Done

func (op *DeleteAzureClusterOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteAzureClusterOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeleteAzureClusterOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteAzureClusterOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeleteAzureClusterOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteAzureNodePoolOperation

type DeleteAzureNodePoolOperation struct {
	// contains filtered or unexported fields
}

DeleteAzureNodePoolOperation manages a long-running operation from DeleteAzureNodePool.

func (*DeleteAzureNodePoolOperation) Done

Done reports whether the long-running operation has completed.

func (*DeleteAzureNodePoolOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*DeleteAzureNodePoolOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteAzureNodePoolOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeleteAzureNodePoolOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

UpdateAwsClusterOperation

type UpdateAwsClusterOperation struct {
	// contains filtered or unexported fields
}

UpdateAwsClusterOperation manages a long-running operation from UpdateAwsCluster.

func (*UpdateAwsClusterOperation) Done

func (op *UpdateAwsClusterOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateAwsClusterOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*UpdateAwsClusterOperation) Name

func (op *UpdateAwsClusterOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*UpdateAwsClusterOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*UpdateAwsClusterOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

UpdateAwsNodePoolOperation

type UpdateAwsNodePoolOperation struct {
	// contains filtered or unexported fields
}

UpdateAwsNodePoolOperation manages a long-running operation from UpdateAwsNodePool.

func (*UpdateAwsNodePoolOperation) Done

func (op *UpdateAwsNodePoolOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateAwsNodePoolOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*UpdateAwsNodePoolOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*UpdateAwsNodePoolOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*UpdateAwsNodePoolOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

UpdateAzureClusterOperation

type UpdateAzureClusterOperation struct {
	// contains filtered or unexported fields
}

UpdateAzureClusterOperation manages a long-running operation from UpdateAzureCluster.

func (*UpdateAzureClusterOperation) Done

func (op *UpdateAzureClusterOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateAzureClusterOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*UpdateAzureClusterOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*UpdateAzureClusterOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*UpdateAzureClusterOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

UpdateAzureNodePoolOperation

type UpdateAzureNodePoolOperation struct {
	// contains filtered or unexported fields
}

UpdateAzureNodePoolOperation manages a long-running operation from UpdateAzureNodePool.

func (*UpdateAzureNodePoolOperation) Done

Done reports whether the long-running operation has completed.

func (*UpdateAzureNodePoolOperation) Metadata

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*UpdateAzureNodePoolOperation) Name

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*UpdateAzureNodePoolOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*UpdateAzureNodePoolOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.