deploy

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 23, 2022 License: Apache-2.0 Imports: 24 Imported by: 2

Documentation

Overview

Package deploy is an auto-generated package for the Google Cloud Deploy API.

Example usage

To get started with this package, create a client. 

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

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client. 

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

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

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.

Index

Examples

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 CloudDeployCallOptions 

type CloudDeployCallOptions struct {
	ListDeliveryPipelines  []gax.CallOption
	GetDeliveryPipeline    []gax.CallOption
	CreateDeliveryPipeline []gax.CallOption
	UpdateDeliveryPipeline []gax.CallOption
	DeleteDeliveryPipeline []gax.CallOption
	ListTargets            []gax.CallOption
	GetTarget              []gax.CallOption
	CreateTarget           []gax.CallOption
	UpdateTarget           []gax.CallOption
	DeleteTarget           []gax.CallOption
	ListReleases           []gax.CallOption
	GetRelease             []gax.CallOption
	CreateRelease          []gax.CallOption
	ApproveRollout         []gax.CallOption
	ListRollouts           []gax.CallOption
	GetRollout             []gax.CallOption
	CreateRollout          []gax.CallOption
	GetConfig              []gax.CallOption
}

CloudDeployCallOptions contains the retry settings for each method of CloudDeployClient.

type CloudDeployClient 

type CloudDeployClient struct {

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

	// 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
}

CloudDeployClient is a client for interacting with Google Cloud Deploy API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev (at https://skaffold.dev)).

func NewCloudDeployClient 

func NewCloudDeployClient(ctx context.Context, opts ...option.ClientOption) (*CloudDeployClient, error)

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

CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev (at https://skaffold.dev)).

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"
)

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

	// TODO: Use client.
	_ = c
}

Output:

func (*CloudDeployClient) ApproveRollout 

func (c *CloudDeployClient) ApproveRollout(ctx context.Context, req *deploypb.ApproveRolloutRequest, opts ...gax.CallOption) (*deploypb.ApproveRolloutResponse, error)

ApproveRollout approves a Rollout.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

Output:

func (*CloudDeployClient) Close 

func (c *CloudDeployClient) Close() error

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

func (*CloudDeployClient) Connection 

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

Connection returns a connection to the API service.

Deprecated.

func (*CloudDeployClient) CreateDeliveryPipeline 

func (c *CloudDeployClient) CreateDeliveryPipeline(ctx context.Context, req *deploypb.CreateDeliveryPipelineRequest, opts ...gax.CallOption) (*CreateDeliveryPipelineOperation, error)

