workflowexecutions

package
v0.194.0 Latest Latest
Warning

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

 Go to latest Published: Aug 22, 2024 License: BSD-3-Clause Imports: 16 Imported by: 2

Documentation

Overview

Package workflowexecutions provides access to the Workflow Executions API.

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

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/workflowexecutions/v1"
...
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 google.golang.org/api/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 google.golang.org/api/option.WithTokenSource: 

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

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
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"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Callback added in v0.140.0 

type Callback struct {
	// AvailablePayloads: Output only. The payloads received by the callback that
	// have not been processed by a waiting execution step.
	AvailablePayloads []string `json:"availablePayloads,omitempty"`
	// Method: Output only. The method accepted by the callback. For example: GET,
	// POST, PUT.
	Method string `json:"method,omitempty"`
	// Name: Output only. The resource name of the callback. Format:
	// projects/{project}/locations/{location}/workflows/{workflow}/executions/{exec
	// ution}/callback/{callback}
	Name string `json:"name,omitempty"`
	// Waiters: Output only. Number of execution steps waiting on this callback.
	Waiters int64 `json:"waiters,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "AvailablePayloads") 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. "AvailablePayloads") 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:"-"`
}

Callback: An instance of a Callback created by an execution.

func (Callback) MarshalJSON added in v0.140.0 

func (s Callback) MarshalJSON() ([]byte, error)

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 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:"-"`
}

Error: Error describes why the execution was abnormally terminated.

func (Error) MarshalJSON 

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

type Exception added in v0.149.0 

type Exception struct {
	// Payload: Error message represented as a JSON string.
	Payload string `json:"payload,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Payload") 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. "Payload") 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:"-"`
}

Exception: Exception describes why the step entry failed.

func (Exception) MarshalJSON added in v0.149.0 

func (s Exception) 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"`
	// 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.
	//   "LOG_NONE" - Explicitly log nothing.
	CallLogLevel string `json:"callLogLevel,omitempty"`
	// CreateTime: Output only. Marks the creation of the execution.
	CreateTime string `json:"createTime,omitempty"`
	// DisableConcurrencyQuotaOverflowBuffering: Optional. If set to true, the
	// execution will not be backlogged when the concurrency quota is exhausted.
	// The backlog execution starts when the concurrency quota becomes available.
	DisableConcurrencyQuotaOverflowBuffering bool `json:"disableConcurrencyQuotaOverflowBuffering,omitempty"`
	// Duration: Output only. Measures the duration of the execution.
	Duration string `json:"duration,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"`
	// ExecutionHistoryLevel: Optional. Describes the level of the execution
	// history feature to apply to this execution. If not specified, the level of
	// the execution history feature will be determined by its workflow's execution
	// history level. If the value is different from its workflow's value, it will
	// override the workflow's execution history level for this exeuction.
	//
	// Possible values:
	//   "EXECUTION_HISTORY_LEVEL_UNSPECIFIED" - The default/unset value.
	//   "EXECUTION_HISTORY_BASIC" - Enable execution history basic feature for
	// this execution.
	//   "EXECUTION_HISTORY_DETAILED" - Enable execution history detailed feature
	// for this execution.
	ExecutionHistoryLevel string `json:"executionHistoryLevel,omitempty"`
	// Labels: Labels associated with this execution. Labels can contain at most 64
	// entries. Keys and values can be no longer than 63 characters and can only
	// contain lowercase letters, numeric characters, underscores, and dashes.
	// Label keys must start with a letter. International characters are allowed.
	// By default, labels are inherited from the workflow but are overridden by any
	// labels associated with the execution.
	Labels map[string]string `json:"labels,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" - Execution data is unavailable. See the `state_error`
	// field.
	//   "QUEUED" - Request has been placed in the backlog for processing at a
	// later time.
	State string `json:"state,omitempty"`
	// StateError: Output only. Error regarding the state of the Execution
	// resource. For example, this field will have error details if the execution
	// data is unavailable due to revoked KMS key permissions.
	StateError *StateError `json:"stateError,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:"-"`
}

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

