OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the email
// address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)
CancelExecutionRequest: Request for the CancelExecution method.
type CancelExecutionRequest struct {
}
Error: Error describes why the execution was abnormally terminated.
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 or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Error) MarshalJSON() ([]byte, error)
Execution: A running instance of a Workflow (/workflows/docs/reference/rest/v1beta/projects.locations.workflows).
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"`
// CallLogLevel: The call logging level associated to this execution.
//
// Possible values:
// "CALL_LOG_LEVEL_UNSPECIFIED" - No call logging level specified.
// "LOG_ALL_CALLS" - Log all call steps within workflows, all call returns,
// and all exceptions raised.
// "LOG_ERRORS_ONLY" - Log only exceptions that are raised from call steps
// within workflows.
CallLogLevel string `json:"callLogLevel,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}/executions/{exec
// ution}
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.
// "UNAVAILABLE" - Reserved for future use.
// "QUEUED" - Request has been placed in the backlog for processing at a
// later time.
State string `json:"state,omitempty"`
// Status: Output only. Status tracks the current steps and progress data of
// this execution.
Status *Status `json:"status,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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Execution) MarshalJSON() ([]byte, error)
ListExecutionsResponse: Response for the ListExecutions method.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListExecutionsResponse) MarshalJSON() ([]byte, error)
Position: Position contains source position information about the stack trace element such as line number, column number and length of the code block in bytes.
type Position struct {
// Column: The source code column position (of the line) the current
// instruction was generated from.
Column int64 `json:"column,omitempty,string"`
// Length: The number of bytes of source code making up this stack trace
// element.
Length int64 `json:"length,omitempty,string"`
// Line: The source code line number the current instruction was generated
// from.
Line int64 `json:"line,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "Column") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Position) MarshalJSON() ([]byte, error)
type ProjectsLocationsService struct {
Workflows *ProjectsLocationsWorkflowsService
// contains filtered or unexported fields
}
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
type ProjectsLocationsWorkflowsExecutionsCancelCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsWorkflowsExecutionsCancelCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsCancelCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsWorkflowsExecutionsCancelCall) Do(opts ...googleapi.CallOption) (*Execution, error)
Do executes the "workflowexecutions.projects.locations.workflows.executions.cancel" call. 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 (c *ProjectsLocationsWorkflowsExecutionsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkflowsExecutionsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsWorkflowsExecutionsCancelCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsWorkflowsExecutionsCreateCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsWorkflowsExecutionsCreateCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsCreateCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsWorkflowsExecutionsCreateCall) Do(opts ...googleapi.CallOption) (*Execution, error)
Do executes the "workflowexecutions.projects.locations.workflows.executions.create" call. 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 (c *ProjectsLocationsWorkflowsExecutionsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkflowsExecutionsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsWorkflowsExecutionsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type ProjectsLocationsWorkflowsExecutionsGetCall struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsWorkflowsExecutionsGetCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsGetCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsWorkflowsExecutionsGetCall) Do(opts ...googleapi.CallOption) (*Execution, error)
Do executes the "workflowexecutions.projects.locations.workflows.executions.get" call. 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 (c *ProjectsLocationsWorkflowsExecutionsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkflowsExecutionsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsWorkflowsExecutionsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsWorkflowsExecutionsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsWorkflowsExecutionsGetCall
IfNoneMatch sets an 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.
func (c *ProjectsLocationsWorkflowsExecutionsGetCall) View(view string) *ProjectsLocationsWorkflowsExecutionsGetCall
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 struct {
// contains filtered or unexported fields
}
func (c *ProjectsLocationsWorkflowsExecutionsListCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsListCall
Context sets the context to be used in this call's Do method.
func (c *ProjectsLocationsWorkflowsExecutionsListCall) Do(opts ...googleapi.CallOption) (*ListExecutionsResponse, error)
Do executes the "workflowexecutions.projects.locations.workflows.executions.list" call. 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 (c *ProjectsLocationsWorkflowsExecutionsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkflowsExecutionsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *ProjectsLocationsWorkflowsExecutionsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *ProjectsLocationsWorkflowsExecutionsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsWorkflowsExecutionsListCall
IfNoneMatch sets an 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.
func (c *ProjectsLocationsWorkflowsExecutionsListCall) PageSize(pageSize int64) *ProjectsLocationsWorkflowsExecutionsListCall
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 (c *ProjectsLocationsWorkflowsExecutionsListCall) PageToken(pageToken string) *ProjectsLocationsWorkflowsExecutionsListCall
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 (c *ProjectsLocationsWorkflowsExecutionsListCall) Pages(ctx context.Context, f func(*ListExecutionsResponse) error) error
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 (c *ProjectsLocationsWorkflowsExecutionsListCall) View(view string) *ProjectsLocationsWorkflowsExecutionsListCall
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 struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsWorkflowsExecutionsService(s *Service) *ProjectsLocationsWorkflowsExecutionsService
func (r *ProjectsLocationsWorkflowsExecutionsService) Cancel(name string, cancelexecutionrequest *CancelExecutionRequest) *ProjectsLocationsWorkflowsExecutionsCancelCall
Cancel: Cancels an execution of the given name.
func (r *ProjectsLocationsWorkflowsExecutionsService) Create(parent string, execution *Execution) *ProjectsLocationsWorkflowsExecutionsCreateCall
Create: Creates a new execution using the latest revision of the given workflow.
func (r *ProjectsLocationsWorkflowsExecutionsService) Get(name string) *ProjectsLocationsWorkflowsExecutionsGetCall
Get: Returns an execution of the given name.
func (r *ProjectsLocationsWorkflowsExecutionsService) List(parent string) *ProjectsLocationsWorkflowsExecutionsListCall
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 struct {
Executions *ProjectsLocationsWorkflowsExecutionsService
// contains filtered or unexported fields
}
func NewProjectsLocationsWorkflowsService(s *Service) *ProjectsLocationsWorkflowsService
type ProjectsService struct {
Locations *ProjectsLocationsService
// contains filtered or unexported fields
}
func NewProjectsService(s *Service) *ProjectsService
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(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(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
StackTrace: A collection of stack elements (frames) where an error occurred.
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 or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *StackTrace) MarshalJSON() ([]byte, error)
StackTraceElement: A single stack element (frame) where an error occurred.
type StackTraceElement struct {
// Position: The source position information of the stack trace element.
Position *Position `json:"position,omitempty"`
// 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. "Position") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Position") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *StackTraceElement) MarshalJSON() ([]byte, error)
Status: Represents the current status of this execution.
type Status struct {
// CurrentSteps: A list of currently executing or last executed step names for
// the workflow execution currently running. If the workflow has succeeded or
// failed, this is the last attempted or executed step. Presently, if the
// current step is inside a subworkflow, the list only includes that step. In
// the future, the list will contain items for each step in the call stack,
// starting with the outermost step in the `main` subworkflow, and ending with
// the most deeply nested step.
CurrentSteps []*Step `json:"currentSteps,omitempty"`
// ForceSendFields is a list of field names (e.g. "CurrentSteps") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CurrentSteps") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error)
Step: Represents a step of the workflow this execution is running.
type Step struct {
// Routine: Name of a routine within the workflow.
Routine string `json:"routine,omitempty"`
// Step: Name of a step within the routine.
Step string `json:"step,omitempty"`
// ForceSendFields is a list of field names (e.g. "Routine") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Routine") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Step) MarshalJSON() ([]byte, error)