Package cloud.google.com/go/cloudbuild/apiv1/v2

Package cloudbuild is an auto-generated package for the Cloud Build API.

Creates and manages builds on Google Cloud Platform.

Example usage

To get started with this package, create a client.

ctx := context.Background()
c, err := cloudbuild.NewClient(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 := cloudbuild.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &cloudbuildpb.CreateBuildRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#CreateBuildRequest.
}
op, err := c.CreateBuild(ctx, req)
if err != nil {
    // TODO: Handle error.
}

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

Use of Context

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

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

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

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

ApproveBuildOperation

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

ApproveBuildOperation manages a long-running operation from ApproveBuild.

func (*ApproveBuildOperation) Done

func (op *ApproveBuildOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*ApproveBuildOperation) Metadata

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

func (*ApproveBuildOperation) Name

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

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

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

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

func (*ApproveBuildOperation) Wait

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

See documentation of Poll for error-handling information.

BuildIterator

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

BuildIterator manages a stream of *cloudbuildpb.Build.

func (*BuildIterator) Next

func (it *BuildIterator) Next() (*cloudbuildpb.Build, 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 (*BuildIterator) PageInfo

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

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

BuildTriggerIterator

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

BuildTriggerIterator manages a stream of *cloudbuildpb.BuildTrigger.

func (*BuildTriggerIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*BuildTriggerIterator) PageInfo

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

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

CallOptions

type CallOptions struct {
	CreateBuild           []gax.CallOption
	GetBuild              []gax.CallOption
	ListBuilds            []gax.CallOption
	CancelBuild           []gax.CallOption
	RetryBuild            []gax.CallOption
	ApproveBuild          []gax.CallOption
	CreateBuildTrigger    []gax.CallOption
	GetBuildTrigger       []gax.CallOption
	ListBuildTriggers     []gax.CallOption
	DeleteBuildTrigger    []gax.CallOption
	UpdateBuildTrigger    []gax.CallOption
	RunBuildTrigger       []gax.CallOption
	ReceiveTriggerWebhook []gax.CallOption
	CreateWorkerPool      []gax.CallOption
	GetWorkerPool         []gax.CallOption
	DeleteWorkerPool      []gax.CallOption
	UpdateWorkerPool      []gax.CallOption
	ListWorkerPools       []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

	// 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 Cloud Build API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Creates and manages builds on Google Cloud Platform.

The main concept used by this API is a Build, which describes the location of the source to build, how to build the source, and where to store the built artifacts, if any.

A user can list previously-requested builds or get builds by their ID to determine the status of the build.

func NewClient

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

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

Creates and manages builds on Google Cloud Platform.

The main concept used by this API is a Build, which describes the location of the source to build, how to build the source, and where to store the built artifacts, if any.

A user can list previously-requested builds or get builds by their ID to determine the status of the build.

Example

package main

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

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

	// TODO: Use client.
	_ = c
}

func (*Client) ApproveBuild

ApproveBuild approves or rejects a pending build.

If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call.

If rejected, the returned LRO will be immediately done.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.ApproveBuildRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#ApproveBuildRequest.
	}
	op, err := c.ApproveBuild(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) ApproveBuildOperation

func (c *Client) ApproveBuildOperation(name string) *ApproveBuildOperation

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

func (*Client) CancelBuild

func (c *Client) CancelBuild(ctx context.Context, req *cloudbuildpb.CancelBuildRequest, opts ...gax.CallOption) (*cloudbuildpb.Build, error)

CancelBuild cancels a build in progress.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.CancelBuildRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#CancelBuildRequest.
	}
	resp, err := c.CancelBuild(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) Close

func (c *Client) Close() error

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

func (*Client) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*Client) CreateBuild

CreateBuild starts a build with the specified configuration.

This method returns a long-running Operation, which includes the build ID. Pass the build ID to GetBuild to determine the build status (such as SUCCESS or FAILURE).

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.CreateBuildRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#CreateBuildRequest.
	}
	op, err := c.CreateBuild(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) CreateBuildOperation

func (c *Client) CreateBuildOperation(name string) *CreateBuildOperation

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

func (*Client) CreateBuildTrigger

CreateBuildTrigger creates a new BuildTrigger.

This API is experimental.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.CreateBuildTriggerRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#CreateBuildTriggerRequest.
	}
	resp, err := c.CreateBuildTrigger(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) CreateWorkerPool

CreateWorkerPool creates a WorkerPool.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.CreateWorkerPoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#CreateWorkerPoolRequest.
	}
	op, err := c.CreateWorkerPool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) CreateWorkerPoolOperation

func (c *Client) CreateWorkerPoolOperation(name string) *CreateWorkerPoolOperation

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

func (*Client) DeleteBuildTrigger

func (c *Client) DeleteBuildTrigger(ctx context.Context, req *cloudbuildpb.DeleteBuildTriggerRequest, opts ...gax.CallOption) error

DeleteBuildTrigger deletes a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.DeleteBuildTriggerRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#DeleteBuildTriggerRequest.
	}
	err = c.DeleteBuildTrigger(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*Client) DeleteWorkerPool

DeleteWorkerPool deletes a WorkerPool.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.DeleteWorkerPoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#DeleteWorkerPoolRequest.
	}
	op, err := c.DeleteWorkerPool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) DeleteWorkerPoolOperation

func (c *Client) DeleteWorkerPoolOperation(name string) *DeleteWorkerPoolOperation

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

func (*Client) GetBuild

GetBuild returns information about a previously requested build.