func (Execution) MarshalJSON 

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

type ExportDataResponse added in v0.140.0 

type ExportDataResponse struct {
	// Data: The JSON string with customer data and metadata for an execution with
	// the given name
	Data string `json:"data,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Data") 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. "Data") 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:"-"`
}

ExportDataResponse: Response for the ExportData method.

func (ExportDataResponse) MarshalJSON added in v0.140.0 

func (s ExportDataResponse) MarshalJSON() ([]byte, error)

type ListCallbacksResponse added in v0.140.0 

type ListCallbacksResponse struct {
	// Callbacks: The callbacks which match the request.
	Callbacks []*Callback `json:"callbacks,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. "Callbacks") 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. "Callbacks") 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:"-"`
}

ListCallbacksResponse: RPC response object for the ListCallbacks method.

func (ListCallbacksResponse) MarshalJSON added in v0.140.0 

func (s ListCallbacksResponse) 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 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:"-"`
}

ListExecutionsResponse: Response for the ListExecutions method.

func (ListExecutionsResponse) MarshalJSON 

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

type ListStepEntriesResponse added in v0.149.0 

type ListStepEntriesResponse struct {
	// NextPageToken: A token to retrieve next page of results. Pass this value in
	// the ListStepEntriesRequest.page_token field in the subsequent call to
	// `ListStepEntries` method to retrieve the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// StepEntries: The list of entries.
	StepEntries []*StepEntry `json:"stepEntries,omitempty"`
	// TotalSize: Indicates the total number of StepEntries that matched the
	// request filter. For running executions, this number shows the number of
	// StepEntries that are executed thus far.
	TotalSize int64 `json:"totalSize,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") 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. "NextPageToken") 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:"-"`
}

ListStepEntriesResponse: Response message for ExecutionHistory.ListStepEntries.

func (ListStepEntriesResponse) MarshalJSON added in v0.149.0 

func (s ListStepEntriesResponse) MarshalJSON() ([]byte, error)
type NavigationInfo struct {
	// Children: Step entries that can be reached by "stepping into" e.g. a
	// subworkflow call.
	Children googleapi.Int64s `json:"children,omitempty"`
	// Next: The index of the next step in the current workflow, if any.
	Next int64 `json:"next,omitempty,string"`
	// Parent: The step entry, if any, that can be reached by "stepping out" of the
	// current workflow being executed.
	Parent int64 `json:"parent,omitempty,string"`
	// Previous: The index of the previous step in the current workflow, if any.
	Previous int64 `json:"previous,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "Children") 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. "Children") 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:"-"`
}

NavigationInfo: NavigationInfo describes what steps if any come before or after this step, or what steps are parents or children of this step. 

func (s NavigationInfo) MarshalJSON() ([]byte, error)

