Package workflows is an auto-generated package for the Workflows API.
Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.
Example usage
To get started with this package, create a client.
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 := workflows . 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 () // 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 := workflows . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & workflowspb . ListWorkflowsRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/workflows/v1#ListWorkflowsRequest. } it := c . ListWorkflows ( ctx , req ) for { resp , err := it . Next () if err == iterator . Done { break } 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.
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.
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 Workflows API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.
func NewClient
NewClient creates a new workflows client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.
Example
package
main
import
(
"context"
workflows
"cloud.google.com/go/workflows/apiv1"
)
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
:=
workflows
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
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) CreateWorkflow
func
(
c
*
Client
)
CreateWorkflow
(
ctx
context
.
Context
,
req
*
workflowspb
.
CreateWorkflowRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateWorkflowOperation
,
error
)
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
package
main
import
(
"context"
workflows
"cloud.google.com/go/workflows/apiv1"
workflowspb
"google.golang.org/genproto/googleapis/cloud/workflows/v1"
)
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
:=
workflows
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& workflowspb
.
CreateWorkflowRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/workflows/v1#CreateWorkflowRequest.
}
op
,
err
:=
c
.
CreateWorkflow
(
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) 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
func
(
c
*
Client
)
DeleteWorkflow
(
ctx
context
.
Context
,
req
*
workflowspb
.
DeleteWorkflowRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteWorkflowOperation
,
error
)
DeleteWorkflow deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.
Example
package
main
import
(
"context"
workflows
"cloud.google.com/go/workflows/apiv1"
workflowspb
"google.golang.org/genproto/googleapis/cloud/workflows/v1"
)
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
:=
workflows
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& workflowspb
.
DeleteWorkflowRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/workflows/v1#DeleteWorkflowRequest.
}
op
,
err
:=
c
.
DeleteWorkflow
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
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
func
(
c
*
Client
)
GetWorkflow
(
ctx
context
.
Context
,
req
*
workflowspb
.
GetWorkflowRequest
,
opts
...
gax
.
CallOption
)
(
*
workflowspb
.
Workflow
,
error
)
GetWorkflow gets details of a single Workflow.
Example
package
main
import
(
"context"
workflows
"cloud.google.com/go/workflows/apiv1"
workflowspb
"google.golang.org/genproto/googleapis/cloud/workflows/v1"
)
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
:=
workflows
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& workflowspb
.
GetWorkflowRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/workflows/v1#GetWorkflowRequest.
}
resp
,
err
:=
c
.
GetWorkflow
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
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
package
main
import
(
"context"
workflows
"cloud.google.com/go/workflows/apiv1"
"google.golang.org/api/iterator"
workflowspb
"google.golang.org/genproto/googleapis/cloud/workflows/v1"
)
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
:=
workflows
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& workflowspb
.
ListWorkflowsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/workflows/v1#ListWorkflowsRequest.
}
it
:=
c
.
ListWorkflows
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) UpdateWorkflow
func
(
c
*
Client
)
UpdateWorkflow
(
ctx
context
.
Context
,
req
*
workflowspb
.
UpdateWorkflowRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateWorkflowOperation
,
error
)
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
package
main
import
(
"context"
workflows
"cloud.google.com/go/workflows/apiv1"
workflowspb
"google.golang.org/genproto/googleapis/cloud/workflows/v1"
)
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
:=
workflows
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& workflowspb
.
UpdateWorkflowRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/workflows/v1#UpdateWorkflowRequest.
}
op
,
err
:=
c
.
UpdateWorkflow
(
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) 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.
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
func
(
op
*
CreateWorkflowOperation
)
Metadata
()
(
*
workflowspb
.
OperationMetadata
,
error
)
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
func
(
op
*
CreateWorkflowOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
workflowspb
.
Workflow
,
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 (*CreateWorkflowOperation) Wait
func
(
op
*
CreateWorkflowOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
workflowspb
.
Workflow
,
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.
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
func
(
op
*
DeleteWorkflowOperation
)
Metadata
()
(
*
workflowspb
.
OperationMetadata
,
error
)
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.
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
func
(
op
*
UpdateWorkflowOperation
)
Metadata
()
(
*
workflowspb
.
OperationMetadata
,
error
)
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
func
(
op
*
UpdateWorkflowOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
workflowspb
.
Workflow
,
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 (*UpdateWorkflowOperation) Wait
func
(
op
*
UpdateWorkflowOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
workflowspb
.
Workflow
,
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.
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.
