Package executions is an auto-generated package for the Workflow Executions API.
Manages user-provided workflows.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview . Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/workflows/executions/apiv1beta@latest ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := executions . 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, mentioned above.
req := & executionspb . CancelExecutionRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/workflows/executions/apiv1beta/executionspb#CancelExecutionRequest. } resp , err := c . CancelExecution ( ctx , req ) 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.
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 Workflow Executions API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Executions is used to start and manage running instances of Workflows called executions.
func NewClient
NewClient creates a new executions client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
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
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
executions
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewRESTClient
NewRESTClient creates a new executions rest 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
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
executions
.
NewRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// 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
"cloud.google.com/go/workflows/executions/apiv1beta/executionspb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
executions
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& executionspb
.
CancelExecutionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/workflows/executions/apiv1beta/executionspb#CancelExecutionRequest.
}
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 (deprecated)
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
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
"cloud.google.com/go/workflows/executions/apiv1beta/executionspb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
executions
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& executionspb
.
CreateExecutionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/workflows/executions/apiv1beta/executionspb#CreateExecutionRequest.
}
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
"cloud.google.com/go/workflows/executions/apiv1beta/executionspb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
executions
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& executionspb
.
GetExecutionRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/workflows/executions/apiv1beta/executionspb#GetExecutionRequest.
}
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).
Examples
package
main
import
(
"context"
executions
"cloud.google.com/go/workflows/executions/apiv1beta"
executionspb
"cloud.google.com/go/workflows/executions/apiv1beta/executionspb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
executions
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& executionspb
.
ListExecutionsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/workflows/executions/apiv1beta/executionspb#ListExecutionsRequest.
}
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
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
executionspb
.
ListExecutionsResponse
)
}
}
all
package
main
import
(
"context"
executions
"cloud.google.com/go/workflows/executions/apiv1beta"
executionspb
"cloud.google.com/go/workflows/executions/apiv1beta/executionspb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
executions
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& executionspb
.
ListExecutionsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/workflows/executions/apiv1beta/executionspb#ListExecutionsRequest.
}
for
resp
,
err
:=
range
c
.
ListExecutions
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any 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) All
func
(
it
*
ExecutionIterator
)
All
()
iter
.
Seq2
[
*
executionspb
.
Execution
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
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.