type Position added in v0.42.0 

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:"-"`
}

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.

func (Position) MarshalJSON added in v0.42.0 

func (s Position) MarshalJSON() ([]byte, error)

type ProjectsLocationsService 

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

func NewProjectsLocationsService 

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

type ProjectsLocationsWorkflowsExecutionsCallbacksListCall added in v0.140.0 

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

func (*ProjectsLocationsWorkflowsExecutionsCallbacksListCall) Context added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsCallbacksListCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsCallbacksListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkflowsExecutionsCallbacksListCall) Do added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsCallbacksListCall) Do(opts ...googleapi.CallOption) (*ListCallbacksResponse, error)

Do executes the "workflowexecutions.projects.locations.workflows.executions.callbacks.list" call. Any non-2xx status code is an error. Response headers are in either *ListCallbacksResponse.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 (*ProjectsLocationsWorkflowsExecutionsCallbacksListCall) Fields added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsCallbacksListCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkflowsExecutionsCallbacksListCall

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

func (*ProjectsLocationsWorkflowsExecutionsCallbacksListCall) Header added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsCallbacksListCall) Header() http.Header

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

func (*ProjectsLocationsWorkflowsExecutionsCallbacksListCall) IfNoneMatch added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsCallbacksListCall) IfNoneMatch(entityTag string) *ProjectsLocationsWorkflowsExecutionsCallbacksListCall

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 (*ProjectsLocationsWorkflowsExecutionsCallbacksListCall) PageSize added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsCallbacksListCall) PageSize(pageSize int64) *ProjectsLocationsWorkflowsExecutionsCallbacksListCall

PageSize sets the optional parameter "pageSize": Maximum number of callbacks to return per call. The default value is 100 and is also the maximum value.

func (*ProjectsLocationsWorkflowsExecutionsCallbacksListCall) PageToken added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsCallbacksListCall) PageToken(pageToken string) *ProjectsLocationsWorkflowsExecutionsCallbacksListCall

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListCallbacks` call. Provide this to retrieve the subsequent page. Note that pagination is applied to dynamic data. The list of callbacks returned can change between page requests if callbacks are created or deleted.

func (*ProjectsLocationsWorkflowsExecutionsCallbacksListCall) Pages added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsCallbacksListCall) Pages(ctx context.Context, f func(*ListCallbacksResponse) 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.

type ProjectsLocationsWorkflowsExecutionsCallbacksService added in v0.140.0 

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

func NewProjectsLocationsWorkflowsExecutionsCallbacksService added in v0.140.0 

func NewProjectsLocationsWorkflowsExecutionsCallbacksService(s *Service) *ProjectsLocationsWorkflowsExecutionsCallbacksService

func (*ProjectsLocationsWorkflowsExecutionsCallbacksService) List added in v0.140.0 

func (r *ProjectsLocationsWorkflowsExecutionsCallbacksService) List(parent string) *ProjectsLocationsWorkflowsExecutionsCallbacksListCall

List: Returns a list of active callbacks that belong to the execution with the given name. The returned callbacks are ordered by callback ID.

  • parent: Name of the execution for which the callbacks should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{ex ecution}.

type ProjectsLocationsWorkflowsExecutionsCancelCall 

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

func (*ProjectsLocationsWorkflowsExecutionsCancelCall) Context 

func (c *ProjectsLocationsWorkflowsExecutionsCancelCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsCancelCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkflowsExecutionsCancelCall) Do 

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 (*ProjectsLocationsWorkflowsExecutionsCancelCall) Fields 

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 (*ProjectsLocationsWorkflowsExecutionsCancelCall) Header 

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 

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

func (*ProjectsLocationsWorkflowsExecutionsCreateCall) Context 

func (c *ProjectsLocationsWorkflowsExecutionsCreateCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkflowsExecutionsCreateCall) Do 

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 (*ProjectsLocationsWorkflowsExecutionsCreateCall) Fields 

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 (*ProjectsLocationsWorkflowsExecutionsCreateCall) Header 

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 ProjectsLocationsWorkflowsExecutionsExportDataCall added in v0.140.0 

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

func (*ProjectsLocationsWorkflowsExecutionsExportDataCall) Context added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsExportDataCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsExportDataCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkflowsExecutionsExportDataCall) Do added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsExportDataCall) Do(opts ...googleapi.CallOption) (*ExportDataResponse, error)

Do executes the "workflowexecutions.projects.locations.workflows.executions.exportData" call. Any non-2xx status code is an error. Response headers are in either *ExportDataResponse.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 (*ProjectsLocationsWorkflowsExecutionsExportDataCall) Fields added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsExportDataCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkflowsExecutionsExportDataCall

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

func (*ProjectsLocationsWorkflowsExecutionsExportDataCall) Header added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsExportDataCall) Header() http.Header

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

