GoogleApi.WorkflowExecutions.V1.Api.Projects (google_api_workflow_executions v0.11.3)

View Source

API calls for all endpoints tagged Projects.

Summary

Functions

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

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

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

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

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

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

Functions

workflowexecutions_projects_locations_workflows_executions_callbacks_list(connection, parent, optional_params \\ [], opts \\ [])

@spec workflowexecutions_projects_locations_workflows_executions_callbacks_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkflowExecutions.V1.Model.ListCallbacksResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.WorkflowExecutions.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Name of the execution for which the callbacks should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Maximum number of callbacks to return per call. The default value is 100 and is also the maximum value.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WorkflowExecutions.V1.Model.ListCallbacksResponse{}} on success
  • {:error, info} on failure

workflowexecutions_projects_locations_workflows_executions_cancel(connection, name, optional_params \\ [], opts \\ [])

@spec workflowexecutions_projects_locations_workflows_executions_cancel(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkflowExecutions.V1.Model.Execution.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Cancels an execution of the given name.

Parameters

  • connection (type: GoogleApi.WorkflowExecutions.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.WorkflowExecutions.V1.Model.CancelExecutionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WorkflowExecutions.V1.Model.Execution{}} on success
  • {:error, info} on failure

workflowexecutions_projects_locations_workflows_executions_create(connection, parent, optional_params \\ [], opts \\ [])

@spec workflowexecutions_projects_locations_workflows_executions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkflowExecutions.V1.Model.Execution.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.WorkflowExecutions.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. 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.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.WorkflowExecutions.V1.Model.Execution.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WorkflowExecutions.V1.Model.Execution{}} on success
  • {:error, info} on failure

workflowexecutions_projects_locations_workflows_executions_delete_execution_history(connection, name, optional_params \\ [], opts \\ [])

@spec workflowexecutions_projects_locations_workflows_executions_delete_execution_history(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkflowExecutions.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes all step entries for an execution.

Parameters

  • connection (type: GoogleApi.WorkflowExecutions.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the execution for which step entries should be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.WorkflowExecutions.V1.Model.DeleteExecutionHistoryRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WorkflowExecutions.V1.Model.Empty{}} on success
  • {:error, info} on failure

workflowexecutions_projects_locations_workflows_executions_export_data(connection, name, optional_params \\ [], opts \\ [])

@spec workflowexecutions_projects_locations_workflows_executions_export_data(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkflowExecutions.V1.Model.ExportDataResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.WorkflowExecutions.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the execution for which data is to be exported. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WorkflowExecutions.V1.Model.ExportDataResponse{}} on success
  • {:error, info} on failure

workflowexecutions_projects_locations_workflows_executions_get(connection, name, optional_params \\ [], opts \\ [])

@spec workflowexecutions_projects_locations_workflows_executions_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkflowExecutions.V1.Model.Execution.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns an execution of the given name.

Parameters

  • connection (type: GoogleApi.WorkflowExecutions.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :view (type: String.t) - Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WorkflowExecutions.V1.Model.Execution{}} on success
  • {:error, info} on failure

workflowexecutions_projects_locations_workflows_executions_list(connection, parent, optional_params \\ [], opts \\ [])

@spec workflowexecutions_projects_locations_workflows_executions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkflowExecutions.V1.Model.ListExecutionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.WorkflowExecutions.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionId, state, createTime, startTime, endTime, duration, workflowRevisionId, stepName, label, and disableConcurrencyQuotaOverflowBuffering. 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"
    • :orderBy (type: String.t) - Optional. 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.
    • :pageSize (type: integer()) - 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.
    • :pageToken (type: String.t) - 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.
    • :view (type: String.t) - Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WorkflowExecutions.V1.Model.ListExecutionsResponse{}} on success
  • {:error, info} on failure

workflowexecutions_projects_locations_workflows_executions_step_entries_get(connection, name, optional_params \\ [], opts \\ [])

@spec workflowexecutions_projects_locations_workflows_executions_step_entries_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkflowExecutions.V1.Model.StepEntry.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a step entry.

Parameters

  • connection (type: GoogleApi.WorkflowExecutions.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the step entry to retrieve. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :view (type: String.t) - Deprecated field.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WorkflowExecutions.V1.Model.StepEntry{}} on success
  • {:error, info} on failure

workflowexecutions_projects_locations_workflows_executions_step_entries_list(connection, parent, optional_params \\ [], opts \\ [])

@spec workflowexecutions_projects_locations_workflows_executions_step_entries_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkflowExecutions.V1.Model.ListStepEntriesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.WorkflowExecutions.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filters applied to the [StepEntries.ListStepEntries] results. The following fields are supported for filtering: entryId, createTime, updateTime, routine, step, stepType, parent, 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"
    • :orderBy (type: String.t) - Optional. 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.
    • :pageSize (type: integer()) - Optional. Number of step entries to return per call. The default max is 1000.
    • :pageToken (type: String.t) - Optional. 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.
    • :skip (type: integer()) - Optional. 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.
    • :view (type: String.t) - Deprecated field.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WorkflowExecutions.V1.Model.ListStepEntriesResponse{}} on success
  • {:error, info} on failure

workflowexecutions_projects_locations_workflows_trigger_pubsub_execution(connection, workflow, optional_params \\ [], opts \\ [])

@spec workflowexecutions_projects_locations_workflows_trigger_pubsub_execution(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.WorkflowExecutions.V1.Model.Execution.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.WorkflowExecutions.V1.Connection.t) - Connection to server
  • workflow (type: String.t) - Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.WorkflowExecutions.V1.Model.TriggerPubsubExecutionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WorkflowExecutions.V1.Model.Execution{}} on success
  • {:error, info} on failure