Documentation

Overview

Package workflowexecutions provides access to the Workflow Executions API.

For product documentation, see: https://cloud.google.com/workflows

Creating a client

Usage example:

import "google.golang.org/api/workflowexecutions/v1beta"
...
ctx := context.Background()
workflowexecutionsService, err := workflowexecutions.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

workflowexecutionsService, err := workflowexecutions.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
workflowexecutionsService, err := workflowexecutions.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

    OAuth2 scopes used by this API.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type CancelExecutionRequest

    type CancelExecutionRequest struct {
    }

      CancelExecutionRequest: Request for the CancelExecution method.

      type Error

      type Error struct {
      	// Context: Human readable stack trace string.
      	Context string `json:"context,omitempty"`
      
      	// Payload: Error message and data returned represented as a JSON
      	// string.
      	Payload string `json:"payload,omitempty"`
      
      	// StackTrace: Stack trace with detailed information of where error was
      	// generated.
      	StackTrace *StackTrace `json:"stackTrace,omitempty"`
      
      	// ForceSendFields is a list of field names (e.g. "Context") to
      	// unconditionally include in API requests. By default, fields with
      	// empty values are omitted from API requests. However, any non-pointer,
      	// non-interface field appearing in ForceSendFields will be sent to the
      	// server regardless of whether the field is empty or not. This may be
      	// used to include empty fields in Patch requests.
      	ForceSendFields []string `json:"-"`
      
      	// NullFields is a list of field names (e.g. "Context") to include in
      	// API requests with the JSON null value. By default, fields with empty
      	// values are omitted from API requests. However, any field with an
      	// empty value appearing in NullFields will be sent to the server as
      	// null. It is an error if a field in this list has a non-empty value.
      	// This may be used to include null fields in Patch requests.
      	NullFields []string `json:"-"`
      }

        Error: Error describes why the execution was abnormally terminated.

        func (*Error) MarshalJSON

        func (s *Error) MarshalJSON() ([]byte, error)

        type Execution

        type Execution struct {
        	// Argument: Input parameters of the execution represented as a JSON
        	// string. The size limit is 32KB. *Note*: If you are using the REST API
        	// directly to run your workflow, you must escape any JSON string value
        	// of `argument`. Example:
        	// `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'`
        	Argument string `json:"argument,omitempty"`
        
        	// EndTime: Output only. Marks the end of execution, successful or not.
        	EndTime string `json:"endTime,omitempty"`
        
        	// Error: Output only. The error which caused the execution to finish
        	// prematurely. The value is only present if the execution's state is
        	// `FAILED` or `CANCELLED`.
        	Error *Error `json:"error,omitempty"`
        
        	// Name: Output only. The resource name of the execution. Format:
        	// projects/{project}/locations/{location}/workflows/{workflow}/execution
        	// s/{execution}
        	Name string `json:"name,omitempty"`
        
        	// Result: Output only. Output of the execution represented as a JSON
        	// string. The value can only be present if the execution's state is
        	// `SUCCEEDED`.
        	Result string `json:"result,omitempty"`
        
        	// StartTime: Output only. Marks the beginning of execution.
        	StartTime string `json:"startTime,omitempty"`
        
        	// State: Output only. Current state of the execution.
        	//
        	// Possible values:
        	//   "STATE_UNSPECIFIED" - Invalid state.
        	//   "ACTIVE" - The execution is in progress.
        	//   "SUCCEEDED" - The execution finished successfully.
        	//   "FAILED" - The execution failed with an error.
        	//   "CANCELLED" - The execution was stopped intentionally.
        	State string `json:"state,omitempty"`
        
        	// WorkflowRevisionId: Output only. Revision of the workflow this
        	// execution is using.
        	WorkflowRevisionId string `json:"workflowRevisionId,omitempty"`
        
        	// ServerResponse contains the HTTP response code and headers from the
        	// server.
        	googleapi.ServerResponse `json:"-"`
        
        	// ForceSendFields is a list of field names (e.g. "Argument") to
        	// unconditionally include in API requests. By default, fields with
        	// empty values are omitted from API requests. However, any non-pointer,
        	// non-interface field appearing in ForceSendFields will be sent to the
        	// server regardless of whether the field is empty or not. This may be
        	// used to include empty fields in Patch requests.
        	ForceSendFields []string `json:"-"`
        
        	// NullFields is a list of field names (e.g. "Argument") to include in
        	// API requests with the JSON null value. By default, fields with empty
        	// values are omitted from API requests. However, any field with an
        	// empty value appearing in NullFields will be sent to the server as
        	// null. It is an error if a field in this list has a non-empty value.
        	// This may be used to include null fields in Patch requests.
        	NullFields []string `json:"-"`
        }

          Execution: A running instance of a Workflow (/workflows/docs/reference/rest/v1beta/projects.locations.workflows).

          func (*Execution) MarshalJSON

          func (s *Execution) MarshalJSON() ([]byte, error)

          type ListExecutionsResponse

          type ListExecutionsResponse struct {
          	// Executions: The executions which match the request.
          	Executions []*Execution `json:"executions,omitempty"`
          
          	// NextPageToken: A token, which can be sent as `page_token` to retrieve
          	// the next page. If this field is omitted, there are no subsequent
          	// pages.
          	NextPageToken string `json:"nextPageToken,omitempty"`
          
          	// ServerResponse contains the HTTP response code and headers from the
          	// server.
          	googleapi.ServerResponse `json:"-"`
          
          	// ForceSendFields is a list of field names (e.g. "Executions") to
          	// unconditionally include in API requests. By default, fields with
          	// empty values are omitted from API requests. However, any non-pointer,
          	// non-interface field appearing in ForceSendFields will be sent to the
          	// server regardless of whether the field is empty or not. This may be
          	// used to include empty fields in Patch requests.
          	ForceSendFields []string `json:"-"`
          
          	// NullFields is a list of field names (e.g. "Executions") to include in
          	// API requests with the JSON null value. By default, fields with empty
          	// values are omitted from API requests. However, any field with an
          	// empty value appearing in NullFields will be sent to the server as
          	// null. It is an error if a field in this list has a non-empty value.
          	// This may be used to include null fields in Patch requests.
          	NullFields []string `json:"-"`
          }

            ListExecutionsResponse: Response for the ListExecutions method.

            func (*ListExecutionsResponse) MarshalJSON

            func (s *ListExecutionsResponse) MarshalJSON() ([]byte, error)

            type ProjectsLocationsService

            type ProjectsLocationsService struct {
            	Workflows *ProjectsLocationsWorkflowsService
            	// contains filtered or unexported fields
            }

            func NewProjectsLocationsService

            func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

            type ProjectsLocationsWorkflowsExecutionsCancelCall

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

            func (*ProjectsLocationsWorkflowsExecutionsCancelCall) Context

              Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

              func (*ProjectsLocationsWorkflowsExecutionsCancelCall) Do

                Do executes the "workflowexecutions.projects.locations.workflows.executions.cancel" call. Exactly one of *Execution or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Execution.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

                func (*ProjectsLocationsWorkflowsExecutionsCancelCall) Fields

                  Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

                  func (*ProjectsLocationsWorkflowsExecutionsCancelCall) Header

                    Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

                    type ProjectsLocationsWorkflowsExecutionsCreateCall

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

                    func (*ProjectsLocationsWorkflowsExecutionsCreateCall) Context

                      Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

                      func (*ProjectsLocationsWorkflowsExecutionsCreateCall) Do

                        Do executes the "workflowexecutions.projects.locations.workflows.executions.create" call. Exactly one of *Execution or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Execution.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

                        func (*ProjectsLocationsWorkflowsExecutionsCreateCall) Fields

                          Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

                          func (*ProjectsLocationsWorkflowsExecutionsCreateCall) Header

                            Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

                            type ProjectsLocationsWorkflowsExecutionsGetCall

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

                            func (*ProjectsLocationsWorkflowsExecutionsGetCall) Context

                              Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

                              func (*ProjectsLocationsWorkflowsExecutionsGetCall) Do

                                Do executes the "workflowexecutions.projects.locations.workflows.executions.get" call. Exactly one of *Execution or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Execution.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

                                func (*ProjectsLocationsWorkflowsExecutionsGetCall) Fields

                                  Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

                                  func (*ProjectsLocationsWorkflowsExecutionsGetCall) Header

                                    Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

                                    func (*ProjectsLocationsWorkflowsExecutionsGetCall) IfNoneMatch

                                      IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

                                      func (*ProjectsLocationsWorkflowsExecutionsGetCall) View

                                        View sets the optional parameter "view": A view defining which fields should be filled in the returned execution. The API will default to the FULL view.

                                        Possible values:

                                        "EXECUTION_VIEW_UNSPECIFIED" - The default / unset value.
                                        "BASIC" - Includes only basic metadata about the execution.
                                        

                                        Following fields are returned: name, start_time, end_time, state and workflow_revision_id.

                                        "FULL" - Includes all data.
                                        

                                        type ProjectsLocationsWorkflowsExecutionsListCall

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

                                        func (*ProjectsLocationsWorkflowsExecutionsListCall) Context

                                          Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

                                          func (*ProjectsLocationsWorkflowsExecutionsListCall) Do

                                            Do executes the "workflowexecutions.projects.locations.workflows.executions.list" call. Exactly one of *ListExecutionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListExecutionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

                                            func (*ProjectsLocationsWorkflowsExecutionsListCall) Fields

                                              Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

                                              func (*ProjectsLocationsWorkflowsExecutionsListCall) Header

                                                Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

                                                func (*ProjectsLocationsWorkflowsExecutionsListCall) IfNoneMatch

                                                  IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

                                                  func (*ProjectsLocationsWorkflowsExecutionsListCall) PageSize

                                                    PageSize sets the optional parameter "pageSize": Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 10000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.

                                                    func (*ProjectsLocationsWorkflowsExecutionsListCall) PageToken

                                                      PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListExecutions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListExecutions` must match the call that provided the page token.

                                                      func (*ProjectsLocationsWorkflowsExecutionsListCall) Pages

                                                        Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

                                                        func (*ProjectsLocationsWorkflowsExecutionsListCall) View

                                                          View sets the optional parameter "view": A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

                                                          Possible values:

                                                          "EXECUTION_VIEW_UNSPECIFIED" - The default / unset value.
                                                          "BASIC" - Includes only basic metadata about the execution.
                                                          

                                                          Following fields are returned: name, start_time, end_time, state and workflow_revision_id.

                                                          "FULL" - Includes all data.
                                                          

                                                          type ProjectsLocationsWorkflowsExecutionsService

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

                                                          func NewProjectsLocationsWorkflowsExecutionsService

                                                          func NewProjectsLocationsWorkflowsExecutionsService(s *Service) *ProjectsLocationsWorkflowsExecutionsService

                                                          func (*ProjectsLocationsWorkflowsExecutionsService) Cancel

                                                            Cancel: Cancels an execution of the given name.

                                                            func (*ProjectsLocationsWorkflowsExecutionsService) Create

                                                              Create: Creates a new execution using the latest revision of the given workflow.

                                                              func (*ProjectsLocationsWorkflowsExecutionsService) Get

                                                                Get: Returns an execution of the given name.

                                                                func (*ProjectsLocationsWorkflowsExecutionsService) List

                                                                  List: 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).

                                                                  type ProjectsLocationsWorkflowsService

                                                                  type ProjectsLocationsWorkflowsService struct {
                                                                  	Executions *ProjectsLocationsWorkflowsExecutionsService
                                                                  	// contains filtered or unexported fields
                                                                  }

                                                                  func NewProjectsLocationsWorkflowsService

                                                                  func NewProjectsLocationsWorkflowsService(s *Service) *ProjectsLocationsWorkflowsService

                                                                  type ProjectsService

                                                                  type ProjectsService struct {
                                                                  	Locations *ProjectsLocationsService
                                                                  	// contains filtered or unexported fields
                                                                  }

                                                                  func NewProjectsService

                                                                  func NewProjectsService(s *Service) *ProjectsService

                                                                  type Service

                                                                  type Service struct {
                                                                  	BasePath  string // API endpoint base URL
                                                                  	UserAgent string // optional additional User-Agent fragment
                                                                  
                                                                  	Projects *ProjectsService
                                                                  	// contains filtered or unexported fields
                                                                  }

                                                                  func New

                                                                  func New(client *http.Client) (*Service, error)

                                                                    New creates a new Service. It uses the provided http.Client for requests.

                                                                    Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

                                                                    func NewService

                                                                    func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

                                                                      NewService creates a new Service.

                                                                      type StackTrace

                                                                      type StackTrace struct {
                                                                      	// Elements: An array of Stack elements.
                                                                      	Elements []*StackTraceElement `json:"elements,omitempty"`
                                                                      
                                                                      	// ForceSendFields is a list of field names (e.g. "Elements") to
                                                                      	// unconditionally include in API requests. By default, fields with
                                                                      	// empty values are omitted from API requests. However, any non-pointer,
                                                                      	// non-interface field appearing in ForceSendFields will be sent to the
                                                                      	// server regardless of whether the field is empty or not. This may be
                                                                      	// used to include empty fields in Patch requests.
                                                                      	ForceSendFields []string `json:"-"`
                                                                      
                                                                      	// NullFields is a list of field names (e.g. "Elements") to include in
                                                                      	// API requests with the JSON null value. By default, fields with empty
                                                                      	// values are omitted from API requests. However, any field with an
                                                                      	// empty value appearing in NullFields will be sent to the server as
                                                                      	// null. It is an error if a field in this list has a non-empty value.
                                                                      	// This may be used to include null fields in Patch requests.
                                                                      	NullFields []string `json:"-"`
                                                                      }

                                                                        StackTrace: A collection of stack elements (frames) where an error occurred.

                                                                        func (*StackTrace) MarshalJSON

                                                                        func (s *StackTrace) MarshalJSON() ([]byte, error)

                                                                        type StackTraceElement

                                                                        type StackTraceElement struct {
                                                                        	// Column: The source code column position (of the line) the current
                                                                        	// instruction was generated from.
                                                                        	Column int64 `json:"column,omitempty,string"`
                                                                        
                                                                        	// Line: The source code line number the current instruction was
                                                                        	// generated from.
                                                                        	Line int64 `json:"line,omitempty,string"`
                                                                        
                                                                        	// Routine: The routine where the error occurred.
                                                                        	Routine string `json:"routine,omitempty"`
                                                                        
                                                                        	// Step: The step the error occurred at.
                                                                        	Step string `json:"step,omitempty"`
                                                                        
                                                                        	// ForceSendFields is a list of field names (e.g. "Column") to
                                                                        	// unconditionally include in API requests. By default, fields with
                                                                        	// empty values are omitted from API requests. However, any non-pointer,
                                                                        	// non-interface field appearing in ForceSendFields will be sent to the
                                                                        	// server regardless of whether the field is empty or not. This may be
                                                                        	// used to include empty fields in Patch requests.
                                                                        	ForceSendFields []string `json:"-"`
                                                                        
                                                                        	// NullFields is a list of field names (e.g. "Column") to include in API
                                                                        	// requests with the JSON null value. By default, fields with empty
                                                                        	// values are omitted from API requests. However, any field with an
                                                                        	// empty value appearing in NullFields will be sent to the server as
                                                                        	// null. It is an error if a field in this list has a non-empty value.
                                                                        	// This may be used to include null fields in Patch requests.
                                                                        	NullFields []string `json:"-"`
                                                                        }

                                                                          StackTraceElement: A single stack element (frame) where an error occurred.

                                                                          func (*StackTraceElement) MarshalJSON

                                                                          func (s *StackTraceElement) MarshalJSON() ([]byte, error)