Documentation

Overview

Creates and manages builds on Google Cloud Platform.

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 godoc.org/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 BuildIterator

    type BuildIterator struct {
    
    	// 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.

          type CallOptions

          type CallOptions struct {
          	CreateBuild        []gax.CallOption
          	GetBuild           []gax.CallOption
          	ListBuilds         []gax.CallOption
          	CancelBuild        []gax.CallOption
          	CreateBuildTrigger []gax.CallOption
          	GetBuildTrigger    []gax.CallOption
          	ListBuildTriggers  []gax.CallOption
          	DeleteBuildTrigger []gax.CallOption
          	UpdateBuildTrigger []gax.CallOption
          	RunBuildTrigger    []gax.CallOption
          	RetryBuild         []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.

            type Client

            type Client struct {
            
            	// The call options for this service.
            	CallOptions *CallOptions
            	// 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.

              func NewClient

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

                NewClient creates a new cloud build client.

                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
                Output:
                
                

                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
                  Output:
                  
                  

                  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 the client's connection to the API service.

                      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
                        Output:
                        
                        

                        func (*Client) CreateBuildTrigger

                          CreateBuildTrigger creates a new BuildTrigger.

                          This API is experimental.

                          Example
                          Output:
                          
                          

                          func (*Client) CreateWorkerPool

                            CreateWorkerPool creates a WorkerPool to run the builds, and returns the new worker pool.

                            This API is experimental.

                            Example
                            Output:
                            
                            

                            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
                              Output:
                              
                              

                              func (*Client) DeleteWorkerPool

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

                                DeleteWorkerPool deletes a WorkerPool by its project ID and WorkerPool name.

                                This API is experimental.

                                Example
                                Output:
                                
                                

                                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
                                  Output:
                                  
                                  

                                  func (*Client) GetBuildTrigger

                                    GetBuildTrigger returns information about a BuildTrigger.

                                    This API is experimental.

                                    Example
                                    Output:
                                    
                                    

                                    func (*Client) GetWorkerPool

                                      GetWorkerPool returns information about a WorkerPool.

                                      This API is experimental.

                                      Example
                                      Output:
                                      
                                      

                                      func (*Client) ListBuildTriggers

                                        ListBuildTriggers lists existing BuildTriggers.

                                        This API is experimental.

                                        Example
                                        Output:
                                        
                                        

                                        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
                                          Output:
                                          
                                          

                                          func (*Client) ListWorkerPools

                                            ListWorkerPools list project's WorkerPools.

                                            This API is experimental.

                                            Example
                                            Output:
                                            
                                            

                                            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
                                              Output:
                                              
                                              

                                              func (*Client) RunBuildTrigger

                                                RunBuildTrigger runs a BuildTrigger at a particular source revision.

                                                Example
                                                Output:
                                                
                                                

                                                func (*Client) UpdateBuildTrigger

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

                                                  This API is experimental.

                                                  Example
                                                  Output:
                                                  
                                                  

                                                  func (*Client) UpdateWorkerPool

                                                    UpdateWorkerPool update a WorkerPool.

                                                    This API is experimental.

                                                    Example
                                                    Output:
                                                    
                                                    

                                                    Directories

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