Movatterモバイル変換

[0]ホーム
URL:

workflows

package
v1.14.3Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest Published: Sep 22, 2025 License:Apache-2.0Imports:30Imported by:2

Details

Repository

github.com/googleapis/google-cloud-go

Links

Documentation

Overview

Package workflows is an auto-generated package for theWorkflows API.

Manage workflow definitions. To execute workflows and manage executions,see the Workflows Executions API.

General documentation

For information that is relevant for all client libraries please referencehttps://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on thispage includes:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/workflows/apiv1@latestctx := 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_Optionsc, 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, mentioned above.

req := &workflowspb.CreateWorkflowRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/workflows/apiv1/workflowspb#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

Use of Context

The ctx passed to NewClient is used for authentication requests andfor 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.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

funcDefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

Types

typeCallOptions

type CallOptions struct {ListWorkflows         []gax.CallOptionGetWorkflow           []gax.CallOptionCreateWorkflow        []gax.CallOptionDeleteWorkflow        []gax.CallOptionUpdateWorkflow        []gax.CallOptionListWorkflowRevisions []gax.CallOptionGetLocation           []gax.CallOptionListLocations         []gax.CallOptionDeleteOperation       []gax.CallOptionGetOperation          []gax.CallOptionListOperations        []gax.CallOption}

CallOptions contains the retry settings for each method of Client.

typeClient

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 andnetworking interruptions.

funcNewClient

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

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 andnetworking interruptions.

