- 0.116.0 (latest)
- 0.115.1
- 0.114.0
- 0.113.0
- 0.112.2
- 0.111.0
- 0.110.10
- 0.109.0
- 0.108.0
- 0.107.0
- 0.106.0
- 0.105.0
- 0.104.0
- 0.103.0
- 0.102.1
- 0.101.1
- 0.100.2
- 0.99.0
- 0.98.0
- 0.97.0
- 0.96.0
- 0.95.0
- 0.94.1
- 0.93.3
- 0.92.3
- 0.91.1
- 0.90.0
- 0.89.0
- 0.88.0
- 0.87.0
- 0.86.0
- 0.85.0
- 0.84.0
- 0.83.0
- 0.82.0
- 0.81.0
- 0.80.0
- 0.79.0
- 0.78.0
- 0.77.0
- 0.76.0
- 0.75.0
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.
Functions
func DefaultAuthScopes
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type CallOptions struct {
ListExecutions []gax.CallOption
CreateExecution []gax.CallOption
GetExecution []gax.CallOption
CancelExecution []gax.CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type Client struct {
// The call options for this service.
CallOptions *CallOptions
// contains filtered or unexported fields
}
Client is a client for interacting with .
Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
func NewClient
NewClient creates a new executions client.
Executions is used to start and manage running instances of Workflows called executions.
Example
package main
import (
"context"
executions "cloud.google.com/go/workflows/executions/apiv1beta"
)
func main() {
ctx := context.Background()
c, err := executions.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use client.
_ = c
}
func (*Client) CancelExecution
func (c *Client) CancelExecution(ctx context.Context, req *executionspb.CancelExecutionRequest, opts ...gax.CallOption) (*executionspb.Execution, error)
CancelExecution cancels an execution of the given name.
Example
package main
import (
"context"
executions "cloud.google.com/go/workflows/executions/apiv1beta"
executionspb "google.golang.org/genproto/googleapis/cloud/workflows/executions/v1beta"
)
func main() {
// import executionspb "google.golang.org/genproto/googleapis/cloud/workflows/executions/v1beta"
ctx := context.Background()
c, err := executions.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
req := &executionspb.CancelExecutionRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CancelExecution(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) Close
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) CreateExecution
func (c *Client) CreateExecution(ctx context.Context, req *executionspb.CreateExecutionRequest, opts ...gax.CallOption) (*executionspb.Execution, error)
CreateExecution creates a new execution using the latest revision of the given workflow.
Example
package main
import (
"context"
executions "cloud.google.com/go/workflows/executions/apiv1beta"
executionspb "google.golang.org/genproto/googleapis/cloud/workflows/executions/v1beta"
)
func main() {
// import executionspb "google.golang.org/genproto/googleapis/cloud/workflows/executions/v1beta"
ctx := context.Background()
c, err := executions.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
req := &executionspb.CreateExecutionRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateExecution(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetExecution
func (c *Client) GetExecution(ctx context.Context, req *executionspb.GetExecutionRequest, opts ...gax.CallOption) (*executionspb.Execution, error)
GetExecution returns an execution of the given name.
Example
package main
import (
"context"
executions "cloud.google.com/go/workflows/executions/apiv1beta"
executionspb "google.golang.org/genproto/googleapis/cloud/workflows/executions/v1beta"
)
func main() {
// import executionspb "google.golang.org/genproto/googleapis/cloud/workflows/executions/v1beta"
ctx := context.Background()
c, err := executions.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
req := &executionspb.GetExecutionRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetExecution(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) ListExecutions
func (c *Client) ListExecutions(ctx context.Context, req *executionspb.ListExecutionsRequest, opts ...gax.CallOption) *ExecutionIterator
ListExecutions returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).
Example
package main
import (
"context"
executions "cloud.google.com/go/workflows/executions/apiv1beta"
"google.golang.org/api/iterator"
executionspb "google.golang.org/genproto/googleapis/cloud/workflows/executions/v1beta"
)
func main() {
// import executionspb "google.golang.org/genproto/googleapis/cloud/workflows/executions/v1beta"
// import "google.golang.org/api/iterator"
ctx := context.Background()
c, err := executions.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
req := &executionspb.ListExecutionsRequest{
// TODO: Fill request struct fields.
}
it := c.ListExecutions(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
ExecutionIterator
type ExecutionIterator 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 []*executionspb.Execution, nextPageToken string, err error)
// contains filtered or unexported fields
}
ExecutionIterator manages a stream of *executionspb.Execution.
func (*ExecutionIterator) Next
func (it *ExecutionIterator) Next() (*executionspb.Execution, 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 (*ExecutionIterator) PageInfo
func (it *ExecutionIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.