Distributed Cloud Edge Container API v1 - Package cloud.google.com/go/edgecontainer/apiv1 (v1.4.4)
Package edgecontainer is an auto-generated package for theDistributed Cloud Edge Container API.
General documentation
For information that is relevant for all client libraries please referencehttps://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on thispage includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/edgecontainer/apiv1@latestctx:=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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed.The methods of Client are safe for concurrent use by multiple goroutines.The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client, mentioned above.
req:=&edgecontainerpb.CreateClusterRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#CreateClusterRequest.}op,err:=c.CreateCluster(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp
Use of Context
The ctx passed to NewClient is used for authentication requests andfor 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.
Functions
func DefaultAuthScopes
funcDefaultAuthScopes()[]stringDefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
typeCallOptionsstruct{ListClusters[]gax.CallOptionGetCluster[]gax.CallOptionCreateCluster[]gax.CallOptionUpdateCluster[]gax.CallOptionUpgradeCluster[]gax.CallOptionDeleteCluster[]gax.CallOptionGenerateAccessToken[]gax.CallOptionGenerateOfflineCredential[]gax.CallOptionListNodePools[]gax.CallOptionGetNodePool[]gax.CallOptionCreateNodePool[]gax.CallOptionUpdateNodePool[]gax.CallOptionDeleteNodePool[]gax.CallOptionListMachines[]gax.CallOptionGetMachine[]gax.CallOptionListVpnConnections[]gax.CallOptionGetVpnConnection[]gax.CallOptionCreateVpnConnection[]gax.CallOptionDeleteVpnConnection[]gax.CallOptionGetServerConfig[]gax.CallOptionGetLocation[]gax.CallOptionListLocations[]gax.CallOptionCancelOperation[]gax.CallOptionDeleteOperation[]gax.CallOptionGetOperation[]gax.CallOptionListOperations[]gax.CallOption}CallOptions contains the retry settings for each method of Client.
Client
typeClientstruct{// The call options for this service.CallOptions*CallOptions// 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}Client is a client for interacting with Distributed Cloud Edge Container API.Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
EdgeContainer API provides management of Kubernetes Clusters on Google EdgeCloud deployments.
func NewClient
NewClient creates a new edge container client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.
EdgeContainer API provides management of Kubernetes Clusters on Google EdgeCloud deployments.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}func NewRESTClient
NewRESTClient creates a new edge container rest client.
EdgeContainer API provides management of Kubernetes Clusters on Google EdgeCloud deployments.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1")funcmain(){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_Optionsc,err:=edgecontainer.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}func (*Client) CancelOperation
func(c*Client)CancelOperation(ctxcontext.Context,req*longrunningpb.CancelOperationRequest,opts...gax.CallOption)errorCancelOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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)iferr!=nil{// TODO: Handle error.}}func (*Client) Close
Close closes the connection to the API service. The user should invoke this whenthe client is no longer required.
func (*Client) Connection (deprecated)
func(c*Client)Connection()*grpc.ClientConnConnection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.
func (*Client) CreateCluster
func(c*Client)CreateCluster(ctxcontext.Context,req*edgecontainerpb.CreateClusterRequest,opts...gax.CallOption)(*CreateClusterOperation,error)CreateCluster creates a new Cluster in a given project and location.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.CreateClusterRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#CreateClusterRequest.}op,err:=c.CreateCluster(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) CreateClusterOperation
func(c*Client)CreateClusterOperation(namestring)*CreateClusterOperationCreateClusterOperation returns a new CreateClusterOperation from a given name.The name must be that of a previously created CreateClusterOperation, possibly from a different process.
func (*Client) CreateNodePool
func(c*Client)CreateNodePool(ctxcontext.Context,req*edgecontainerpb.CreateNodePoolRequest,opts...gax.CallOption)(*CreateNodePoolOperation,error)CreateNodePool creates a new NodePool in a given project and location.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.CreateNodePoolRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#CreateNodePoolRequest.}op,err:=c.CreateNodePool(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) CreateNodePoolOperation
func(c*Client)CreateNodePoolOperation(namestring)*CreateNodePoolOperationCreateNodePoolOperation returns a new CreateNodePoolOperation from a given name.The name must be that of a previously created CreateNodePoolOperation, possibly from a different process.
func (*Client) CreateVpnConnection
func(c*Client)CreateVpnConnection(ctxcontext.Context,req*edgecontainerpb.CreateVpnConnectionRequest,opts...gax.CallOption)(*CreateVpnConnectionOperation,error)CreateVpnConnection creates a new VPN connection in a given project and location.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.CreateVpnConnectionRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#CreateVpnConnectionRequest.}op,err:=c.CreateVpnConnection(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) CreateVpnConnectionOperation
func(c*Client)CreateVpnConnectionOperation(namestring)*CreateVpnConnectionOperationCreateVpnConnectionOperation returns a new CreateVpnConnectionOperation from a given name.The name must be that of a previously created CreateVpnConnectionOperation, possibly from a different process.
func (*Client) DeleteCluster
func(c*Client)DeleteCluster(ctxcontext.Context,req*edgecontainerpb.DeleteClusterRequest,opts...gax.CallOption)(*DeleteClusterOperation,error)DeleteCluster deletes a single Cluster.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.DeleteClusterRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#DeleteClusterRequest.}op,err:=c.DeleteCluster(ctx,req)iferr!=nil{// TODO: Handle error.}err=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}}func (*Client) DeleteClusterOperation
func(c*Client)DeleteClusterOperation(namestring)*DeleteClusterOperationDeleteClusterOperation returns a new DeleteClusterOperation from a given name.The name must be that of a previously created DeleteClusterOperation, possibly from a different process.
func (*Client) DeleteNodePool
func(c*Client)DeleteNodePool(ctxcontext.Context,req*edgecontainerpb.DeleteNodePoolRequest,opts...gax.CallOption)(*DeleteNodePoolOperation,error)DeleteNodePool deletes a single NodePool.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.DeleteNodePoolRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#DeleteNodePoolRequest.}op,err:=c.DeleteNodePool(ctx,req)iferr!=nil{// TODO: Handle error.}err=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}}func (*Client) DeleteNodePoolOperation
func(c*Client)DeleteNodePoolOperation(namestring)*DeleteNodePoolOperationDeleteNodePoolOperation returns a new DeleteNodePoolOperation from a given name.The name must be that of a previously created DeleteNodePoolOperation, possibly from a different process.
func (*Client) DeleteOperation
func(c*Client)DeleteOperation(ctxcontext.Context,req*longrunningpb.DeleteOperationRequest,opts...gax.CallOption)errorDeleteOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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)iferr!=nil{// TODO: Handle error.}}func (*Client) DeleteVpnConnection
func(c*Client)DeleteVpnConnection(ctxcontext.Context,req*edgecontainerpb.DeleteVpnConnectionRequest,opts...gax.CallOption)(*DeleteVpnConnectionOperation,error)DeleteVpnConnection deletes a single VPN connection.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.DeleteVpnConnectionRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#DeleteVpnConnectionRequest.}op,err:=c.DeleteVpnConnection(ctx,req)iferr!=nil{// TODO: Handle error.}err=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}}func (*Client) DeleteVpnConnectionOperation
func(c*Client)DeleteVpnConnectionOperation(namestring)*DeleteVpnConnectionOperationDeleteVpnConnectionOperation returns a new DeleteVpnConnectionOperation from a given name.The name must be that of a previously created DeleteVpnConnectionOperation, possibly from a different process.
func (*Client) GenerateAccessToken
func(c*Client)GenerateAccessToken(ctxcontext.Context,req*edgecontainerpb.GenerateAccessTokenRequest,opts...gax.CallOption)(*edgecontainerpb.GenerateAccessTokenResponse,error)GenerateAccessToken generates an access token for a Cluster.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.GenerateAccessTokenRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#GenerateAccessTokenRequest.}resp,err:=c.GenerateAccessToken(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GenerateOfflineCredential
func(c*Client)GenerateOfflineCredential(ctxcontext.Context,req*edgecontainerpb.GenerateOfflineCredentialRequest,opts...gax.CallOption)(*edgecontainerpb.GenerateOfflineCredentialResponse,error)GenerateOfflineCredential generates an offline credential for a Cluster.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.GenerateOfflineCredentialRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#GenerateOfflineCredentialRequest.}resp,err:=c.GenerateOfflineCredential(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetCluster
func(c*Client)GetCluster(ctxcontext.Context,req*edgecontainerpb.GetClusterRequest,opts...gax.CallOption)(*edgecontainerpb.Cluster,error)GetCluster gets details of a single Cluster.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.GetClusterRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#GetClusterRequest.}resp,err:=c.GetCluster(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetLocation
func(c*Client)GetLocation(ctxcontext.Context,req*locationpb.GetLocationRequest,opts...gax.CallOption)(*locationpb.Location,error)GetLocation gets information about a location.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.GetLocationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.}resp,err:=c.GetLocation(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetMachine
func(c*Client)GetMachine(ctxcontext.Context,req*edgecontainerpb.GetMachineRequest,opts...gax.CallOption)(*edgecontainerpb.Machine,error)GetMachine gets details of a single Machine.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.GetMachineRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#GetMachineRequest.}resp,err:=c.GetMachine(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetNodePool
func(c*Client)GetNodePool(ctxcontext.Context,req*edgecontainerpb.GetNodePoolRequest,opts...gax.CallOption)(*edgecontainerpb.NodePool,error)GetNodePool gets details of a single NodePool.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.GetNodePoolRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#GetNodePoolRequest.}resp,err:=c.GetNodePool(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetOperation
func(c*Client)GetOperation(ctxcontext.Context,req*longrunningpb.GetOperationRequest,opts...gax.CallOption)(*longrunningpb.Operation,error)GetOperation is a utility method from google.longrunning.Operations.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetServerConfig
func(c*Client)GetServerConfig(ctxcontext.Context,req*edgecontainerpb.GetServerConfigRequest,opts...gax.CallOption)(*edgecontainerpb.ServerConfig,error)GetServerConfig gets the server config.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.GetServerConfigRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#GetServerConfigRequest.}resp,err:=c.GetServerConfig(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) GetVpnConnection
func(c*Client)GetVpnConnection(ctxcontext.Context,req*edgecontainerpb.GetVpnConnectionRequest,opts...gax.CallOption)(*edgecontainerpb.VpnConnection,error)GetVpnConnection gets details of a single VPN connection.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.GetVpnConnectionRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#GetVpnConnectionRequest.}resp,err:=c.GetVpnConnection(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) ListClusters
func(c*Client)ListClusters(ctxcontext.Context,req*edgecontainerpb.ListClustersRequest,opts...gax.CallOption)*ClusterIteratorListClusters lists Clusters in a given project and location.
Examples
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb""google.golang.org/api/iterator")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.ListClustersRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#ListClustersRequest.}it:=c.ListClusters(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*edgecontainerpb.ListClustersResponse)}}all
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.ListClustersRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#ListClustersRequest.}forresp,err:=rangec.ListClusters(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) ListLocations
func(c*Client)ListLocations(ctxcontext.Context,req*locationpb.ListLocationsRequest,opts...gax.CallOption)*LocationIteratorListLocations lists information about the supported locations for this service.
Examples
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1""google.golang.org/api/iterator"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}it:=c.ListLocations(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*locationpb.ListLocationsResponse)}}all
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}forresp,err:=rangec.ListLocations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) ListMachines
func(c*Client)ListMachines(ctxcontext.Context,req*edgecontainerpb.ListMachinesRequest,opts...gax.CallOption)*MachineIteratorListMachines lists Machines in a given project and location.
Examples
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb""google.golang.org/api/iterator")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.ListMachinesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#ListMachinesRequest.}it:=c.ListMachines(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*edgecontainerpb.ListMachinesResponse)}}all
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.ListMachinesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#ListMachinesRequest.}forresp,err:=rangec.ListMachines(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) ListNodePools
func(c*Client)ListNodePools(ctxcontext.Context,req*edgecontainerpb.ListNodePoolsRequest,opts...gax.CallOption)*NodePoolIteratorListNodePools lists NodePools in a given project and location.
Examples
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb""google.golang.org/api/iterator")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.ListNodePoolsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#ListNodePoolsRequest.}it:=c.ListNodePools(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*edgecontainerpb.ListNodePoolsResponse)}}all
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.ListNodePoolsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#ListNodePoolsRequest.}forresp,err:=rangec.ListNodePools(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) ListOperations
func(c*Client)ListOperations(ctxcontext.Context,req*longrunningpb.ListOperationsRequest,opts...gax.CallOption)*OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb""google.golang.org/api/iterator")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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()iferr==iterator.Done{break}iferr!=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)}}all
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}forresp,err:=rangec.ListOperations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) ListVpnConnections
func(c*Client)ListVpnConnections(ctxcontext.Context,req*edgecontainerpb.ListVpnConnectionsRequest,opts...gax.CallOption)*VpnConnectionIteratorListVpnConnections lists VPN connections in a given project and location.
Examples
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb""google.golang.org/api/iterator")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.ListVpnConnectionsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#ListVpnConnectionsRequest.}it:=c.ListVpnConnections(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*edgecontainerpb.ListVpnConnectionsResponse)}}all
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.ListVpnConnectionsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#ListVpnConnectionsRequest.}forresp,err:=rangec.ListVpnConnections(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}func (*Client) UpdateCluster
func(c*Client)UpdateCluster(ctxcontext.Context,req*edgecontainerpb.UpdateClusterRequest,opts...gax.CallOption)(*UpdateClusterOperation,error)UpdateCluster updates the parameters of a single Cluster.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.UpdateClusterRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#UpdateClusterRequest.}op,err:=c.UpdateCluster(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) UpdateClusterOperation
func(c*Client)UpdateClusterOperation(namestring)*UpdateClusterOperationUpdateClusterOperation returns a new UpdateClusterOperation from a given name.The name must be that of a previously created UpdateClusterOperation, possibly from a different process.
func (*Client) UpdateNodePool
func(c*Client)UpdateNodePool(ctxcontext.Context,req*edgecontainerpb.UpdateNodePoolRequest,opts...gax.CallOption)(*UpdateNodePoolOperation,error)UpdateNodePool updates the parameters of a single NodePool.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.UpdateNodePoolRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#UpdateNodePoolRequest.}op,err:=c.UpdateNodePool(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) UpdateNodePoolOperation
func(c*Client)UpdateNodePoolOperation(namestring)*UpdateNodePoolOperationUpdateNodePoolOperation returns a new UpdateNodePoolOperation from a given name.The name must be that of a previously created UpdateNodePoolOperation, possibly from a different process.
func (*Client) UpgradeCluster
func(c*Client)UpgradeCluster(ctxcontext.Context,req*edgecontainerpb.UpgradeClusterRequest,opts...gax.CallOption)(*UpgradeClusterOperation,error)UpgradeCluster upgrades a single cluster.
Example
packagemainimport("context"edgecontainer"cloud.google.com/go/edgecontainer/apiv1"edgecontainerpb"cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb")funcmain(){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_Optionsc,err:=edgecontainer.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&edgecontainerpb.UpgradeClusterRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/edgecontainer/apiv1/edgecontainerpb#UpgradeClusterRequest.}op,err:=c.UpgradeCluster(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}func (*Client) UpgradeClusterOperation
func(c*Client)UpgradeClusterOperation(namestring)*UpgradeClusterOperationUpgradeClusterOperation returns a new UpgradeClusterOperation from a given name.The name must be that of a previously created UpgradeClusterOperation, possibly from a different process.
ClusterIterator
typeClusterIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*edgecontainerpb.Cluster,nextPageTokenstring,errerror)// contains filtered or unexported fields}ClusterIterator manages a stream of *edgecontainerpb.Cluster.
func (*ClusterIterator) All
func(it*ClusterIterator)All()iter.Seq2[*edgecontainerpb.Cluster,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*ClusterIterator) Next
func(it*ClusterIterator)Next()(*edgecontainerpb.Cluster,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*ClusterIterator) PageInfo
func(it*ClusterIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
CreateClusterOperation
typeCreateClusterOperationstruct{// contains filtered or unexported fields}CreateClusterOperation manages a long-running operation from CreateCluster.
func (*CreateClusterOperation) Done
func(op*CreateClusterOperation)Done()boolDone reports whether the long-running operation has completed.
func (*CreateClusterOperation) Metadata
func(op*CreateClusterOperation)Metadata()(*edgecontainerpb.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 (*CreateClusterOperation) Name
func(op*CreateClusterOperation)Name()stringName 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 (*CreateClusterOperation) Poll
func(op*CreateClusterOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.Cluster,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 andthe 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 (*CreateClusterOperation) Wait
func(op*CreateClusterOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.Cluster,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.
CreateNodePoolOperation
typeCreateNodePoolOperationstruct{// contains filtered or unexported fields}CreateNodePoolOperation manages a long-running operation from CreateNodePool.
func (*CreateNodePoolOperation) Done
func(op*CreateNodePoolOperation)Done()boolDone reports whether the long-running operation has completed.
func (*CreateNodePoolOperation) Metadata
func(op*CreateNodePoolOperation)Metadata()(*edgecontainerpb.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 (*CreateNodePoolOperation) Name
func(op*CreateNodePoolOperation)Name()stringName 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 (*CreateNodePoolOperation) Poll
func(op*CreateNodePoolOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.NodePool,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 andthe 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 (*CreateNodePoolOperation) Wait
func(op*CreateNodePoolOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.NodePool,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.
CreateVpnConnectionOperation
typeCreateVpnConnectionOperationstruct{// contains filtered or unexported fields}CreateVpnConnectionOperation manages a long-running operation from CreateVpnConnection.
func (*CreateVpnConnectionOperation) Done
func(op*CreateVpnConnectionOperation)Done()boolDone reports whether the long-running operation has completed.
func (*CreateVpnConnectionOperation) Metadata
func(op*CreateVpnConnectionOperation)Metadata()(*edgecontainerpb.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 (*CreateVpnConnectionOperation) Name
func(op*CreateVpnConnectionOperation)Name()stringName 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 (*CreateVpnConnectionOperation) Poll
func(op*CreateVpnConnectionOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.VpnConnection,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 andthe 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 (*CreateVpnConnectionOperation) Wait
func(op*CreateVpnConnectionOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.VpnConnection,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.
DeleteClusterOperation
typeDeleteClusterOperationstruct{// contains filtered or unexported fields}DeleteClusterOperation manages a long-running operation from DeleteCluster.
func (*DeleteClusterOperation) Done
func(op*DeleteClusterOperation)Done()boolDone reports whether the long-running operation has completed.
func (*DeleteClusterOperation) Metadata
func(op*DeleteClusterOperation)Metadata()(*edgecontainerpb.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 (*DeleteClusterOperation) Name
func(op*DeleteClusterOperation)Name()stringName 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 (*DeleteClusterOperation) Poll
func(op*DeleteClusterOperation)Poll(ctxcontext.Context,opts...gax.CallOption)errorPoll 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 andthe 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 (*DeleteClusterOperation) Wait
func(op*DeleteClusterOperation)Wait(ctxcontext.Context,opts...gax.CallOption)errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteNodePoolOperation
typeDeleteNodePoolOperationstruct{// contains filtered or unexported fields}DeleteNodePoolOperation manages a long-running operation from DeleteNodePool.
func (*DeleteNodePoolOperation) Done
func(op*DeleteNodePoolOperation)Done()boolDone reports whether the long-running operation has completed.
func (*DeleteNodePoolOperation) Metadata
func(op*DeleteNodePoolOperation)Metadata()(*edgecontainerpb.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 (*DeleteNodePoolOperation) Name
func(op*DeleteNodePoolOperation)Name()stringName 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 (*DeleteNodePoolOperation) Poll
func(op*DeleteNodePoolOperation)Poll(ctxcontext.Context,opts...gax.CallOption)errorPoll 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 andthe 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 (*DeleteNodePoolOperation) Wait
func(op*DeleteNodePoolOperation)Wait(ctxcontext.Context,opts...gax.CallOption)errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteVpnConnectionOperation
typeDeleteVpnConnectionOperationstruct{// contains filtered or unexported fields}DeleteVpnConnectionOperation manages a long-running operation from DeleteVpnConnection.
func (*DeleteVpnConnectionOperation) Done
func(op*DeleteVpnConnectionOperation)Done()boolDone reports whether the long-running operation has completed.
func (*DeleteVpnConnectionOperation) Metadata
func(op*DeleteVpnConnectionOperation)Metadata()(*edgecontainerpb.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 (*DeleteVpnConnectionOperation) Name
func(op*DeleteVpnConnectionOperation)Name()stringName 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 (*DeleteVpnConnectionOperation) Poll
func(op*DeleteVpnConnectionOperation)Poll(ctxcontext.Context,opts...gax.CallOption)errorPoll 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 andthe 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 (*DeleteVpnConnectionOperation) Wait
func(op*DeleteVpnConnectionOperation)Wait(ctxcontext.Context,opts...gax.CallOption)errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
LocationIterator
typeLocationIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*locationpb.Location,nextPageTokenstring,errerror)// contains filtered or unexported fields}LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) All
func(it*LocationIterator)All()iter.Seq2[*locationpb.Location,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*LocationIterator) Next
func(it*LocationIterator)Next()(*locationpb.Location,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo
func(it*LocationIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
MachineIterator
typeMachineIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*edgecontainerpb.Machine,nextPageTokenstring,errerror)// contains filtered or unexported fields}MachineIterator manages a stream of *edgecontainerpb.Machine.
func (*MachineIterator) All
func(it*MachineIterator)All()iter.Seq2[*edgecontainerpb.Machine,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*MachineIterator) Next
func(it*MachineIterator)Next()(*edgecontainerpb.Machine,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*MachineIterator) PageInfo
func(it*MachineIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
NodePoolIterator
typeNodePoolIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*edgecontainerpb.NodePool,nextPageTokenstring,errerror)// contains filtered or unexported fields}NodePoolIterator manages a stream of *edgecontainerpb.NodePool.
func (*NodePoolIterator) All
func(it*NodePoolIterator)All()iter.Seq2[*edgecontainerpb.NodePool,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*NodePoolIterator) Next
func(it*NodePoolIterator)Next()(*edgecontainerpb.NodePool,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*NodePoolIterator) PageInfo
func(it*NodePoolIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
OperationIterator
typeOperationIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*longrunningpb.Operation,nextPageTokenstring,errerror)// contains filtered or unexported fields}OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All
func(it*OperationIterator)All()iter.Seq2[*longrunningpb.Operation,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*OperationIterator) Next
func(it*OperationIterator)Next()(*longrunningpb.Operation,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*OperationIterator) PageInfo
func(it*OperationIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
UpdateClusterOperation
typeUpdateClusterOperationstruct{// contains filtered or unexported fields}UpdateClusterOperation manages a long-running operation from UpdateCluster.
func (*UpdateClusterOperation) Done
func(op*UpdateClusterOperation)Done()boolDone reports whether the long-running operation has completed.
func (*UpdateClusterOperation) Metadata
func(op*UpdateClusterOperation)Metadata()(*edgecontainerpb.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 (*UpdateClusterOperation) Name
func(op*UpdateClusterOperation)Name()stringName 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 (*UpdateClusterOperation) Poll
func(op*UpdateClusterOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.Cluster,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 andthe 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 (*UpdateClusterOperation) Wait
func(op*UpdateClusterOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.Cluster,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.
UpdateNodePoolOperation
typeUpdateNodePoolOperationstruct{// contains filtered or unexported fields}UpdateNodePoolOperation manages a long-running operation from UpdateNodePool.
func (*UpdateNodePoolOperation) Done
func(op*UpdateNodePoolOperation)Done()boolDone reports whether the long-running operation has completed.
func (*UpdateNodePoolOperation) Metadata
func(op*UpdateNodePoolOperation)Metadata()(*edgecontainerpb.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 (*UpdateNodePoolOperation) Name
func(op*UpdateNodePoolOperation)Name()stringName 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 (*UpdateNodePoolOperation) Poll
func(op*UpdateNodePoolOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.NodePool,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 andthe 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 (*UpdateNodePoolOperation) Wait
func(op*UpdateNodePoolOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.NodePool,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.
UpgradeClusterOperation
typeUpgradeClusterOperationstruct{// contains filtered or unexported fields}UpgradeClusterOperation manages a long-running operation from UpgradeCluster.
func (*UpgradeClusterOperation) Done
func(op*UpgradeClusterOperation)Done()boolDone reports whether the long-running operation has completed.
func (*UpgradeClusterOperation) Metadata
func(op*UpgradeClusterOperation)Metadata()(*edgecontainerpb.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 (*UpgradeClusterOperation) Name
func(op*UpgradeClusterOperation)Name()stringName 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 (*UpgradeClusterOperation) Poll
func(op*UpgradeClusterOperation)Poll(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.Cluster,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 andthe 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 (*UpgradeClusterOperation) Wait
func(op*UpgradeClusterOperation)Wait(ctxcontext.Context,opts...gax.CallOption)(*edgecontainerpb.Cluster,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.
VpnConnectionIterator
typeVpnConnectionIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*edgecontainerpb.VpnConnection,nextPageTokenstring,errerror)// contains filtered or unexported fields}VpnConnectionIterator manages a stream of *edgecontainerpb.VpnConnection.
func (*VpnConnectionIterator) All
func(it*VpnConnectionIterator)All()iter.Seq2[*edgecontainerpb.VpnConnection,error]All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.
func (*VpnConnectionIterator) Next
func(it*VpnConnectionIterator)Next()(*edgecontainerpb.VpnConnection,error)Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.
func (*VpnConnectionIterator) PageInfo
func(it*VpnConnectionIterator)PageInfo()*iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.