CreateDeliveryPipeline creates a new DeliveryPipeline in a given project and location.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

	req := &deploypb.CreateDeliveryPipelineRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#CreateDeliveryPipelineRequest.
	}
	op, err := c.CreateDeliveryPipeline(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 (*CloudDeployClient) CreateDeliveryPipelineOperation 

func (c *CloudDeployClient) CreateDeliveryPipelineOperation(name string) *CreateDeliveryPipelineOperation

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

func (*CloudDeployClient) CreateRelease 

func (c *CloudDeployClient) CreateRelease(ctx context.Context, req *deploypb.CreateReleaseRequest, opts ...gax.CallOption) (*CreateReleaseOperation, error)

CreateRelease creates a new Release in a given project and location.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

	req := &deploypb.CreateReleaseRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#CreateReleaseRequest.
	}
	op, err := c.CreateRelease(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 (*CloudDeployClient) CreateReleaseOperation 

func (c *CloudDeployClient) CreateReleaseOperation(name string) *CreateReleaseOperation

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

func (*CloudDeployClient) CreateRollout 

func (c *CloudDeployClient) CreateRollout(ctx context.Context, req *deploypb.CreateRolloutRequest, opts ...gax.CallOption) (*CreateRolloutOperation, error)

CreateRollout creates a new Rollout in a given project and location.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

	req := &deploypb.CreateRolloutRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#CreateRolloutRequest.
	}
	op, err := c.CreateRollout(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 (*CloudDeployClient) CreateRolloutOperation 

func (c *CloudDeployClient) CreateRolloutOperation(name string) *CreateRolloutOperation

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

func (*CloudDeployClient) CreateTarget 

func (c *CloudDeployClient) CreateTarget(ctx context.Context, req *deploypb.CreateTargetRequest, opts ...gax.CallOption) (*CreateTargetOperation, error)

CreateTarget creates a new Target in a given project and location.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

	req := &deploypb.CreateTargetRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#CreateTargetRequest.
	}
	op, err := c.CreateTarget(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 (*CloudDeployClient) CreateTargetOperation 

func (c *CloudDeployClient) CreateTargetOperation(name string) *CreateTargetOperation

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

func (*CloudDeployClient) DeleteDeliveryPipeline 

func (c *CloudDeployClient) DeleteDeliveryPipeline(ctx context.Context, req *deploypb.DeleteDeliveryPipelineRequest, opts ...gax.CallOption) (*DeleteDeliveryPipelineOperation, error)

DeleteDeliveryPipeline deletes a single DeliveryPipeline.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

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

Output:

func (*CloudDeployClient) DeleteDeliveryPipelineOperation 

func (c *CloudDeployClient) DeleteDeliveryPipelineOperation(name string) *DeleteDeliveryPipelineOperation

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

func (*CloudDeployClient) DeleteTarget 

func (c *CloudDeployClient) DeleteTarget(ctx context.Context, req *deploypb.DeleteTargetRequest, opts ...gax.CallOption) (*DeleteTargetOperation, error)

DeleteTarget deletes a single Target.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

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

Output:

func (*CloudDeployClient) DeleteTargetOperation 

func (c *CloudDeployClient) DeleteTargetOperation(name string) *DeleteTargetOperation

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

func (*CloudDeployClient) GetConfig 

func (c *CloudDeployClient) GetConfig(ctx context.Context, req *deploypb.GetConfigRequest, opts ...gax.CallOption) (*deploypb.Config, error)

GetConfig gets the configuration for a location.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

Output:

func (*CloudDeployClient) GetDeliveryPipeline 

func (c *CloudDeployClient) GetDeliveryPipeline(ctx context.Context, req *deploypb.GetDeliveryPipelineRequest, opts ...gax.CallOption) (*deploypb.DeliveryPipeline, error)

GetDeliveryPipeline gets details of a single DeliveryPipeline.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

Output:

func (*CloudDeployClient) GetRelease 

func (c *CloudDeployClient) GetRelease(ctx context.Context, req *deploypb.GetReleaseRequest, opts ...gax.CallOption) (*deploypb.Release, error)

GetRelease gets details of a single Release.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

Output:

func (*CloudDeployClient) GetRollout 

func (c *CloudDeployClient) GetRollout(ctx context.Context, req *deploypb.GetRolloutRequest, opts ...gax.CallOption) (*deploypb.Rollout, error)

GetRollout gets details of a single Rollout.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

Output:

func (*CloudDeployClient) GetTarget 

func (c *CloudDeployClient) GetTarget(ctx context.Context, req *deploypb.GetTargetRequest, opts ...gax.CallOption) (*deploypb.Target, error)

GetTarget gets details of a single Target.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

Output:

func (*CloudDeployClient) ListDeliveryPipelines 

func (c *CloudDeployClient) ListDeliveryPipelines(ctx context.Context, req *deploypb.ListDeliveryPipelinesRequest, opts ...gax.CallOption) *DeliveryPipelineIterator

ListDeliveryPipelines lists DeliveryPipelines in a given project and location.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"
	"google.golang.org/api/iterator"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

Output:

func (*CloudDeployClient) ListReleases 

func (c *CloudDeployClient) ListReleases(ctx context.Context, req *deploypb.ListReleasesRequest, opts ...gax.CallOption) *ReleaseIterator

ListReleases lists Releases in a given project and location.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"
	"google.golang.org/api/iterator"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

Output:

func (*CloudDeployClient) ListRollouts 

func (c *CloudDeployClient) ListRollouts(ctx context.Context, req *deploypb.ListRolloutsRequest, opts ...gax.CallOption) *RolloutIterator

ListRollouts lists Rollouts in a given project and location.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"
	"google.golang.org/api/iterator"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

Output:

func (*CloudDeployClient) ListTargets 

func (c *CloudDeployClient) ListTargets(ctx context.Context, req *deploypb.ListTargetsRequest, opts ...gax.CallOption) *TargetIterator

ListTargets lists Targets in a given project and location.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"
	"google.golang.org/api/iterator"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

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

Output:

func (*CloudDeployClient) UpdateDeliveryPipeline 

func (c *CloudDeployClient) UpdateDeliveryPipeline(ctx context.Context, req *deploypb.UpdateDeliveryPipelineRequest, opts ...gax.CallOption) (*UpdateDeliveryPipelineOperation, error)

UpdateDeliveryPipeline updates the parameters of a single DeliveryPipeline.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

	req := &deploypb.UpdateDeliveryPipelineRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#UpdateDeliveryPipelineRequest.
	}
	op, err := c.UpdateDeliveryPipeline(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 (*CloudDeployClient) UpdateDeliveryPipelineOperation 

func (c *CloudDeployClient) UpdateDeliveryPipelineOperation(name string) *UpdateDeliveryPipelineOperation

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

func (*CloudDeployClient) UpdateTarget 

func (c *CloudDeployClient) UpdateTarget(ctx context.Context, req *deploypb.UpdateTargetRequest, opts ...gax.CallOption) (*UpdateTargetOperation, error)

UpdateTarget updates the parameters of a single Target.

Example 
package main

import (
	"context"

	deploy "cloud.google.com/go/deploy/apiv1"

	deploypb "google.golang.org/genproto/googleapis/cloud/deploy/v1"
)

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

	req := &deploypb.UpdateTargetRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/deploy/v1#UpdateTargetRequest.
	}
	op, err := c.UpdateTarget(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 (*CloudDeployClient) UpdateTargetOperation 

func (c *CloudDeployClient) UpdateTargetOperation(name string) *UpdateTargetOperation

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

type CreateDeliveryPipelineOperation 

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

CreateDeliveryPipelineOperation manages a long-running operation from CreateDeliveryPipeline.

func (*CreateDeliveryPipelineOperation) Done 

func (op *CreateDeliveryPipelineOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateDeliveryPipelineOperation) Metadata 

func (op *CreateDeliveryPipelineOperation) Metadata() (*deploypb.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 (*CreateDeliveryPipelineOperation) Name 

func (op *CreateDeliveryPipelineOperation) 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 (*CreateDeliveryPipelineOperation) Poll 

func (op *CreateDeliveryPipelineOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*deploypb.DeliveryPipeline, 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 (*CreateDeliveryPipelineOperation) Wait 

func (op *CreateDeliveryPipelineOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*deploypb.DeliveryPipeline, 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 CreateReleaseOperation 

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

CreateReleaseOperation manages a long-running operation from CreateRelease.

func (*CreateReleaseOperation) Done 

func (op *CreateReleaseOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateReleaseOperation) Metadata 

func (op *CreateReleaseOperation) Metadata() (*deploypb.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 (*CreateReleaseOperation) Name 

func (op *CreateReleaseOperation) 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 (*CreateReleaseOperation) Poll 

func (op *CreateReleaseOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*deploypb.Release, 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 (*CreateReleaseOperation) Wait 

func (op *CreateReleaseOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*deploypb.Release, 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 CreateRolloutOperation 

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

CreateRolloutOperation manages a long-running operation from CreateRollout.

func (*CreateRolloutOperation) Done 

func (op *CreateRolloutOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateRolloutOperation) Metadata 

func (op *CreateRolloutOperation) Metadata() (*deploypb.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 (*CreateRolloutOperation) Name 

func (op *CreateRolloutOperation) 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 (*CreateRolloutOperation) Poll 

func (op *CreateRolloutOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*deploypb.Rollout, 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 (*CreateRolloutOperation) Wait 

func (op *CreateRolloutOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*deploypb.Rollout, 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 CreateTargetOperation 

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

CreateTargetOperation manages a long-running operation from CreateTarget.

func (*CreateTargetOperation) Done 

func (op *CreateTargetOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateTargetOperation) Metadata 

func (op *CreateTargetOperation) Metadata() (*deploypb.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 (*CreateTargetOperation) Name 

func (op *CreateTargetOperation) 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 (*CreateTargetOperation) Poll 

func (op *CreateTargetOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*deploypb.Target, 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 (*CreateTargetOperation) Wait 

func (op *CreateTargetOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*deploypb.Target, 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 DeleteDeliveryPipelineOperation 

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

DeleteDeliveryPipelineOperation manages a long-running operation from DeleteDeliveryPipeline.

func (*DeleteDeliveryPipelineOperation) Done 

func (op *DeleteDeliveryPipelineOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteDeliveryPipelineOperation) Metadata 

func (op *DeleteDeliveryPipelineOperation) Metadata() (*deploypb.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 (*DeleteDeliveryPipelineOperation) Name 

func (op *DeleteDeliveryPipelineOperation) 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 (*DeleteDeliveryPipelineOperation) Poll 

func (op *DeleteDeliveryPipelineOperation) 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 (*DeleteDeliveryPipelineOperation) Wait 

func (op *DeleteDeliveryPipelineOperation) 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 DeleteTargetOperation 

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

DeleteTargetOperation manages a long-running operation from DeleteTarget.

func (*DeleteTargetOperation) Done 

func (op *DeleteTargetOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteTargetOperation) Metadata 

func (op *DeleteTargetOperation) Metadata() (*deploypb.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 (*DeleteTargetOperation) Name 

func (op *DeleteTargetOperation) 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 (*DeleteTargetOperation) Poll 

func (op *DeleteTargetOperation) 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 (*DeleteTargetOperation) Wait 

func (op *DeleteTargetOperation) 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 DeliveryPipelineIterator 

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

DeliveryPipelineIterator manages a stream of *deploypb.DeliveryPipeline.

func (*DeliveryPipelineIterator) Next 

func (it *DeliveryPipelineIterator) Next() (*deploypb.DeliveryPipeline, 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 (*DeliveryPipelineIterator) PageInfo 

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

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

type ReleaseIterator 

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

ReleaseIterator manages a stream of *deploypb.Release.

func (*ReleaseIterator) Next 

func (it *ReleaseIterator) Next() (*deploypb.Release, 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 (*ReleaseIterator) PageInfo 

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

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

type RolloutIterator 

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

RolloutIterator manages a stream of *deploypb.Rollout.

func (*RolloutIterator) Next 

func (it *RolloutIterator) Next() (*deploypb.Rollout, 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 (*RolloutIterator) PageInfo 

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

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

type TargetIterator 

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

TargetIterator manages a stream of *deploypb.Target.

func (*TargetIterator) Next 

func (it *TargetIterator) Next() (*deploypb.Target, 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 (*TargetIterator) PageInfo 

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

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

type UpdateDeliveryPipelineOperation 

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

UpdateDeliveryPipelineOperation manages a long-running operation from UpdateDeliveryPipeline.

func (*UpdateDeliveryPipelineOperation) Done 

func (op *UpdateDeliveryPipelineOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateDeliveryPipelineOperation) Metadata 

func (op *UpdateDeliveryPipelineOperation) Metadata() (*deploypb.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 (*UpdateDeliveryPipelineOperation) Name 

func (op *UpdateDeliveryPipelineOperation) 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 (*UpdateDeliveryPipelineOperation) Poll 

func (op *UpdateDeliveryPipelineOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*deploypb.DeliveryPipeline, 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 (*UpdateDeliveryPipelineOperation) Wait 

func (op *UpdateDeliveryPipelineOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*deploypb.DeliveryPipeline, 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 UpdateTargetOperation 

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

UpdateTargetOperation manages a long-running operation from UpdateTarget.

func (*UpdateTargetOperation) Done 

func (op *UpdateTargetOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateTargetOperation) Metadata 

func (op *UpdateTargetOperation) Metadata() (*deploypb.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 (*UpdateTargetOperation) Name 

func (op *UpdateTargetOperation) 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 (*UpdateTargetOperation) Poll 

func (op *UpdateTargetOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*deploypb.Target, 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 (*UpdateTargetOperation) Wait 

func (op *UpdateTargetOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*deploypb.Target, 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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.