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

API calls for all endpoints tagged Projects.

Summary

Functions

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

Cancels an execution of the given name.

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

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

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

Returns an execution of the given name.

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

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

Functions

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.V1beta.Model.Execution.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Cancels an execution of the given name.

Parameters

connection (type: GoogleApi.WorkflowExecutions.V1beta.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.V1beta.Model.CancelExecutionRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WorkflowExecutions.V1beta.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.V1beta.Model.Execution.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

connection (type: GoogleApi.WorkflowExecutions.V1beta.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.V1beta.Model.Execution.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.WorkflowExecutions.V1beta.Model.Execution{}} 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.V1beta.Model.Execution.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns an execution of the given name.

Parameters

connection (type: GoogleApi.WorkflowExecutions.V1beta.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.V1beta.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.V1beta.Model.ListExecutionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.WorkflowExecutions.V1beta.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").
- :pageSize (type: integer()) - Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 10000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.
- :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.
- :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.V1beta.Model.ListExecutionsResponse{}} on success
{:error, info} on failure