openstacksdk/openstack/workflow/v2/execution.py

73 lines
2.5 KiB
Python

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from openstack import resource
class Execution(resource.Resource):
resource_key = 'execution'
resources_key = 'executions'
base_path = '/executions'
# capabilities
allow_create = True
allow_list = True
allow_fetch = True
allow_delete = True
_query_mapping = resource.QueryParameters(
'marker',
'limit',
'sort_keys',
'sort_dirs',
'fields',
'params',
'include_output',
)
#: The name of the workflow
workflow_name = resource.Body("workflow_name")
#: The ID of the workflow
workflow_id = resource.Body("workflow_id")
#: A description of the workflow execution
description = resource.Body("description")
#: A reference to the parent task execution
task_execution_id = resource.Body("task_execution_id")
#: Status can be one of: IDLE, RUNNING, SUCCESS, ERROR, or PAUSED
status = resource.Body("state")
#: An optional information string about the status
status_info = resource.Body("state_info")
#: A JSON structure containing workflow input values
# TODO(briancurtin): type=dict
input = resource.Body("input")
#: An optional JSON structure containing workflow type specific parameters
params = resource.Body("params")
#: The output of the workflow
output = resource.Body("output")
#: The time at which the Execution was created
created_at = resource.Body("created_at")
#: The time at which the Execution was updated
updated_at = resource.Body("updated_at")
def create(self, session, prepend_key=True, base_path=None):
request = self._prepare_request(
requires_id=False, prepend_key=prepend_key, base_path=base_path
)
request_body = request.body["execution"]
response = session.post(
request.url, json=request_body, headers=request.headers
)
self._translate_response(response, has_body=True)
return self