workflowexecutions

package
v0.136.0 Latest Latest
Warning

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

 Go to latest Published: Aug 8, 2023 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

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 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 (
	// 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 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. 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"`

	// 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"`

	// 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"`

	// 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}/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.
	//   "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. 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/v1/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 or default 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 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. 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:"-"`
}

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 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsWorkflowsExecutionsCancelCall) Do 

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

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 

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

func (*ProjectsLocationsWorkflowsExecutionsCancelCall) Header 

func (c *ProjectsLocationsWorkflowsExecutionsCancelCall) Header() http.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 

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

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 

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

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 

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

func (*ProjectsLocationsWorkflowsExecutionsCreateCall) Header 

func (c *ProjectsLocationsWorkflowsExecutionsCreateCall) Header() http.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 

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

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 

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

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 

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

func (*ProjectsLocationsWorkflowsExecutionsGetCall) Header 

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

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

func (*ProjectsLocationsWorkflowsExecutionsGetCall) IfNoneMatch 

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

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 

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsWorkflowsExecutionsListCall) Do 

func (c *ProjectsLocationsWorkflowsExecutionsListCall) Do(opts ...googleapi.CallOption) (*ListExecutionsResponse, error)

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 

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

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, startTime, endTime, duration, workflowRevisionID, stepName, and label.

func (*ProjectsLocationsWorkflowsExecutionsListCall) Header 

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

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

func (*ProjectsLocationsWorkflowsExecutionsListCall) IfNoneMatch 

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

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

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

OrderBy sets the optional parameter "orderBy": The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.

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 {
	// 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}/executi ons/{execution}.

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.

  • 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) 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}/executi ons/{execution}.

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 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. Any pending HTTP request will be aborted if the provided context is canceled.

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. 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 (*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 information.

func (*ProjectsLocationsWorkflowsTriggerPubsubExecutionCall) Header added in v0.74.0 

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

Header returns an http.Header that can be modified by the caller to add HTTP 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: Optional. 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: Optional. 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. 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. "Attributes") 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:"-"`
}

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. 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 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. 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. "Position") 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 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. 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. "Details") 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:"-"`
}

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

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

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

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.