Documentation

Overview

Package workflows is an auto-generated package for the Workflows API.

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 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 CallOptions

    type CallOptions struct {
    	ListWorkflows  []gax.CallOption
    	GetWorkflow    []gax.CallOption
    	CreateWorkflow []gax.CallOption
    	DeleteWorkflow []gax.CallOption
    	UpdateWorkflow []gax.CallOption
    }

      CallOptions contains the retry settings for each method of Client.

      type Client

      type Client struct {
      
      	// LROClient is used internally to handle longrunning operations.
      	// It is exposed so that its CallOptions can be modified if required.
      	// Users should not Close this client.
      	LROClient *lroauto.OperationsClient
      
      	// The call options for this service.
      	CallOptions *CallOptions
      	// contains filtered or unexported fields
      }

        Client is a client for interacting with Workflows 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 workflows client.

          Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

          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 a connection to the API service.

              Deprecated.

              func (*Client) CreateWorkflow

                CreateWorkflow creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error.

                Example
                Output:
                
                

                func (*Client) CreateWorkflowOperation

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

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

                  func (*Client) DeleteWorkflow

                    DeleteWorkflow deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.

                    Example
                    Output:
                    
                    

                    func (*Client) DeleteWorkflowOperation

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

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

                      func (*Client) GetWorkflow

                        GetWorkflow gets details of a single Workflow.

                        Example
                        Output:
                        
                        

                        func (*Client) ListWorkflows

                        func (c *Client) ListWorkflows(ctx context.Context, req *workflowspb.ListWorkflowsRequest, opts ...gax.CallOption) *WorkflowIterator

                          ListWorkflows lists Workflows in a given project and location. The default order is not specified.

                          Example
                          Output:
                          
                          

                          func (*Client) UpdateWorkflow

                            UpdateWorkflow updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.

                            Example
                            Output:
                            
                            

                            func (*Client) UpdateWorkflowOperation

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

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

                              type CreateWorkflowOperation

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

                                CreateWorkflowOperation manages a long-running operation from CreateWorkflow.

                                func (*CreateWorkflowOperation) Done

                                func (op *CreateWorkflowOperation) Done() bool

                                  Done reports whether the long-running operation has completed.

                                  func (*CreateWorkflowOperation) 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 (*CreateWorkflowOperation) Name

                                    func (op *CreateWorkflowOperation) 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 (*CreateWorkflowOperation) 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 (*CreateWorkflowOperation) 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.

                                          type DeleteWorkflowOperation

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

                                            DeleteWorkflowOperation manages a long-running operation from DeleteWorkflow.

                                            func (*DeleteWorkflowOperation) Done

                                            func (op *DeleteWorkflowOperation) Done() bool

                                              Done reports whether the long-running operation has completed.

                                              func (*DeleteWorkflowOperation) 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 (*DeleteWorkflowOperation) Name

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

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

                                                    func (op *DeleteWorkflowOperation) 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 UpdateWorkflowOperation

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

                                                        UpdateWorkflowOperation manages a long-running operation from UpdateWorkflow.

                                                        func (*UpdateWorkflowOperation) Done

                                                        func (op *UpdateWorkflowOperation) Done() bool

                                                          Done reports whether the long-running operation has completed.

                                                          func (*UpdateWorkflowOperation) 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 (*UpdateWorkflowOperation) Name

                                                            func (op *UpdateWorkflowOperation) 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 (*UpdateWorkflowOperation) 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 (*UpdateWorkflowOperation) 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.

                                                                  type WorkflowIterator

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

                                                                    WorkflowIterator manages a stream of *workflowspb.Workflow.

                                                                    func (*WorkflowIterator) Next

                                                                    func (it *WorkflowIterator) Next() (*workflowspb.Workflow, 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 (*WorkflowIterator) PageInfo

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

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