func (*ProjectsLocationsWorkflowsExecutionsExportDataCall) IfNoneMatch added in v0.140.0 

func (c *ProjectsLocationsWorkflowsExecutionsExportDataCall) IfNoneMatch(entityTag string) *ProjectsLocationsWorkflowsExecutionsExportDataCall

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.

type ProjectsLocationsWorkflowsExecutionsGetCall 

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

func (*ProjectsLocationsWorkflowsExecutionsGetCall) Context 

func (c *ProjectsLocationsWorkflowsExecutionsGetCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkflowsExecutionsGetCall) Do 

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 (*ProjectsLocationsWorkflowsExecutionsGetCall) Fields 

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 (*ProjectsLocationsWorkflowsExecutionsGetCall) Header 

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 (*ProjectsLocationsWorkflowsExecutionsGetCall) IfNoneMatch 

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 (*ProjectsLocationsWorkflowsExecutionsGetCall) View 

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. The following

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

"FULL" - Includes all data.

type ProjectsLocationsWorkflowsExecutionsListCall 

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

func (*ProjectsLocationsWorkflowsExecutionsListCall) Context 

func (c *ProjectsLocationsWorkflowsExecutionsListCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkflowsExecutionsListCall) Do 

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 (*ProjectsLocationsWorkflowsExecutionsListCall) Fields 

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 (*ProjectsLocationsWorkflowsExecutionsListCall) Filter added in v0.109.0 

func (c *ProjectsLocationsWorkflowsExecutionsListCall) Filter(filter string) *ProjectsLocationsWorkflowsExecutionsListCall

Filter sets the optional parameter "filter": Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For more information, see Filter executions. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED" or `startTime>"2023-08-01" AND state="FAILED"

func (*ProjectsLocationsWorkflowsExecutionsListCall) Header 

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 (*ProjectsLocationsWorkflowsExecutionsListCall) IfNoneMatch 

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 (*ProjectsLocationsWorkflowsExecutionsListCall) OrderBy added in v0.109.0 

func (c *ProjectsLocationsWorkflowsExecutionsListCall) OrderBy(orderBy string) *ProjectsLocationsWorkflowsExecutionsListCall

OrderBy sets the optional parameter "orderBy": Comma-separated list of fields that specify the ordering applied to the `[Executions.ListExecutions]` results. By default the ordering is based on descending `createTime`. The following fields are supported for ordering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, and `workflowRevisionId`. For details, see AIP-132.

func (*ProjectsLocationsWorkflowsExecutionsListCall) PageSize 

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

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. Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

func (*ProjectsLocationsWorkflowsExecutionsListCall) Pages 

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 (*ProjectsLocationsWorkflowsExecutionsListCall) View 

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. The following

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

"FULL" - Includes all data.

type ProjectsLocationsWorkflowsExecutionsService 

type ProjectsLocationsWorkflowsExecutionsService struct {
	Callbacks *ProjectsLocationsWorkflowsExecutionsCallbacksService

	StepEntries *ProjectsLocationsWorkflowsExecutionsStepEntriesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsWorkflowsExecutionsService 

func NewProjectsLocationsWorkflowsExecutionsService(s *Service) *ProjectsLocationsWorkflowsExecutionsService

func (*ProjectsLocationsWorkflowsExecutionsService) Cancel 

func (r *ProjectsLocationsWorkflowsExecutionsService) Cancel(name string, cancelexecutionrequest *CancelExecutionRequest) *ProjectsLocationsWorkflowsExecutionsCancelCall

Cancel: Cancels an execution of the given name.

  • name: Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{ex ecution}.

func (*ProjectsLocationsWorkflowsExecutionsService) Create 

func (r *ProjectsLocationsWorkflowsExecutionsService) Create(parent string, execution *Execution) *ProjectsLocationsWorkflowsExecutionsCreateCall

Create: Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow.

  • parent: Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.

func (*ProjectsLocationsWorkflowsExecutionsService) ExportData added in v0.140.0 

func (r *ProjectsLocationsWorkflowsExecutionsService) ExportData(name string) *ProjectsLocationsWorkflowsExecutionsExportDataCall

ExportData: Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.

  • name: Name of the execution for which data is to be exported. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{ex ecution}.

func (*ProjectsLocationsWorkflowsExecutionsService) Get 

func (r *ProjectsLocationsWorkflowsExecutionsService) Get(name string) *ProjectsLocationsWorkflowsExecutionsGetCall

Get: Returns an execution of the given name.

  • name: Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{ex ecution}.

func (*ProjectsLocationsWorkflowsExecutionsService) List 

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

  • parent: Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}.

type ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall added in v0.149.0 

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

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall) Context added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall) Do added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall) Do(opts ...googleapi.CallOption) (*StepEntry, error)

Do executes the "workflowexecutions.projects.locations.workflows.executions.stepEntries.get" call. Any non-2xx status code is an error. Response headers are in either *StepEntry.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 (*ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall) Fields added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall

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

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall) Header added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall) Header() http.Header

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

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall) IfNoneMatch added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall

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.

type ProjectsLocationsWorkflowsExecutionsStepEntriesListCall added in v0.149.0 

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

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Context added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Do added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Do(opts ...googleapi.CallOption) (*ListStepEntriesResponse, error)

Do executes the "workflowexecutions.projects.locations.workflows.executions.stepEntries.list" call. Any non-2xx status code is an error. Response headers are in either *ListStepEntriesResponse.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 (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Fields added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall

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

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Filter added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Filter(filter string) *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall

Filter sets the optional parameter "filter": Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED" or `createTime>"2023-08-01" AND state="FAILED"

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Header added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Header() http.Header

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

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) IfNoneMatch added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall

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 (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) OrderBy added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) OrderBy(orderBy string) *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall

OrderBy sets the optional parameter "orderBy": Comma-separated list of fields that specify the ordering applied to the `[StepEntries.ListStepEntries]` results. By default the ordering is based on ascending `entryId`. The following fields are supported for ordering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-132.

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) PageSize added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) PageSize(pageSize int64) *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall

PageSize sets the optional parameter "pageSize": Number of step entries to return per call. The default max is 1000.

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) PageToken added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) PageToken(pageToken string) *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall

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

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Pages added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Pages(ctx context.Context, f func(*ListStepEntriesResponse) 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 (*ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Skip added in v0.149.0 

func (c *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall) Skip(skip int64) *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall

Skip sets the optional parameter "skip": The number of step entries to skip. It can be used with or without a pageToken. If used with a pageToken, then it indicates the number of step entries to skip starting from the requested page.

type ProjectsLocationsWorkflowsExecutionsStepEntriesService added in v0.149.0 

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

func NewProjectsLocationsWorkflowsExecutionsStepEntriesService added in v0.149.0 

func NewProjectsLocationsWorkflowsExecutionsStepEntriesService(s *Service) *ProjectsLocationsWorkflowsExecutionsStepEntriesService

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesService) Get added in v0.149.0 

func (r *ProjectsLocationsWorkflowsExecutionsStepEntriesService) Get(name string) *ProjectsLocationsWorkflowsExecutionsStepEntriesGetCall

Get: Gets a step entry.

  • name: The name of the step entry to retrieve. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{ex ecution}/stepEntries/{step_entry}.

func (*ProjectsLocationsWorkflowsExecutionsStepEntriesService) List added in v0.149.0 

func (r *ProjectsLocationsWorkflowsExecutionsStepEntriesService) List(parent string) *ProjectsLocationsWorkflowsExecutionsStepEntriesListCall

List: Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.

  • parent: Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{ex ecution}/stepEntries/.

type ProjectsLocationsWorkflowsService 

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

func NewProjectsLocationsWorkflowsService 

func NewProjectsLocationsWorkflowsService(s *Service) *ProjectsLocationsWorkflowsService

func (*ProjectsLocationsWorkflowsService) TriggerPubsubExecution added in v0.74.0 

func (r *ProjectsLocationsWorkflowsService) TriggerPubsubExecution(workflow string, triggerpubsubexecutionrequest *TriggerPubsubExecutionRequest) *ProjectsLocationsWorkflowsTriggerPubsubExecutionCall

TriggerPubsubExecution: Triggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification.

  • workflow: Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow}.