Example
package mainimport ("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_Optionsc, err := workflows.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()// TODO: Use client._ = c}

funcNewRESTClientadded inv1.10.0

func NewRESTClient(ctxcontext.Context, opts ...option.ClientOption) (*Client,error)

NewRESTClient creates a new workflows rest client.

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

Example
package mainimport ("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_Optionsc, err := workflows.NewRESTClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()// TODO: Use client._ = c}

func (*Client)Close

func (c *Client) Close()error

Close closes the connection to the API service. The user should invoke this whenthe client is no longer required.

func (*Client)Connectiondeprecated

func (c *Client) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.

func (*Client)CreateWorkflow

CreateWorkflow creates a new workflow. If a workflow with the specified name alreadyexists in the specified project and location, the long running operationreturns a ALREADY_EXISTS error.

Example
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1"workflowspb "cloud.google.com/go/workflows/apiv1/workflowspb")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_Optionsc, 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/cloud.google.com/go/workflows/apiv1/workflowspb#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(namestring) *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)DeleteOperationadded inv1.12.0

func (c *Client) DeleteOperation(ctxcontext.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption)error

DeleteOperation is a utility method from google.longrunning.Operations.

Example
package mainimport ("context"longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"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_Optionsc, err := workflows.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &longrunningpb.DeleteOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.}err = c.DeleteOperation(ctx, req)if err != nil {// TODO: Handle error.}}

func (*Client)DeleteWorkflow

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

Example
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1"workflowspb "cloud.google.com/go/workflows/apiv1/workflowspb")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_Optionsc, 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/cloud.google.com/go/workflows/apiv1/workflowspb#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(namestring) *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)GetLocationadded inv1.12.0

GetLocation gets information about a location.

Example
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1"locationpb "google.golang.org/genproto/googleapis/cloud/location")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_Optionsc, err := workflows.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &locationpb.GetLocationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.}resp, err := c.GetLocation(ctx, req)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}

func (*Client)GetOperationadded inv1.12.0

GetOperation is a utility method from google.longrunning.Operations.

Example
package mainimport ("context"longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"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_Optionsc, err := workflows.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &longrunningpb.GetOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.}resp, err := c.GetOperation(ctx, req)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}

func (*Client)GetWorkflow

GetWorkflow gets details of a single workflow.

Example
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1"workflowspb "cloud.google.com/go/workflows/apiv1/workflowspb")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_Optionsc, 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/cloud.google.com/go/workflows/apiv1/workflowspb#GetWorkflowRequest.}resp, err := c.GetWorkflow(ctx, req)if err != nil {// TODO: Handle error.}// TODO: Use resp._ = resp}

func (*Client)ListLocationsadded inv1.12.0

ListLocations lists information about the supported locations for this service.

Example
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1""google.golang.org/api/iterator"locationpb "google.golang.org/genproto/googleapis/cloud/location")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_Optionsc, err := workflows.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}it := c.ListLocations(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.(*locationpb.ListLocationsResponse)}}

Example (All)
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1"locationpb "google.golang.org/genproto/googleapis/cloud/location")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_Optionsc, err := workflows.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}for resp, err := range c.ListLocations(ctx, req).All() {if err != nil {// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._ = resp}}

func (*Client)ListOperationsadded inv1.12.0

ListOperations is a utility method from google.longrunning.Operations.

Example
package mainimport ("context"longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"workflows "cloud.google.com/go/workflows/apiv1""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_Optionsc, err := workflows.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}it := c.ListOperations(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.(*longrunningpb.ListOperationsResponse)}}

Example (All)
package mainimport ("context"longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"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_Optionsc, err := workflows.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}for resp, err := range c.ListOperations(ctx, req).All() {if err != nil {// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._ = resp}}

func (*Client)ListWorkflowRevisionsadded inv1.14.0

func (c *Client) ListWorkflowRevisions(ctxcontext.Context, req *workflowspb.ListWorkflowRevisionsRequest, opts ...gax.CallOption) *WorkflowIterator

ListWorkflowRevisions lists revisions for a given workflow.

Example
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1"workflowspb "cloud.google.com/go/workflows/apiv1/workflowspb""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_Optionsc, err := workflows.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &workflowspb.ListWorkflowRevisionsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/workflows/apiv1/workflowspb#ListWorkflowRevisionsRequest.}it := c.ListWorkflowRevisions(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.(*workflowspb.ListWorkflowRevisionsResponse)}}

Example (All)
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1"workflowspb "cloud.google.com/go/workflows/apiv1/workflowspb")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_Optionsc, err := workflows.NewClient(ctx)if err != nil {// TODO: Handle error.}defer c.Close()req := &workflowspb.ListWorkflowRevisionsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/workflows/apiv1/workflowspb#ListWorkflowRevisionsRequest.}for resp, err := range c.ListWorkflowRevisions(ctx, req).All() {if err != nil {// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._ = resp}}

func (*Client)ListWorkflows

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

Example
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1"workflowspb "cloud.google.com/go/workflows/apiv1/workflowspb""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_Optionsc, 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/cloud.google.com/go/workflows/apiv1/workflowspb#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// 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.(*workflowspb.ListWorkflowsResponse)}}

Example (All)
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1"workflowspb "cloud.google.com/go/workflows/apiv1/workflowspb")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_Optionsc, 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/cloud.google.com/go/workflows/apiv1/workflowspb#ListWorkflowsRequest.}for resp, err := range c.ListWorkflows(ctx, req).All() {if err != nil {// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._ = resp}}

func (*Client)UpdateWorkflow

UpdateWorkflow updates an existing workflow.Running this method has no impact on already running executions of theworkflow. A new revision of the workflow might be created as a result of asuccessful update operation. In that case, the new revision is usedin new workflow executions.

Example
package mainimport ("context"workflows "cloud.google.com/go/workflows/apiv1"workflowspb "cloud.google.com/go/workflows/apiv1/workflowspb")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_Optionsc, 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/cloud.google.com/go/workflows/apiv1/workflowspb#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(namestring) *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.

typeCreateWorkflowOperation

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

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 andthe 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.

typeDeleteWorkflowOperation

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

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

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

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

typeLocationIteratoradded inv1.12.0

type LocationIterator 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(pageSizeint, pageTokenstring) (results []*locationpb.Location, nextPageTokenstring, errerror)// contains filtered or unexported fields}

LocationIterator manages a stream of *locationpb.Location.

func (*LocationIterator)Alladded inv1.13.1

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*LocationIterator)Nextadded inv1.12.0

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.

func (*LocationIterator)PageInfoadded inv1.12.0

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

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

typeOperationIteratoradded inv1.12.0

type OperationIterator 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(pageSizeint, pageTokenstring) (results []*longrunningpb.Operation, nextPageTokenstring, errerror)// contains filtered or unexported fields}

OperationIterator manages a stream of *longrunningpb.Operation.

func (*OperationIterator)Alladded inv1.13.1

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*OperationIterator)Nextadded inv1.12.0

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.

func (*OperationIterator)PageInfoadded inv1.12.0

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

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

typeUpdateWorkflowOperation

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

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 andthe 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.

typeWorkflowIterator

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(pageSizeint, pageTokenstring) (results []*workflowspb.Workflow, nextPageTokenstring, errerror)// contains filtered or unexported fields}

WorkflowIterator manages a stream of *workflowspb.Workflow.

func (*WorkflowIterator)Alladded inv1.13.1

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*WorkflowIterator)Next

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. Once Next returns Done, all subsequent calls will return Done.

func (*WorkflowIterator)PageInfo

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

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

Source Files

View all Source files

Directories

PathSynopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.
[8]ページ先頭
©2009-2026 Movatter.jp