Documentation ¶
Overview ¶
Package gkemulticloud is an auto-generated package for the GKE Multi-Cloud API.
GKE Multi-Cloud provides a way to manage Kubernetes clusters that run on AWS and Azure infrastructure using the GKE 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 GKE Multi-Cloud, Google creates the resources needed and brings up a cluster on your behalf. You can deploy workloads with the GKE Multi-Cloud API or the gcloud and kubectl command-line tools.
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.
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 := gkemulticloud.NewAttachedClustersClient(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() // 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.CreateAttachedClusterRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#CreateAttachedClusterRequest. } op, err := c.CreateAttachedCluster(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 NewAttachedClustersClient 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 AttachedClusterIterator
- type AttachedClustersCallOptions
- type AttachedClustersClient
- func (c *AttachedClustersClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *AttachedClustersClient) Close() error
- func (c *AttachedClustersClient) Connection() *grpc.ClientConndeprecated
- func (c *AttachedClustersClient) CreateAttachedCluster(ctx context.Context, req *gkemulticloudpb.CreateAttachedClusterRequest, ...) (*CreateAttachedClusterOperation, error)
- func (c *AttachedClustersClient) CreateAttachedClusterOperation(name string) *CreateAttachedClusterOperation
- func (c *AttachedClustersClient) DeleteAttachedCluster(ctx context.Context, req *gkemulticloudpb.DeleteAttachedClusterRequest, ...) (*DeleteAttachedClusterOperation, error)
- func (c *AttachedClustersClient) DeleteAttachedClusterOperation(name string) *DeleteAttachedClusterOperation
- func (c *AttachedClustersClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *AttachedClustersClient) GenerateAttachedClusterAgentToken(ctx context.Context, ...) (*gkemulticloudpb.GenerateAttachedClusterAgentTokenResponse, error)
- func (c *AttachedClustersClient) GenerateAttachedClusterInstallManifest(ctx context.Context, ...) (*gkemulticloudpb.GenerateAttachedClusterInstallManifestResponse, error)
- func (c *AttachedClustersClient) GetAttachedCluster(ctx context.Context, req *gkemulticloudpb.GetAttachedClusterRequest, ...) (*gkemulticloudpb.AttachedCluster, error)
- func (c *AttachedClustersClient) GetAttachedServerConfig(ctx context.Context, req *gkemulticloudpb.GetAttachedServerConfigRequest, ...) (*gkemulticloudpb.AttachedServerConfig, error)
- func (c *AttachedClustersClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *AttachedClustersClient) ImportAttachedCluster(ctx context.Context, req *gkemulticloudpb.ImportAttachedClusterRequest, ...) (*ImportAttachedClusterOperation, error)
- func (c *AttachedClustersClient) ImportAttachedClusterOperation(name string) *ImportAttachedClusterOperation
- func (c *AttachedClustersClient) ListAttachedClusters(ctx context.Context, req *gkemulticloudpb.ListAttachedClustersRequest, ...) *AttachedClusterIterator
- func (c *AttachedClustersClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *AttachedClustersClient) UpdateAttachedCluster(ctx context.Context, req *gkemulticloudpb.UpdateAttachedClusterRequest, ...) (*UpdateAttachedClusterOperation, error)
- func (c *AttachedClustersClient) UpdateAttachedClusterOperation(name string) *UpdateAttachedClusterOperation
- type AwsClusterIterator
- type AwsClustersCallOptions
- type AwsClustersClient
- func (c *AwsClustersClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *AwsClustersClient) Close() error
- func (c *AwsClustersClient) Connection() *grpc.ClientConndeprecated
- func (c *AwsClustersClient) CreateAwsCluster(ctx context.Context, req *gkemulticloudpb.CreateAwsClusterRequest, ...) (*CreateAwsClusterOperation, error)
- func (c *AwsClustersClient) CreateAwsClusterOperation(name string) *CreateAwsClusterOperation
- func (c *AwsClustersClient) CreateAwsNodePool(ctx context.Context, req *gkemulticloudpb.CreateAwsNodePoolRequest, ...) (*CreateAwsNodePoolOperation, error)
- func (c *AwsClustersClient) CreateAwsNodePoolOperation(name string) *CreateAwsNodePoolOperation
- func (c *AwsClustersClient) DeleteAwsCluster(ctx context.Context, req *gkemulticloudpb.DeleteAwsClusterRequest, ...) (*DeleteAwsClusterOperation, error)
- func (c *AwsClustersClient) DeleteAwsClusterOperation(name string) *DeleteAwsClusterOperation
- func (c *AwsClustersClient) DeleteAwsNodePool(ctx context.Context, req *gkemulticloudpb.DeleteAwsNodePoolRequest, ...) (*DeleteAwsNodePoolOperation, error)
- func (c *AwsClustersClient) DeleteAwsNodePoolOperation(name string) *DeleteAwsNodePoolOperation
- func (c *AwsClustersClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *AwsClustersClient) GenerateAwsAccessToken(ctx context.Context, req *gkemulticloudpb.GenerateAwsAccessTokenRequest, ...) (*gkemulticloudpb.GenerateAwsAccessTokenResponse, error)
- func (c *AwsClustersClient) GenerateAwsClusterAgentToken(ctx context.Context, req *gkemulticloudpb.GenerateAwsClusterAgentTokenRequest, ...) (*gkemulticloudpb.GenerateAwsClusterAgentTokenResponse, error)
- func (c *AwsClustersClient) GetAwsCluster(ctx context.Context, req *gkemulticloudpb.GetAwsClusterRequest, ...) (*gkemulticloudpb.AwsCluster, error)
- func (c *AwsClustersClient) GetAwsJsonWebKeys(ctx context.Context, req *gkemulticloudpb.GetAwsJsonWebKeysRequest, ...) (*gkemulticloudpb.AwsJsonWebKeys, error)
- func (c *AwsClustersClient) GetAwsNodePool(ctx context.Context, req *gkemulticloudpb.GetAwsNodePoolRequest, ...) (*gkemulticloudpb.AwsNodePool, error)
- func (c *AwsClustersClient) GetAwsOpenIdConfig(ctx context.Context, req *gkemulticloudpb.GetAwsOpenIdConfigRequest, ...) (*gkemulticloudpb.AwsOpenIdConfig, error)
- func (c *AwsClustersClient) GetAwsServerConfig(ctx context.Context, req *gkemulticloudpb.GetAwsServerConfigRequest, ...) (*gkemulticloudpb.AwsServerConfig, error)
- func (c *AwsClustersClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *AwsClustersClient) ListAwsClusters(ctx context.Context, req *gkemulticloudpb.ListAwsClustersRequest, ...) *AwsClusterIterator
- func (c *AwsClustersClient) ListAwsNodePools(ctx context.Context, req *gkemulticloudpb.ListAwsNodePoolsRequest, ...) *AwsNodePoolIterator
- func (c *AwsClustersClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *AwsClustersClient) RollbackAwsNodePoolUpdate(ctx context.Context, req *gkemulticloudpb.RollbackAwsNodePoolUpdateRequest, ...) (*RollbackAwsNodePoolUpdateOperation, error)
- func (c *AwsClustersClient) RollbackAwsNodePoolUpdateOperation(name string) *RollbackAwsNodePoolUpdateOperation
- func (c *AwsClustersClient) UpdateAwsCluster(ctx context.Context, req *gkemulticloudpb.UpdateAwsClusterRequest, ...) (*UpdateAwsClusterOperation, error)
- func (c *AwsClustersClient) UpdateAwsClusterOperation(name string) *UpdateAwsClusterOperation
- func (c *AwsClustersClient) UpdateAwsNodePool(ctx context.Context, req *gkemulticloudpb.UpdateAwsNodePoolRequest, ...) (*UpdateAwsNodePoolOperation, error)
- func (c *AwsClustersClient) UpdateAwsNodePoolOperation(name string) *UpdateAwsNodePoolOperation
- type AwsNodePoolIterator
- type AzureClientIterator
- type AzureClusterIterator
- type AzureClustersCallOptions
- type AzureClustersClient
- func (c *AzureClustersClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *AzureClustersClient) Close() error
- func (c *AzureClustersClient) Connection() *grpc.ClientConndeprecated
- func (c *AzureClustersClient) CreateAzureClient(ctx context.Context, req *gkemulticloudpb.CreateAzureClientRequest, ...) (*CreateAzureClientOperation, error)
- func (c *AzureClustersClient) CreateAzureClientOperation(name string) *CreateAzureClientOperation
- func (c *AzureClustersClient) CreateAzureCluster(ctx context.Context, req *gkemulticloudpb.CreateAzureClusterRequest, ...) (*CreateAzureClusterOperation, error)
- func (c *AzureClustersClient) CreateAzureClusterOperation(name string) *CreateAzureClusterOperation
- func (c *AzureClustersClient) CreateAzureNodePool(ctx context.Context, req *gkemulticloudpb.CreateAzureNodePoolRequest, ...) (*CreateAzureNodePoolOperation, error)
- func (c *AzureClustersClient) CreateAzureNodePoolOperation(name string) *CreateAzureNodePoolOperation
- func (c *AzureClustersClient) DeleteAzureClient(ctx context.Context, req *gkemulticloudpb.DeleteAzureClientRequest, ...) (*DeleteAzureClientOperation, error)
- func (c *AzureClustersClient) DeleteAzureClientOperation(name string) *DeleteAzureClientOperation
- func (c *AzureClustersClient) DeleteAzureCluster(ctx context.Context, req *gkemulticloudpb.DeleteAzureClusterRequest, ...) (*DeleteAzureClusterOperation, error)
- func (c *AzureClustersClient) DeleteAzureClusterOperation(name string) *DeleteAzureClusterOperation
- func (c *AzureClustersClient) DeleteAzureNodePool(ctx context.Context, req *gkemulticloudpb.DeleteAzureNodePoolRequest, ...) (*DeleteAzureNodePoolOperation, error)
- func (c *AzureClustersClient) DeleteAzureNodePoolOperation(name string) *DeleteAzureNodePoolOperation
- func (c *AzureClustersClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *AzureClustersClient) GenerateAzureAccessToken(ctx context.Context, req *gkemulticloudpb.GenerateAzureAccessTokenRequest, ...) (*gkemulticloudpb.GenerateAzureAccessTokenResponse, error)
- func (c *AzureClustersClient) GenerateAzureClusterAgentToken(ctx context.Context, ...) (*gkemulticloudpb.GenerateAzureClusterAgentTokenResponse, error)
- func (c *AzureClustersClient) GetAzureClient(ctx context.Context, req *gkemulticloudpb.GetAzureClientRequest, ...) (*gkemulticloudpb.AzureClient, error)
- func (c *AzureClustersClient) GetAzureCluster(ctx context.Context, req *gkemulticloudpb.GetAzureClusterRequest, ...) (*gkemulticloudpb.AzureCluster, error)
- func (c *AzureClustersClient) GetAzureJsonWebKeys(ctx context.Context, req *gkemulticloudpb.GetAzureJsonWebKeysRequest, ...) (*gkemulticloudpb.AzureJsonWebKeys, error)
- func (c *AzureClustersClient) GetAzureNodePool(ctx context.Context, req *gkemulticloudpb.GetAzureNodePoolRequest, ...) (*gkemulticloudpb.AzureNodePool, error)
- func (c *AzureClustersClient) GetAzureOpenIdConfig(ctx context.Context, req *gkemulticloudpb.GetAzureOpenIdConfigRequest, ...) (*gkemulticloudpb.AzureOpenIdConfig, error)
- func (c *AzureClustersClient) GetAzureServerConfig(ctx context.Context, req *gkemulticloudpb.GetAzureServerConfigRequest, ...) (*gkemulticloudpb.AzureServerConfig, error)
- func (c *AzureClustersClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *AzureClustersClient) ListAzureClients(ctx context.Context, req *gkemulticloudpb.ListAzureClientsRequest, ...) *AzureClientIterator
- func (c *AzureClustersClient) ListAzureClusters(ctx context.Context, req *gkemulticloudpb.ListAzureClustersRequest, ...) *AzureClusterIterator
- func (c *AzureClustersClient) ListAzureNodePools(ctx context.Context, req *gkemulticloudpb.ListAzureNodePoolsRequest, ...) *AzureNodePoolIterator
- func (c *AzureClustersClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *AzureClustersClient) UpdateAzureCluster(ctx context.Context, req *gkemulticloudpb.UpdateAzureClusterRequest, ...) (*UpdateAzureClusterOperation, error)
- func (c *AzureClustersClient) UpdateAzureClusterOperation(name string) *UpdateAzureClusterOperation
- func (c *AzureClustersClient) UpdateAzureNodePool(ctx context.Context, req *gkemulticloudpb.UpdateAzureNodePoolRequest, ...) (*UpdateAzureNodePoolOperation, error)
- func (c *AzureClustersClient) UpdateAzureNodePoolOperation(name string) *UpdateAzureNodePoolOperation
- type AzureNodePoolIterator
- type CreateAttachedClusterOperation
- func (op *CreateAttachedClusterOperation) Done() bool
- func (op *CreateAttachedClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *CreateAttachedClusterOperation) Name() string
- func (op *CreateAttachedClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
- func (op *CreateAttachedClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
- type CreateAwsClusterOperation
- func (op *CreateAwsClusterOperation) Done() bool
- func (op *CreateAwsClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *CreateAwsClusterOperation) Name() string
- func (op *CreateAwsClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsCluster, error)
- func (op *CreateAwsClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsCluster, error)
- type CreateAwsNodePoolOperation
- func (op *CreateAwsNodePoolOperation) Done() bool
- func (op *CreateAwsNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *CreateAwsNodePoolOperation) Name() string
- func (op *CreateAwsNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
- func (op *CreateAwsNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
- type CreateAzureClientOperation
- func (op *CreateAzureClientOperation) Done() bool
- func (op *CreateAzureClientOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *CreateAzureClientOperation) Name() string
- func (op *CreateAzureClientOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureClient, error)
- func (op *CreateAzureClientOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureClient, error)
- type CreateAzureClusterOperation
- func (op *CreateAzureClusterOperation) Done() bool
- func (op *CreateAzureClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *CreateAzureClusterOperation) Name() string
- func (op *CreateAzureClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureCluster, error)
- func (op *CreateAzureClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureCluster, error)
- type CreateAzureNodePoolOperation
- func (op *CreateAzureNodePoolOperation) Done() bool
- func (op *CreateAzureNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *CreateAzureNodePoolOperation) Name() string
- func (op *CreateAzureNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureNodePool, error)
- func (op *CreateAzureNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureNodePool, error)
- type DeleteAttachedClusterOperation
- func (op *DeleteAttachedClusterOperation) Done() bool
- func (op *DeleteAttachedClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *DeleteAttachedClusterOperation) Name() string
- func (op *DeleteAttachedClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteAttachedClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteAwsClusterOperation
- func (op *DeleteAwsClusterOperation) Done() bool
- func (op *DeleteAwsClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *DeleteAwsClusterOperation) Name() string
- func (op *DeleteAwsClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteAwsClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteAwsNodePoolOperation
- func (op *DeleteAwsNodePoolOperation) Done() bool
- func (op *DeleteAwsNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *DeleteAwsNodePoolOperation) Name() string
- func (op *DeleteAwsNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteAwsNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteAzureClientOperation
- func (op *DeleteAzureClientOperation) Done() bool
- func (op *DeleteAzureClientOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *DeleteAzureClientOperation) Name() string
- func (op *DeleteAzureClientOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteAzureClientOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteAzureClusterOperation
- func (op *DeleteAzureClusterOperation) Done() bool
- func (op *DeleteAzureClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *DeleteAzureClusterOperation) Name() string
- func (op *DeleteAzureClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteAzureClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteAzureNodePoolOperation
- func (op *DeleteAzureNodePoolOperation) Done() bool
- func (op *DeleteAzureNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *DeleteAzureNodePoolOperation) Name() string
- func (op *DeleteAzureNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteAzureNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type ImportAttachedClusterOperation
- func (op *ImportAttachedClusterOperation) Done() bool
- func (op *ImportAttachedClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *ImportAttachedClusterOperation) Name() string
- func (op *ImportAttachedClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
- func (op *ImportAttachedClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
- type OperationIterator
- type RollbackAwsNodePoolUpdateOperation
- func (op *RollbackAwsNodePoolUpdateOperation) Done() bool
- func (op *RollbackAwsNodePoolUpdateOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *RollbackAwsNodePoolUpdateOperation) Name() string
- func (op *RollbackAwsNodePoolUpdateOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
- func (op *RollbackAwsNodePoolUpdateOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
- type UpdateAttachedClusterOperation
- func (op *UpdateAttachedClusterOperation) Done() bool
- func (op *UpdateAttachedClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *UpdateAttachedClusterOperation) Name() string
- func (op *UpdateAttachedClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
- func (op *UpdateAttachedClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
- type UpdateAwsClusterOperation
- func (op *UpdateAwsClusterOperation) Done() bool
- func (op *UpdateAwsClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *UpdateAwsClusterOperation) Name() string
- func (op *UpdateAwsClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsCluster, error)
- func (op *UpdateAwsClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsCluster, error)
- type UpdateAwsNodePoolOperation
- func (op *UpdateAwsNodePoolOperation) Done() bool
- func (op *UpdateAwsNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *UpdateAwsNodePoolOperation) Name() string
- func (op *UpdateAwsNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
- func (op *UpdateAwsNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
- type UpdateAzureClusterOperation
- func (op *UpdateAzureClusterOperation) Done() bool
- func (op *UpdateAzureClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *UpdateAzureClusterOperation) Name() string
- func (op *UpdateAzureClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureCluster, error)
- func (op *UpdateAzureClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureCluster, error)
- type UpdateAzureNodePoolOperation
- func (op *UpdateAzureNodePoolOperation) Done() bool
- func (op *UpdateAzureNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
- func (op *UpdateAzureNodePoolOperation) Name() string
- func (op *UpdateAzureNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureNodePool, error)
- func (op *UpdateAzureNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureNodePool, error)
Examples ¶
- AttachedClustersClient.CancelOperation
- AttachedClustersClient.CreateAttachedCluster
- AttachedClustersClient.DeleteAttachedCluster
- AttachedClustersClient.DeleteOperation
- AttachedClustersClient.GenerateAttachedClusterAgentToken
- AttachedClustersClient.GenerateAttachedClusterInstallManifest
- AttachedClustersClient.GetAttachedCluster
- AttachedClustersClient.GetAttachedServerConfig
- AttachedClustersClient.GetOperation
- AttachedClustersClient.ImportAttachedCluster
- AttachedClustersClient.ListAttachedClusters
- AttachedClustersClient.ListAttachedClusters (All)
- AttachedClustersClient.ListOperations
- AttachedClustersClient.ListOperations (All)
- AttachedClustersClient.UpdateAttachedCluster
- AwsClustersClient.CancelOperation
- AwsClustersClient.CreateAwsCluster
- AwsClustersClient.CreateAwsNodePool
- AwsClustersClient.DeleteAwsCluster
- AwsClustersClient.DeleteAwsNodePool
- AwsClustersClient.DeleteOperation
- AwsClustersClient.GenerateAwsAccessToken
- AwsClustersClient.GenerateAwsClusterAgentToken
- AwsClustersClient.GetAwsCluster
- AwsClustersClient.GetAwsJsonWebKeys
- AwsClustersClient.GetAwsNodePool
- AwsClustersClient.GetAwsOpenIdConfig
- AwsClustersClient.GetAwsServerConfig
- AwsClustersClient.GetOperation
- AwsClustersClient.ListAwsClusters
- AwsClustersClient.ListAwsClusters (All)
- AwsClustersClient.ListAwsNodePools
- AwsClustersClient.ListAwsNodePools (All)
- AwsClustersClient.ListOperations
- AwsClustersClient.ListOperations (All)
- AwsClustersClient.RollbackAwsNodePoolUpdate
- AwsClustersClient.UpdateAwsCluster
- AwsClustersClient.UpdateAwsNodePool
- AzureClustersClient.CancelOperation
- AzureClustersClient.CreateAzureClient
- AzureClustersClient.CreateAzureCluster
- AzureClustersClient.CreateAzureNodePool
- AzureClustersClient.DeleteAzureClient
- AzureClustersClient.DeleteAzureCluster
- AzureClustersClient.DeleteAzureNodePool
- AzureClustersClient.DeleteOperation
- AzureClustersClient.GenerateAzureAccessToken
- AzureClustersClient.GenerateAzureClusterAgentToken
- AzureClustersClient.GetAzureClient
- AzureClustersClient.GetAzureCluster
- AzureClustersClient.GetAzureJsonWebKeys
- AzureClustersClient.GetAzureNodePool
- AzureClustersClient.GetAzureOpenIdConfig
- AzureClustersClient.GetAzureServerConfig
- AzureClustersClient.GetOperation
- AzureClustersClient.ListAzureClients
- AzureClustersClient.ListAzureClients (All)
- AzureClustersClient.ListAzureClusters
- AzureClustersClient.ListAzureClusters (All)
- AzureClustersClient.ListAzureNodePools
- AzureClustersClient.ListAzureNodePools (All)
- AzureClustersClient.ListOperations
- AzureClustersClient.ListOperations (All)
- AzureClustersClient.UpdateAzureCluster
- AzureClustersClient.UpdateAzureNodePool
- NewAttachedClustersClient
- NewAwsClustersClient
- NewAzureClustersClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type AttachedClusterIterator ¶ added in v0.5.0
type AttachedClusterIterator 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.AttachedCluster, nextPageToken string, err error) // contains filtered or unexported fields }
AttachedClusterIterator manages a stream of *gkemulticloudpb.AttachedCluster.
func (*AttachedClusterIterator) All ¶ added in v1.3.1
func (it *AttachedClusterIterator) All() iter.Seq2[*gkemulticloudpb.AttachedCluster, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AttachedClusterIterator) Next ¶ added in v0.5.0
func (it *AttachedClusterIterator) Next() (*gkemulticloudpb.AttachedCluster, 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 (*AttachedClusterIterator) PageInfo ¶ added in v0.5.0
func (it *AttachedClusterIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type AttachedClustersCallOptions ¶ added in v0.5.0
type AttachedClustersCallOptions struct { CreateAttachedCluster []gax.CallOption UpdateAttachedCluster []gax.CallOption ImportAttachedCluster []gax.CallOption GetAttachedCluster []gax.CallOption ListAttachedClusters []gax.CallOption DeleteAttachedCluster []gax.CallOption GetAttachedServerConfig []gax.CallOption GenerateAttachedClusterInstallManifest []gax.CallOption GenerateAttachedClusterAgentToken []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
AttachedClustersCallOptions contains the retry settings for each method of AttachedClustersClient.
type AttachedClustersClient ¶ added in v0.5.0
type AttachedClustersClient struct { // The call options for this service. CallOptions *AttachedClustersCallOptions // 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 }
AttachedClustersClient is a client for interacting with GKE Multi-Cloud API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The AttachedClusters API provides a single centrally managed service to register and manage Anthos attached clusters that run on customer’s owned infrastructure.
func NewAttachedClustersClient ¶ added in v0.5.0
func NewAttachedClustersClient(ctx context.Context, opts ...option.ClientOption) (*AttachedClustersClient, error)
NewAttachedClustersClient creates a new attached clusters client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The AttachedClusters API provides a single centrally managed service to register and manage Anthos attached clusters that run on customer’s owned infrastructure.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*AttachedClustersClient) CancelOperation ¶ added in v0.5.0
func (c *AttachedClustersClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*AttachedClustersClient) Close ¶ added in v0.5.0
func (c *AttachedClustersClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*AttachedClustersClient) Connection
deprecated
added in
v0.5.0
func (c *AttachedClustersClient) 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 (*AttachedClustersClient) CreateAttachedCluster ¶ added in v0.5.0
func (c *AttachedClustersClient) CreateAttachedCluster(ctx context.Context, req *gkemulticloudpb.CreateAttachedClusterRequest, opts ...gax.CallOption) (*CreateAttachedClusterOperation, error)
CreateAttachedCluster creates a new AttachedCluster resource on a given Google Cloud Platform 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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.CreateAttachedClusterRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#CreateAttachedClusterRequest. } op, err := c.CreateAttachedCluster(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AttachedClustersClient) CreateAttachedClusterOperation ¶ added in v0.5.0
func (c *AttachedClustersClient) CreateAttachedClusterOperation(name string) *CreateAttachedClusterOperation
CreateAttachedClusterOperation returns a new CreateAttachedClusterOperation from a given name. The name must be that of a previously created CreateAttachedClusterOperation, possibly from a different process.
func (*AttachedClustersClient) DeleteAttachedCluster ¶ added in v0.5.0
func (c *AttachedClustersClient) DeleteAttachedCluster(ctx context.Context, req *gkemulticloudpb.DeleteAttachedClusterRequest, opts ...gax.CallOption) (*DeleteAttachedClusterOperation, error)
DeleteAttachedCluster deletes a specific AttachedCluster 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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.DeleteAttachedClusterRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#DeleteAttachedClusterRequest. } op, err := c.DeleteAttachedCluster(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*AttachedClustersClient) DeleteAttachedClusterOperation ¶ added in v0.5.0
func (c *AttachedClustersClient) DeleteAttachedClusterOperation(name string) *DeleteAttachedClusterOperation
DeleteAttachedClusterOperation returns a new DeleteAttachedClusterOperation from a given name. The name must be that of a previously created DeleteAttachedClusterOperation, possibly from a different process.
func (*AttachedClustersClient) DeleteOperation ¶ added in v0.5.0
func (c *AttachedClustersClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*AttachedClustersClient) GenerateAttachedClusterAgentToken ¶ added in v1.1.0
func (c *AttachedClustersClient) GenerateAttachedClusterAgentToken(ctx context.Context, req *gkemulticloudpb.GenerateAttachedClusterAgentTokenRequest, opts ...gax.CallOption) (*gkemulticloudpb.GenerateAttachedClusterAgentTokenResponse, error)
GenerateAttachedClusterAgentToken generates an access token for a cluster agent.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.GenerateAttachedClusterAgentTokenRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GenerateAttachedClusterAgentTokenRequest. } resp, err := c.GenerateAttachedClusterAgentToken(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AttachedClustersClient) GenerateAttachedClusterInstallManifest ¶ added in v0.5.0
func (c *AttachedClustersClient) GenerateAttachedClusterInstallManifest(ctx context.Context, req *gkemulticloudpb.GenerateAttachedClusterInstallManifestRequest, opts ...gax.CallOption) (*gkemulticloudpb.GenerateAttachedClusterInstallManifestResponse, error)
GenerateAttachedClusterInstallManifest generates the install manifest to be installed on the target cluster.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.GenerateAttachedClusterInstallManifestRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GenerateAttachedClusterInstallManifestRequest. } resp, err := c.GenerateAttachedClusterInstallManifest(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AttachedClustersClient) GetAttachedCluster ¶ added in v0.5.0
func (c *AttachedClustersClient) GetAttachedCluster(ctx context.Context, req *gkemulticloudpb.GetAttachedClusterRequest, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
GetAttachedCluster describes a specific AttachedCluster resource.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.GetAttachedClusterRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAttachedClusterRequest. } resp, err := c.GetAttachedCluster(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AttachedClustersClient) GetAttachedServerConfig ¶ added in v0.5.0
func (c *AttachedClustersClient) GetAttachedServerConfig(ctx context.Context, req *gkemulticloudpb.GetAttachedServerConfigRequest, opts ...gax.CallOption) (*gkemulticloudpb.AttachedServerConfig, error)
GetAttachedServerConfig returns information, such as supported Kubernetes versions, on a given Google Cloud location.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.GetAttachedServerConfigRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAttachedServerConfigRequest. } resp, err := c.GetAttachedServerConfig(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AttachedClustersClient) GetOperation ¶ added in v0.5.0
func (c *AttachedClustersClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AttachedClustersClient) ImportAttachedCluster ¶ added in v0.5.0
func (c *AttachedClustersClient) ImportAttachedCluster(ctx context.Context, req *gkemulticloudpb.ImportAttachedClusterRequest, opts ...gax.CallOption) (*ImportAttachedClusterOperation, error)
ImportAttachedCluster imports creates a new AttachedCluster resource by importing an existing Fleet Membership resource.
Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.
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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.ImportAttachedClusterRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#ImportAttachedClusterRequest. } op, err := c.ImportAttachedCluster(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AttachedClustersClient) ImportAttachedClusterOperation ¶ added in v0.5.0
func (c *AttachedClustersClient) ImportAttachedClusterOperation(name string) *ImportAttachedClusterOperation
ImportAttachedClusterOperation returns a new ImportAttachedClusterOperation from a given name. The name must be that of a previously created ImportAttachedClusterOperation, possibly from a different process.
func (*AttachedClustersClient) ListAttachedClusters ¶ added in v0.5.0
func (c *AttachedClustersClient) ListAttachedClusters(ctx context.Context, req *gkemulticloudpb.ListAttachedClustersRequest, opts ...gax.CallOption) *AttachedClusterIterator
ListAttachedClusters lists all AttachedCluster resources on a given Google Cloud project and region.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" "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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.ListAttachedClustersRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#ListAttachedClustersRequest. } it := c.ListAttachedClusters(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.(*gkemulticloudpb.ListAttachedClustersResponse) } }
Output:
Example (All) ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.ListAttachedClustersRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#ListAttachedClustersRequest. } for resp, err := range c.ListAttachedClusters(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*AttachedClustersClient) ListOperations ¶ added in v0.5.0
func (c *AttachedClustersClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(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.(*longrunningpb.ListOperationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } for resp, err := range c.ListOperations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*AttachedClustersClient) UpdateAttachedCluster ¶ added in v0.5.0
func (c *AttachedClustersClient) UpdateAttachedCluster(ctx context.Context, req *gkemulticloudpb.UpdateAttachedClusterRequest, opts ...gax.CallOption) (*UpdateAttachedClusterOperation, error)
UpdateAttachedCluster updates an AttachedCluster.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAttachedClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.UpdateAttachedClusterRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#UpdateAttachedClusterRequest. } op, err := c.UpdateAttachedCluster(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AttachedClustersClient) UpdateAttachedClusterOperation ¶ added in v0.5.0
func (c *AttachedClustersClient) UpdateAttachedClusterOperation(name string) *UpdateAttachedClusterOperation
UpdateAttachedClusterOperation returns a new UpdateAttachedClusterOperation from a given name. The name must be that of a previously created UpdateAttachedClusterOperation, possibly from a different process.
type 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) All ¶ added in v1.3.1
func (it *AwsClusterIterator) All() iter.Seq2[*gkemulticloudpb.AwsCluster, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AwsClusterIterator) Next ¶
func (it *AwsClusterIterator) Next() (*gkemulticloudpb.AwsCluster, 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 (*AwsClusterIterator) PageInfo ¶
func (it *AwsClusterIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type AwsClustersCallOptions ¶
type AwsClustersCallOptions struct { CreateAwsCluster []gax.CallOption UpdateAwsCluster []gax.CallOption GetAwsCluster []gax.CallOption ListAwsClusters []gax.CallOption DeleteAwsCluster []gax.CallOption GenerateAwsClusterAgentToken []gax.CallOption GenerateAwsAccessToken []gax.CallOption CreateAwsNodePool []gax.CallOption UpdateAwsNodePool []gax.CallOption RollbackAwsNodePoolUpdate []gax.CallOption GetAwsNodePool []gax.CallOption ListAwsNodePools []gax.CallOption DeleteAwsNodePool []gax.CallOption GetAwsOpenIdConfig []gax.CallOption GetAwsJsonWebKeys []gax.CallOption GetAwsServerConfig []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
AwsClustersCallOptions contains the retry settings for each method of AwsClustersClient.
type 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 GKE 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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/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 := gkemulticloud.NewAwsClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*AwsClustersClient) CancelOperation ¶ added in v0.5.0
func (c *AwsClustersClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAwsClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
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
deprecated
func (c *AwsClustersClient) 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 (*AwsClustersClient) CreateAwsCluster ¶
func (c *AwsClustersClient) CreateAwsCluster(ctx context.Context, req *gkemulticloudpb.CreateAwsClusterRequest, opts ...gax.CallOption) (*CreateAwsClusterOperation, error)
CreateAwsCluster creates a new AwsCluster resource on a given Google Cloud Platform 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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 }
Output:
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 ¶
func (c *AwsClustersClient) CreateAwsNodePool(ctx context.Context, req *gkemulticloudpb.CreateAwsNodePoolRequest, opts ...gax.CallOption) (*CreateAwsNodePoolOperation, error)
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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 }
Output:
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 ¶
func (c *AwsClustersClient) DeleteAwsCluster(ctx context.Context, req *gkemulticloudpb.DeleteAwsClusterRequest, opts ...gax.CallOption) (*DeleteAwsClusterOperation, error)
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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#DeleteAwsClusterRequest. } op, err := c.DeleteAwsCluster(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
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 ¶
func (c *AwsClustersClient) DeleteAwsNodePool(ctx context.Context, req *gkemulticloudpb.DeleteAwsNodePoolRequest, opts ...gax.CallOption) (*DeleteAwsNodePoolOperation, error)
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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#DeleteAwsNodePoolRequest. } op, err := c.DeleteAwsNodePool(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
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) DeleteOperation ¶ added in v0.5.0
func (c *AwsClustersClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAwsClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*AwsClustersClient) GenerateAwsAccessToken ¶
func (c *AwsClustersClient) GenerateAwsAccessToken(ctx context.Context, req *gkemulticloudpb.GenerateAwsAccessTokenRequest, opts ...gax.CallOption) (*gkemulticloudpb.GenerateAwsAccessTokenResponse, error)
GenerateAwsAccessToken generates a short-lived access token to authenticate to a given AwsCluster resource.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GenerateAwsAccessTokenRequest. } resp, err := c.GenerateAwsAccessToken(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AwsClustersClient) GenerateAwsClusterAgentToken ¶ added in v1.1.0
func (c *AwsClustersClient) GenerateAwsClusterAgentToken(ctx context.Context, req *gkemulticloudpb.GenerateAwsClusterAgentTokenRequest, opts ...gax.CallOption) (*gkemulticloudpb.GenerateAwsClusterAgentTokenResponse, error)
GenerateAwsClusterAgentToken generates an access token for a cluster agent.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAwsClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.GenerateAwsClusterAgentTokenRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GenerateAwsClusterAgentTokenRequest. } resp, err := c.GenerateAwsClusterAgentToken(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AwsClustersClient) GetAwsCluster ¶
func (c *AwsClustersClient) GetAwsCluster(ctx context.Context, req *gkemulticloudpb.GetAwsClusterRequest, opts ...gax.CallOption) (*gkemulticloudpb.AwsCluster, error)
GetAwsCluster describes a specific AwsCluster resource.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAwsClusterRequest. } resp, err := c.GetAwsCluster(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AwsClustersClient) GetAwsJsonWebKeys ¶ added in v1.1.0
func (c *AwsClustersClient) GetAwsJsonWebKeys(ctx context.Context, req *gkemulticloudpb.GetAwsJsonWebKeysRequest, opts ...gax.CallOption) (*gkemulticloudpb.AwsJsonWebKeys, error)
GetAwsJsonWebKeys gets the public component of the cluster signing keys in JSON Web Key format.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAwsClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.GetAwsJsonWebKeysRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAwsJsonWebKeysRequest. } resp, err := c.GetAwsJsonWebKeys(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AwsClustersClient) GetAwsNodePool ¶
func (c *AwsClustersClient) GetAwsNodePool(ctx context.Context, req *gkemulticloudpb.GetAwsNodePoolRequest, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
GetAwsNodePool describes a specific AwsNodePool resource.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAwsNodePoolRequest. } resp, err := c.GetAwsNodePool(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AwsClustersClient) GetAwsOpenIdConfig ¶ added in v1.1.0
func (c *AwsClustersClient) GetAwsOpenIdConfig(ctx context.Context, req *gkemulticloudpb.GetAwsOpenIdConfigRequest, opts ...gax.CallOption) (*gkemulticloudpb.AwsOpenIdConfig, error)
GetAwsOpenIdConfig gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification (at https://openid.net/specs/openid-connect-discovery-1_0.html) for details.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAwsClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.GetAwsOpenIdConfigRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAwsOpenIdConfigRequest. } resp, err := c.GetAwsOpenIdConfig(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AwsClustersClient) GetAwsServerConfig ¶
func (c *AwsClustersClient) GetAwsServerConfig(ctx context.Context, req *gkemulticloudpb.GetAwsServerConfigRequest, opts ...gax.CallOption) (*gkemulticloudpb.AwsServerConfig, error)
GetAwsServerConfig returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAwsServerConfigRequest. } resp, err := c.GetAwsServerConfig(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AwsClustersClient) GetOperation ¶ added in v0.5.0
func (c *AwsClustersClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAwsClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AwsClustersClient) ListAwsClusters ¶
func (c *AwsClustersClient) ListAwsClusters(ctx context.Context, req *gkemulticloudpb.ListAwsClustersRequest, opts ...gax.CallOption) *AwsClusterIterator
ListAwsClusters lists all AwsCluster resources on a given Google Cloud project and region.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" "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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 // 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.(*gkemulticloudpb.ListAwsClustersResponse) } }
Output:
Example (All) ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#ListAwsClustersRequest. } for resp, err := range c.ListAwsClusters(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*AwsClustersClient) ListAwsNodePools ¶
func (c *AwsClustersClient) ListAwsNodePools(ctx context.Context, req *gkemulticloudpb.ListAwsNodePoolsRequest, opts ...gax.CallOption) *AwsNodePoolIterator
ListAwsNodePools lists all AwsNodePool resources on a given AwsCluster.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" "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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 // 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.(*gkemulticloudpb.ListAwsNodePoolsResponse) } }
Output:
Example (All) ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#ListAwsNodePoolsRequest. } for resp, err := range c.ListAwsNodePools(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*AwsClustersClient) ListOperations ¶ added in v0.5.0
func (c *AwsClustersClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "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 := gkemulticloud.NewAwsClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(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.(*longrunningpb.ListOperationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAwsClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } for resp, err := range c.ListOperations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*AwsClustersClient) RollbackAwsNodePoolUpdate ¶ added in v1.1.0
func (c *AwsClustersClient) RollbackAwsNodePoolUpdate(ctx context.Context, req *gkemulticloudpb.RollbackAwsNodePoolUpdateRequest, opts ...gax.CallOption) (*RollbackAwsNodePoolUpdateOperation, error)
RollbackAwsNodePoolUpdate rolls back a previously aborted or failed AwsNodePool update request. Makes no changes if the last update request successfully finished. If an update request is in progress, you cannot rollback the update. You must first cancel or let it finish unsuccessfully before you can rollback.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAwsClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.RollbackAwsNodePoolUpdateRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#RollbackAwsNodePoolUpdateRequest. } op, err := c.RollbackAwsNodePoolUpdate(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AwsClustersClient) RollbackAwsNodePoolUpdateOperation ¶ added in v1.1.0
func (c *AwsClustersClient) RollbackAwsNodePoolUpdateOperation(name string) *RollbackAwsNodePoolUpdateOperation
RollbackAwsNodePoolUpdateOperation returns a new RollbackAwsNodePoolUpdateOperation from a given name. The name must be that of a previously created RollbackAwsNodePoolUpdateOperation, possibly from a different process.
func (*AwsClustersClient) UpdateAwsCluster ¶
func (c *AwsClustersClient) UpdateAwsCluster(ctx context.Context, req *gkemulticloudpb.UpdateAwsClusterRequest, opts ...gax.CallOption) (*UpdateAwsClusterOperation, error)
UpdateAwsCluster updates an AwsCluster.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 }
Output:
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 ¶
func (c *AwsClustersClient) UpdateAwsNodePool(ctx context.Context, req *gkemulticloudpb.UpdateAwsNodePoolRequest, opts ...gax.CallOption) (*UpdateAwsNodePoolOperation, error)
UpdateAwsNodePool updates an AwsNodePool.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 }
Output:
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.
type 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) All ¶ added in v1.3.1
func (it *AwsNodePoolIterator) All() iter.Seq2[*gkemulticloudpb.AwsNodePool, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AwsNodePoolIterator) Next ¶
func (it *AwsNodePoolIterator) Next() (*gkemulticloudpb.AwsNodePool, 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 (*AwsNodePoolIterator) PageInfo ¶
func (it *AwsNodePoolIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type 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) All ¶ added in v1.3.1
func (it *AzureClientIterator) All() iter.Seq2[*gkemulticloudpb.AzureClient, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AzureClientIterator) Next ¶
func (it *AzureClientIterator) Next() (*gkemulticloudpb.AzureClient, 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 (*AzureClientIterator) PageInfo ¶
func (it *AzureClientIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type 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) All ¶ added in v1.3.1
func (it *AzureClusterIterator) All() iter.Seq2[*gkemulticloudpb.AzureCluster, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AzureClusterIterator) Next ¶
func (it *AzureClusterIterator) Next() (*gkemulticloudpb.AzureCluster, 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 (*AzureClusterIterator) PageInfo ¶
func (it *AzureClusterIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type 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 GenerateAzureClusterAgentToken []gax.CallOption GenerateAzureAccessToken []gax.CallOption CreateAzureNodePool []gax.CallOption UpdateAzureNodePool []gax.CallOption GetAzureNodePool []gax.CallOption ListAzureNodePools []gax.CallOption DeleteAzureNodePool []gax.CallOption GetAzureOpenIdConfig []gax.CallOption GetAzureJsonWebKeys []gax.CallOption GetAzureServerConfig []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
AzureClustersCallOptions contains the retry settings for each method of AzureClustersClient.
type 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 GKE 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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/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 := gkemulticloud.NewAzureClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*AzureClustersClient) CancelOperation ¶ added in v0.5.0
func (c *AzureClustersClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAzureClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
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
deprecated
func (c *AzureClustersClient) 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 (*AzureClustersClient) CreateAzureClient ¶
func (c *AzureClustersClient) CreateAzureClient(ctx context.Context, req *gkemulticloudpb.CreateAzureClientRequest, opts ...gax.CallOption) (*CreateAzureClientOperation, error)
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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 }
Output:
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 ¶
func (c *AzureClustersClient) CreateAzureCluster(ctx context.Context, req *gkemulticloudpb.CreateAzureClusterRequest, opts ...gax.CallOption) (*CreateAzureClusterOperation, error)
CreateAzureCluster creates a new AzureCluster resource on a given Google Cloud Platform 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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 }
Output:
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 ¶
func (c *AzureClustersClient) CreateAzureNodePool(ctx context.Context, req *gkemulticloudpb.CreateAzureNodePoolRequest, opts ...gax.CallOption) (*CreateAzureNodePoolOperation, error)
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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 }
Output:
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 ¶
func (c *AzureClustersClient) DeleteAzureClient(ctx context.Context, req *gkemulticloudpb.DeleteAzureClientRequest, opts ...gax.CallOption) (*DeleteAzureClientOperation, error)
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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#DeleteAzureClientRequest. } op, err := c.DeleteAzureClient(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
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 ¶
func (c *AzureClustersClient) DeleteAzureCluster(ctx context.Context, req *gkemulticloudpb.DeleteAzureClusterRequest, opts ...gax.CallOption) (*DeleteAzureClusterOperation, error)
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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#DeleteAzureClusterRequest. } op, err := c.DeleteAzureCluster(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
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 ¶
func (c *AzureClustersClient) DeleteAzureNodePool(ctx context.Context, req *gkemulticloudpb.DeleteAzureNodePoolRequest, opts ...gax.CallOption) (*DeleteAzureNodePoolOperation, error)
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 ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#DeleteAzureNodePoolRequest. } op, err := c.DeleteAzureNodePool(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
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) DeleteOperation ¶ added in v0.5.0
func (c *AzureClustersClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAzureClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*AzureClustersClient) GenerateAzureAccessToken ¶
func (c *AzureClustersClient) GenerateAzureAccessToken(ctx context.Context, req *gkemulticloudpb.GenerateAzureAccessTokenRequest, opts ...gax.CallOption) (*gkemulticloudpb.GenerateAzureAccessTokenResponse, error)
GenerateAzureAccessToken generates a short-lived access token to authenticate to a given AzureCluster resource.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GenerateAzureAccessTokenRequest. } resp, err := c.GenerateAzureAccessToken(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AzureClustersClient) GenerateAzureClusterAgentToken ¶ added in v1.1.0
func (c *AzureClustersClient) GenerateAzureClusterAgentToken(ctx context.Context, req *gkemulticloudpb.GenerateAzureClusterAgentTokenRequest, opts ...gax.CallOption) (*gkemulticloudpb.GenerateAzureClusterAgentTokenResponse, error)
GenerateAzureClusterAgentToken generates an access token for a cluster agent.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAzureClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.GenerateAzureClusterAgentTokenRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GenerateAzureClusterAgentTokenRequest. } resp, err := c.GenerateAzureClusterAgentToken(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AzureClustersClient) GetAzureClient ¶
func (c *AzureClustersClient) GetAzureClient(ctx context.Context, req *gkemulticloudpb.GetAzureClientRequest, opts ...gax.CallOption) (*gkemulticloudpb.AzureClient, error)
GetAzureClient describes a specific AzureClient resource.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAzureClientRequest. } resp, err := c.GetAzureClient(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AzureClustersClient) GetAzureCluster ¶
func (c *AzureClustersClient) GetAzureCluster(ctx context.Context, req *gkemulticloudpb.GetAzureClusterRequest, opts ...gax.CallOption) (*gkemulticloudpb.AzureCluster, error)
GetAzureCluster describes a specific AzureCluster resource.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAzureClusterRequest. } resp, err := c.GetAzureCluster(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AzureClustersClient) GetAzureJsonWebKeys ¶ added in v1.1.0
func (c *AzureClustersClient) GetAzureJsonWebKeys(ctx context.Context, req *gkemulticloudpb.GetAzureJsonWebKeysRequest, opts ...gax.CallOption) (*gkemulticloudpb.AzureJsonWebKeys, error)
GetAzureJsonWebKeys gets the public component of the cluster signing keys in JSON Web Key format.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAzureClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.GetAzureJsonWebKeysRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAzureJsonWebKeysRequest. } resp, err := c.GetAzureJsonWebKeys(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AzureClustersClient) GetAzureNodePool ¶
func (c *AzureClustersClient) GetAzureNodePool(ctx context.Context, req *gkemulticloudpb.GetAzureNodePoolRequest, opts ...gax.CallOption) (*gkemulticloudpb.AzureNodePool, error)
GetAzureNodePool describes a specific AzureNodePool resource.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAzureNodePoolRequest. } resp, err := c.GetAzureNodePool(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AzureClustersClient) GetAzureOpenIdConfig ¶ added in v1.1.0
func (c *AzureClustersClient) GetAzureOpenIdConfig(ctx context.Context, req *gkemulticloudpb.GetAzureOpenIdConfigRequest, opts ...gax.CallOption) (*gkemulticloudpb.AzureOpenIdConfig, error)
GetAzureOpenIdConfig gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification (at https://openid.net/specs/openid-connect-discovery-1_0.html) for details.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := gkemulticloud.NewAzureClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &gkemulticloudpb.GetAzureOpenIdConfigRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAzureOpenIdConfigRequest. } resp, err := c.GetAzureOpenIdConfig(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AzureClustersClient) GetAzureServerConfig ¶
func (c *AzureClustersClient) GetAzureServerConfig(ctx context.Context, req *gkemulticloudpb.GetAzureServerConfigRequest, opts ...gax.CallOption) (*gkemulticloudpb.AzureServerConfig, error)
GetAzureServerConfig returns information, such as supported Azure regions and Kubernetes versions, on a given Google Cloud location.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#GetAzureServerConfigRequest. } resp, err := c.GetAzureServerConfig(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AzureClustersClient) GetOperation ¶ added in v0.5.0
func (c *AzureClustersClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAzureClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*AzureClustersClient) ListAzureClients ¶
func (c *AzureClustersClient) ListAzureClients(ctx context.Context, req *gkemulticloudpb.ListAzureClientsRequest, opts ...gax.CallOption) *AzureClientIterator
ListAzureClients lists all AzureClient resources on a given Google Cloud project and region.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" "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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 // 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.(*gkemulticloudpb.ListAzureClientsResponse) } }
Output:
Example (All) ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#ListAzureClientsRequest. } for resp, err := range c.ListAzureClients(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*AzureClustersClient) ListAzureClusters ¶
func (c *AzureClustersClient) ListAzureClusters(ctx context.Context, req *gkemulticloudpb.ListAzureClustersRequest, opts ...gax.CallOption) *AzureClusterIterator
ListAzureClusters lists all AzureCluster resources on a given Google Cloud project and region.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" "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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 // 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.(*gkemulticloudpb.ListAzureClustersResponse) } }
Output:
Example (All) ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#ListAzureClustersRequest. } for resp, err := range c.ListAzureClusters(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*AzureClustersClient) ListAzureNodePools ¶
func (c *AzureClustersClient) ListAzureNodePools(ctx context.Context, req *gkemulticloudpb.ListAzureNodePoolsRequest, opts ...gax.CallOption) *AzureNodePoolIterator
ListAzureNodePools lists all AzureNodePool resources on a given AzureCluster.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" "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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 // 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.(*gkemulticloudpb.ListAzureNodePoolsResponse) } }
Output:
Example (All) ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#ListAzureNodePoolsRequest. } for resp, err := range c.ListAzureNodePools(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*AzureClustersClient) ListOperations ¶ added in v0.5.0
func (c *AzureClustersClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "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 := gkemulticloud.NewAzureClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(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.(*longrunningpb.ListOperationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := gkemulticloud.NewAzureClustersClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } for resp, err := range c.ListOperations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*AzureClustersClient) UpdateAzureCluster ¶
func (c *AzureClustersClient) UpdateAzureCluster(ctx context.Context, req *gkemulticloudpb.UpdateAzureClusterRequest, opts ...gax.CallOption) (*UpdateAzureClusterOperation, error)
UpdateAzureCluster updates an AzureCluster.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 }
Output:
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 ¶
func (c *AzureClustersClient) UpdateAzureNodePool(ctx context.Context, req *gkemulticloudpb.UpdateAzureNodePoolRequest, opts ...gax.CallOption) (*UpdateAzureNodePoolOperation, error)
UpdateAzureNodePool updates an AzureNodePool.
Example ¶
package main import ( "context" gkemulticloud "cloud.google.com/go/gkemulticloud/apiv1" gkemulticloudpb "cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb" ) 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 := 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/cloud.google.com/go/gkemulticloud/apiv1/gkemulticloudpb#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 }
Output:
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.
type 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) All ¶ added in v1.3.1
func (it *AzureNodePoolIterator) All() iter.Seq2[*gkemulticloudpb.AzureNodePool, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*AzureNodePoolIterator) Next ¶
func (it *AzureNodePoolIterator) Next() (*gkemulticloudpb.AzureNodePool, 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 (*AzureNodePoolIterator) PageInfo ¶
func (it *AzureNodePoolIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type CreateAttachedClusterOperation ¶ added in v0.5.0
type CreateAttachedClusterOperation struct {
// contains filtered or unexported fields
}
CreateAttachedClusterOperation manages a long-running operation from CreateAttachedCluster.
func (*CreateAttachedClusterOperation) Done ¶ added in v0.5.0
func (op *CreateAttachedClusterOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateAttachedClusterOperation) Metadata ¶ added in v0.5.0
func (op *CreateAttachedClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 (*CreateAttachedClusterOperation) Name ¶ added in v0.5.0
func (op *CreateAttachedClusterOperation) 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 (*CreateAttachedClusterOperation) Poll ¶ added in v0.5.0
func (op *CreateAttachedClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
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 (*CreateAttachedClusterOperation) Wait ¶ added in v0.5.0
func (op *CreateAttachedClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *CreateAwsClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *CreateAwsClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsCluster, error)
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 ¶
func (op *CreateAwsClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsCluster, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *CreateAwsNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *CreateAwsNodePoolOperation) 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 (*CreateAwsNodePoolOperation) Poll ¶
func (op *CreateAwsNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
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 ¶
func (op *CreateAwsNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *CreateAzureClientOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *CreateAzureClientOperation) 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 (*CreateAzureClientOperation) Poll ¶
func (op *CreateAzureClientOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureClient, error)
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 ¶
func (op *CreateAzureClientOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureClient, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *CreateAzureClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *CreateAzureClusterOperation) 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 (*CreateAzureClusterOperation) Poll ¶
func (op *CreateAzureClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureCluster, error)
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 ¶
func (op *CreateAzureClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureCluster, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type CreateAzureNodePoolOperation ¶
type CreateAzureNodePoolOperation struct {
// contains filtered or unexported fields
}
CreateAzureNodePoolOperation manages a long-running operation from CreateAzureNodePool.
func (*CreateAzureNodePoolOperation) Done ¶
func (op *CreateAzureNodePoolOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateAzureNodePoolOperation) Metadata ¶
func (op *CreateAzureNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *CreateAzureNodePoolOperation) 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 (*CreateAzureNodePoolOperation) Poll ¶
func (op *CreateAzureNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureNodePool, error)
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 ¶
func (op *CreateAzureNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureNodePool, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteAttachedClusterOperation ¶ added in v0.5.0
type DeleteAttachedClusterOperation struct {
// contains filtered or unexported fields
}
DeleteAttachedClusterOperation manages a long-running operation from DeleteAttachedCluster.
func (*DeleteAttachedClusterOperation) Done ¶ added in v0.5.0
func (op *DeleteAttachedClusterOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteAttachedClusterOperation) Metadata ¶ added in v0.5.0
func (op *DeleteAttachedClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 (*DeleteAttachedClusterOperation) Name ¶ added in v0.5.0
func (op *DeleteAttachedClusterOperation) 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 (*DeleteAttachedClusterOperation) Poll ¶ added in v0.5.0
func (op *DeleteAttachedClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
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 (*DeleteAttachedClusterOperation) Wait ¶ added in v0.5.0
func (op *DeleteAttachedClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *DeleteAwsClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *DeleteAwsClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
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 ¶
func (op *DeleteAwsClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *DeleteAwsNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *DeleteAwsNodePoolOperation) 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 (*DeleteAwsNodePoolOperation) Poll ¶
func (op *DeleteAwsNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
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 ¶
func (op *DeleteAwsNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *DeleteAzureClientOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *DeleteAzureClientOperation) 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 (*DeleteAzureClientOperation) Poll ¶
func (op *DeleteAzureClientOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
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 ¶
func (op *DeleteAzureClientOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *DeleteAzureClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *DeleteAzureClusterOperation) 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 (*DeleteAzureClusterOperation) Poll ¶
func (op *DeleteAzureClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
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 ¶
func (op *DeleteAzureClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type DeleteAzureNodePoolOperation ¶
type DeleteAzureNodePoolOperation struct {
// contains filtered or unexported fields
}
DeleteAzureNodePoolOperation manages a long-running operation from DeleteAzureNodePool.
func (*DeleteAzureNodePoolOperation) Done ¶
func (op *DeleteAzureNodePoolOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteAzureNodePoolOperation) Metadata ¶
func (op *DeleteAzureNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *DeleteAzureNodePoolOperation) 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 (*DeleteAzureNodePoolOperation) Poll ¶
func (op *DeleteAzureNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
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 ¶
func (op *DeleteAzureNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type ImportAttachedClusterOperation ¶ added in v0.5.0
type ImportAttachedClusterOperation struct {
// contains filtered or unexported fields
}
ImportAttachedClusterOperation manages a long-running operation from ImportAttachedCluster.
func (*ImportAttachedClusterOperation) Done ¶ added in v0.5.0
func (op *ImportAttachedClusterOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*ImportAttachedClusterOperation) Metadata ¶ added in v0.5.0
func (op *ImportAttachedClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 (*ImportAttachedClusterOperation) Name ¶ added in v0.5.0
func (op *ImportAttachedClusterOperation) 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 (*ImportAttachedClusterOperation) Poll ¶ added in v0.5.0
func (op *ImportAttachedClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
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 (*ImportAttachedClusterOperation) Wait ¶ added in v0.5.0
func (op *ImportAttachedClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type OperationIterator ¶ added in v0.5.0
type OperationIterator 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 []*longrunningpb.Operation, nextPageToken string, err error) // contains filtered or unexported fields }
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All ¶ added in v1.3.1
func (it *OperationIterator) All() iter.Seq2[*longrunningpb.Operation, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*OperationIterator) Next ¶ added in v0.5.0
func (it *OperationIterator) Next() (*longrunningpb.Operation, 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 (*OperationIterator) PageInfo ¶ added in v0.5.0
func (it *OperationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type RollbackAwsNodePoolUpdateOperation ¶ added in v1.1.0
type RollbackAwsNodePoolUpdateOperation struct {
// contains filtered or unexported fields
}
RollbackAwsNodePoolUpdateOperation manages a long-running operation from RollbackAwsNodePoolUpdate.
func (*RollbackAwsNodePoolUpdateOperation) Done ¶ added in v1.1.0
func (op *RollbackAwsNodePoolUpdateOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*RollbackAwsNodePoolUpdateOperation) Metadata ¶ added in v1.1.0
func (op *RollbackAwsNodePoolUpdateOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 (*RollbackAwsNodePoolUpdateOperation) Name ¶ added in v1.1.0
func (op *RollbackAwsNodePoolUpdateOperation) 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 (*RollbackAwsNodePoolUpdateOperation) Poll ¶ added in v1.1.0
func (op *RollbackAwsNodePoolUpdateOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
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 (*RollbackAwsNodePoolUpdateOperation) Wait ¶ added in v1.1.0
func (op *RollbackAwsNodePoolUpdateOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateAttachedClusterOperation ¶ added in v0.5.0
type UpdateAttachedClusterOperation struct {
// contains filtered or unexported fields
}
UpdateAttachedClusterOperation manages a long-running operation from UpdateAttachedCluster.
func (*UpdateAttachedClusterOperation) Done ¶ added in v0.5.0
func (op *UpdateAttachedClusterOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateAttachedClusterOperation) Metadata ¶ added in v0.5.0
func (op *UpdateAttachedClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 (*UpdateAttachedClusterOperation) Name ¶ added in v0.5.0
func (op *UpdateAttachedClusterOperation) 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 (*UpdateAttachedClusterOperation) Poll ¶ added in v0.5.0
func (op *UpdateAttachedClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
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 (*UpdateAttachedClusterOperation) Wait ¶ added in v0.5.0
func (op *UpdateAttachedClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AttachedCluster, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *UpdateAwsClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *UpdateAwsClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsCluster, error)
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 ¶
func (op *UpdateAwsClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsCluster, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *UpdateAwsNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *UpdateAwsNodePoolOperation) 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 (*UpdateAwsNodePoolOperation) Poll ¶
func (op *UpdateAwsNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
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 ¶
func (op *UpdateAwsNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AwsNodePool, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type 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 ¶
func (op *UpdateAzureClusterOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *UpdateAzureClusterOperation) 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 (*UpdateAzureClusterOperation) Poll ¶
func (op *UpdateAzureClusterOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureCluster, error)
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 ¶
func (op *UpdateAzureClusterOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureCluster, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
type UpdateAzureNodePoolOperation ¶
type UpdateAzureNodePoolOperation struct {
// contains filtered or unexported fields
}
UpdateAzureNodePoolOperation manages a long-running operation from UpdateAzureNodePool.
func (*UpdateAzureNodePoolOperation) Done ¶
func (op *UpdateAzureNodePoolOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateAzureNodePoolOperation) Metadata ¶
func (op *UpdateAzureNodePoolOperation) Metadata() (*gkemulticloudpb.OperationMetadata, error)
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 ¶
func (op *UpdateAzureNodePoolOperation) 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 (*UpdateAzureNodePoolOperation) Poll ¶
func (op *UpdateAzureNodePoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureNodePool, error)
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 ¶
func (op *UpdateAzureNodePoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*gkemulticloudpb.AzureNodePool, error)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.