type ProjectsLocationsWorkflowsTriggerPubsubExecutionCall added in v0.74.0 

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

func (*ProjectsLocationsWorkflowsTriggerPubsubExecutionCall) Context added in v0.74.0 

func (c *ProjectsLocationsWorkflowsTriggerPubsubExecutionCall) Context(ctx context.Context) *ProjectsLocationsWorkflowsTriggerPubsubExecutionCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsWorkflowsTriggerPubsubExecutionCall) Do added in v0.74.0 

func (c *ProjectsLocationsWorkflowsTriggerPubsubExecutionCall) Do(opts ...googleapi.CallOption) (*Execution, error)

Do executes the "workflowexecutions.projects.locations.workflows.triggerPubsubExecution" 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 (*ProjectsLocationsWorkflowsTriggerPubsubExecutionCall) Fields added in v0.74.0 

func (c *ProjectsLocationsWorkflowsTriggerPubsubExecutionCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkflowsTriggerPubsubExecutionCall

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

func (*ProjectsLocationsWorkflowsTriggerPubsubExecutionCall) Header added in v0.74.0 

func (c *ProjectsLocationsWorkflowsTriggerPubsubExecutionCall) Header() http.Header

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

type ProjectsService 

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

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type PubsubMessage added in v0.74.0 

type PubsubMessage struct {
	// Attributes: Optional. Attributes for this message. If this field is empty,
	// the message must contain non-empty data. This can be used to filter messages
	// on the subscription.
	Attributes map[string]string `json:"attributes,omitempty"`
	// Data: Optional. The message data field. If this field is empty, the message
	// must contain at least one attribute.
	Data string `json:"data,omitempty"`
	// MessageId: ID of this message, assigned by the server when the message is
	// published. Guaranteed to be unique within the topic. This value may be read
	// by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push
	// delivery. It must not be populated by the publisher in a `Publish` call.
	MessageId string `json:"messageId,omitempty"`
	// OrderingKey: Optional. If non-empty, identifies related messages for which
	// publish order should be respected. If a `Subscription` has
	// `enable_message_ordering` set to `true`, messages published with the same
	// non-empty `ordering_key` value will be delivered to subscribers in the order
	// in which they are received by the Pub/Sub system. All `PubsubMessage`s
	// published in a given `PublishRequest` must specify the same `ordering_key`
	// value. For more information, see ordering messages
	// (https://cloud.google.com/pubsub/docs/ordering).
	OrderingKey string `json:"orderingKey,omitempty"`
	// PublishTime: The time at which the message was published, populated by the
	// server when it receives the `Publish` call. It must not be populated by the
	// publisher in a `Publish` call.
	PublishTime string `json:"publishTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Attributes") 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. "Attributes") 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:"-"`
}

PubsubMessage: A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation (https://cloud.google.com/pubsub/docs/reference/libraries) for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.

func (PubsubMessage) MarshalJSON added in v0.74.0 

func (s PubsubMessage) MarshalJSON() ([]byte, error)

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 deprecated 

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 added in v0.42.0 

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:"-"`
}

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

func (StackTrace) MarshalJSON added in v0.42.0 

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

type StackTraceElement added in v0.42.0 

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:"-"`
}

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

func (StackTraceElement) MarshalJSON added in v0.42.0 

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

type StateError added in v0.117.0 

type StateError struct {
	// Details: Provides specifics about the error.
	Details string `json:"details,omitempty"`
	// Type: The type of this state error.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - No type specified.
	//   "KMS_ERROR" - Caused by an issue with KMS.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Details") 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. "Details") 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:"-"`
}

StateError: Describes an error related to the current state of the Execution resource.

func (StateError) MarshalJSON added in v0.117.0 

func (s StateError) MarshalJSON() ([]byte, error)

type Status added in v0.97.0 

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:"-"`
}

Status: Represents the current status of this execution.

func (Status) MarshalJSON added in v0.97.0 

func (s Status) MarshalJSON() ([]byte, error)

type Step added in v0.97.0 

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:"-"`
}