The Build that is returned includes its status (such as SUCCESS, FAILURE, or WORKING), and timing information.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.GetBuildRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#GetBuildRequest.
	}
	resp, err := c.GetBuild(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetBuildTrigger

GetBuildTrigger returns information about a BuildTrigger.

This API is experimental.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.GetBuildTriggerRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#GetBuildTriggerRequest.
	}
	resp, err := c.GetBuildTrigger(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetWorkerPool

GetWorkerPool returns details of a WorkerPool.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.GetWorkerPoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#GetWorkerPoolRequest.
	}
	resp, err := c.GetWorkerPool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) ListBuildTriggers

ListBuildTriggers lists existing BuildTriggers.

This API is experimental.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	"google.golang.org/api/iterator"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

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

func (*Client) ListBuilds

func (c *Client) ListBuilds(ctx context.Context, req *cloudbuildpb.ListBuildsRequest, opts ...gax.CallOption) *BuildIterator

ListBuilds lists previously requested builds.

Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	"google.golang.org/api/iterator"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

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

func (*Client) ListWorkerPools

ListWorkerPools lists WorkerPools.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	"google.golang.org/api/iterator"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

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

func (*Client) ReceiveTriggerWebhook

ReceiveTriggerWebhook receiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.ReceiveTriggerWebhookRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#ReceiveTriggerWebhookRequest.
	}
	resp, err := c.ReceiveTriggerWebhook(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) RetryBuild

RetryBuild creates a new build based on the specified build.

This method creates a new build using the original build request, which may or may not result in an identical build.

For triggered builds:

Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision.

For non-triggered builds that specify RepoSource:

If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build.

If the original build specified a commit sha or revision ID, the retried build will use the identical source.

For builds that specify StorageSource:

If the original build pulled source from Google Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source.

If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket’s lifecycle management settings.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.RetryBuildRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#RetryBuildRequest.
	}
	op, err := c.RetryBuild(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) RetryBuildOperation

func (c *Client) RetryBuildOperation(name string) *RetryBuildOperation

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

func (*Client) RunBuildTrigger

RunBuildTrigger runs a BuildTrigger at a particular source revision.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.RunBuildTriggerRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#RunBuildTriggerRequest.
	}
	op, err := c.RunBuildTrigger(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) RunBuildTriggerOperation

func (c *Client) RunBuildTriggerOperation(name string) *RunBuildTriggerOperation

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

func (*Client) UpdateBuildTrigger

UpdateBuildTrigger updates a BuildTrigger by its project ID and trigger ID.

This API is experimental.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.UpdateBuildTriggerRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#UpdateBuildTriggerRequest.
	}
	resp, err := c.UpdateBuildTrigger(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) UpdateWorkerPool

UpdateWorkerPool updates a WorkerPool.

Example

package main

import (
	cloudbuild "cloud.google.com/go/cloudbuild/apiv1/v2"
	"context"
	cloudbuildpb "google.golang.org/genproto/googleapis/devtools/cloudbuild/v1"
)

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

	req := &cloudbuildpb.UpdateWorkerPoolRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/devtools/cloudbuild/v1#UpdateWorkerPoolRequest.
	}
	op, err := c.UpdateWorkerPool(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) UpdateWorkerPoolOperation

func (c *Client) UpdateWorkerPoolOperation(name string) *UpdateWorkerPoolOperation

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

CreateBuildOperation

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

CreateBuildOperation manages a long-running operation from CreateBuild.

func (*CreateBuildOperation) Done

func (op *CreateBuildOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateBuildOperation) Metadata

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

func (*CreateBuildOperation) Name

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

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

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

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

func (*CreateBuildOperation) Wait

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

See documentation of Poll for error-handling information.

CreateWorkerPoolOperation

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

CreateWorkerPoolOperation manages a long-running operation from CreateWorkerPool.

func (*CreateWorkerPoolOperation) Done

func (op *CreateWorkerPoolOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateWorkerPoolOperation) Metadata

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

func (*CreateWorkerPoolOperation) Name

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

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

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

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

func (*CreateWorkerPoolOperation) Wait

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

See documentation of Poll for error-handling information.

DeleteWorkerPoolOperation

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

DeleteWorkerPoolOperation manages a long-running operation from DeleteWorkerPool.

func (*DeleteWorkerPoolOperation) Done

func (op *DeleteWorkerPoolOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteWorkerPoolOperation) Metadata

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

func (*DeleteWorkerPoolOperation) Name

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

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

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

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

func (*DeleteWorkerPoolOperation) Wait

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

See documentation of Poll for error-handling information.

RetryBuildOperation

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

RetryBuildOperation manages a long-running operation from RetryBuild.

func (*RetryBuildOperation) Done

func (op *RetryBuildOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RetryBuildOperation) Metadata

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

func (*RetryBuildOperation) Name

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

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

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

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

func (*RetryBuildOperation) Wait

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

See documentation of Poll for error-handling information.

RunBuildTriggerOperation

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

RunBuildTriggerOperation manages a long-running operation from RunBuildTrigger.

func (*RunBuildTriggerOperation) Done

func (op *RunBuildTriggerOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RunBuildTriggerOperation) Metadata

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

func (*RunBuildTriggerOperation) Name

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

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

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

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

func (*RunBuildTriggerOperation) Wait

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

See documentation of Poll for error-handling information.

UpdateWorkerPoolOperation

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

UpdateWorkerPoolOperation manages a long-running operation from UpdateWorkerPool.

func (*UpdateWorkerPoolOperation) Done

func (op *UpdateWorkerPoolOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateWorkerPoolOperation) Metadata

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

func (*UpdateWorkerPoolOperation) Name

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

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

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

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

func (*UpdateWorkerPoolOperation) Wait

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

See documentation of Poll for error-handling information.

WorkerPoolIterator

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

WorkerPoolIterator manages a stream of *cloudbuildpb.WorkerPool.

func (*WorkerPoolIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*WorkerPoolIterator) PageInfo

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

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