Step: Represents a step of the workflow this execution is running.

func (Step) MarshalJSON added in v0.97.0 

func (s Step) MarshalJSON() ([]byte, error)

type StepEntry added in v0.149.0 

type StepEntry struct {
	// CreateTime: Output only. The creation time of the step entry.
	CreateTime string `json:"createTime,omitempty"`
	// EntryId: Output only. The numeric ID of this step entry, used for
	// navigation.
	EntryId int64 `json:"entryId,omitempty,string"`
	// Exception: Output only. The exception thrown by the step entry.
	Exception *Exception `json:"exception,omitempty"`
	// Name: Output only. The full resource name of the step entry. Each step entry
	// has a unique entry ID, which is a monotonically increasing counter. Step
	// entry names have the format:
	// `projects/{project}/locations/{location}/workflows/{workflow}/executions/{exe
	// cution}/stepEntries/{step_entry}`.
	Name string `json:"name,omitempty"`
	// NavigationInfo: Output only. The NavigationInfo associated to this step.
	NavigationInfo *NavigationInfo `json:"navigationInfo,omitempty"`
	// Routine: Output only. The name of the routine this step entry belongs to. A
	// routine name is the subworkflow name defined in the YAML source code. The
	// top level routine name is `main`.
	Routine string `json:"routine,omitempty"`
	// State: Output only. The state of the step entry.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Invalid state.
	//   "STATE_IN_PROGRESS" - The step entry is in progress.
	//   "STATE_SUCCEEDED" - The step entry finished successfully.
	//   "STATE_FAILED" - The step entry failed with an error.
	State string `json:"state,omitempty"`
	// Step: Output only. The name of the step this step entry belongs to.
	Step string `json:"step,omitempty"`
	// StepEntryMetadata: Output only. The StepEntryMetadata associated to this
	// step.
	StepEntryMetadata *StepEntryMetadata `json:"stepEntryMetadata,omitempty"`
	// StepType: Output only. The type of the step this step entry belongs to.
	//
	// Possible values:
	//   "STEP_TYPE_UNSPECIFIED" - Invalid step type.
	//   "STEP_ASSIGN" - The step entry assigns new variable(s).
	//   "STEP_STD_LIB_CALL" - The step entry calls a standard library routine.
	//   "STEP_CONNECTOR_CALL" - The step entry calls a connector.
	//   "STEP_SUBWORKFLOW_CALL" - The step entry calls a subworklfow.
	//   "STEP_CALL" - The step entry calls a subworkflow/stdlib.
	//   "STEP_SWITCH" - The step entry executes a switch-case block.
	//   "STEP_CONDITION" - The step entry executes a condition inside a switch.
	//   "STEP_FOR" - The step entry executes a for loop.
	//   "STEP_FOR_ITERATION" - The step entry executes a iteration of a for loop.
	//   "STEP_PARALLEL_FOR" - The step entry executes a parallel for loop.
	//   "STEP_PARALLEL_BRANCH" - The step entry executes a series of parallel
	// branch(es).
	//   "STEP_PARALLEL_BRANCH_ENTRY" - The step entry executes a branch of a
	// parallel branch.
	//   "STEP_TRY_RETRY_EXCEPT" - The step entry executes a try/retry/except
	// block.
	//   "STEP_TRY" - The step entry executes the try part of a try/retry/except
	// block.
	//   "STEP_RETRY" - The step entry executes the retry part of a
	// try/retry/except block.
	//   "STEP_EXCEPT" - The step entry executes the except part of a
	// try/retry/except block.
	//   "STEP_RETURN" - The step entry returns.
	//   "STEP_RAISE" - The step entry raises an error.
	//   "STEP_GOTO" - The step entry jumps to another step.
	StepType string `json:"stepType,omitempty"`
	// UpdateTime: Output only. The most recently updated time of the step entry.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"`
}

StepEntry: An StepEntry contains debugging information for a step transition in a workflow execution.

func (StepEntry) MarshalJSON added in v0.149.0 

func (s StepEntry) MarshalJSON() ([]byte, error)

type StepEntryMetadata added in v0.149.0 

type StepEntryMetadata struct {
	// ExpectedIteration: Expected iteration represents the expected number of
	// iterations in the step's progress.
	ExpectedIteration int64 `json:"expectedIteration,omitempty,string"`
	// ProgressNumber: Progress number represents the current state of the current
	// progress. eg: A step entry represents the 4th iteration in a progress of
	// PROGRESS_TYPE_FOR.
	ProgressNumber int64 `json:"progressNumber,omitempty,string"`
	// ProgressType: Progress type of this step entry.
	//
	// Possible values:
	//   "PROGRESS_TYPE_UNSPECIFIED" - Current step entry does not have any
	// progress data.
	//   "PROGRESS_TYPE_FOR" - Current step entry is in progress of a FOR step.
	//   "PROGRESS_TYPE_SWITCH" - Current step entry is in progress of a SWITCH
	// step.
	//   "PROGRESS_TYPE_RETRY" - Current step entry is in progress of a RETRY step.
	//   "PROGRESS_TYPE_PARALLEL_FOR" - Current step entry is in progress of a
	// PARALLEL FOR step.
	//   "PROGRESS_TYPE_PARALLEL_BRANCH" - Current step entry is in progress of a
	// PARALLEL BRANCH step.
	ProgressType string `json:"progressType,omitempty"`
	// ThreadId: Child thread id that this step entry belongs to.
	ThreadId string `json:"threadId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpectedIteration") 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. "ExpectedIteration") 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:"-"`
}

StepEntryMetadata: StepEntryMetadata contains metadata information about this step.

func (StepEntryMetadata) MarshalJSON added in v0.149.0 

func (s StepEntryMetadata) MarshalJSON() ([]byte, error)

type TriggerPubsubExecutionRequest added in v0.74.0 

type TriggerPubsubExecutionRequest struct {
	// GCPCloudEventsMode: Required. LINT: LEGACY_NAMES The query parameter value
	// for __GCP_CloudEventsMode, set by the Eventarc service when configuring
	// triggers.
	GCPCloudEventsMode string `json:"GCPCloudEventsMode,omitempty"`
	// DeliveryAttempt: The number of attempts that have been made to deliver this
	// message. This is set by Pub/Sub for subscriptions that have the "dead
	// letter" feature enabled, and hence provided here for compatibility, but is
	// ignored by Workflows.
	DeliveryAttempt int64 `json:"deliveryAttempt,omitempty"`
	// Message: Required. The message of the Pub/Sub push notification.
	Message *PubsubMessage `json:"message,omitempty"`
	// Subscription: Required. The subscription of the Pub/Sub push notification.
	// Format: projects/{project}/subscriptions/{sub}
	Subscription string `json:"subscription,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GCPCloudEventsMode") 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. "GCPCloudEventsMode") 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:"-"`
}

TriggerPubsubExecutionRequest: Request for the TriggerPubsubExecution method.

func (TriggerPubsubExecutionRequest) MarshalJSON added in v0.74.0 

func (s TriggerPubsubExecutionRequest) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.