cloudreactor_api_client 0.1.0.pre
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE.txt +21 -0
- data/README.md +92 -0
- data/cloudreactor_api_client.md +226 -0
- data/lib/cloudreactor_api_client/api/alert_methods_api.rb +482 -0
- data/lib/cloudreactor_api_client/api/email_notification_profiles_api.rb +482 -0
- data/lib/cloudreactor_api_client/api/pagerduty_profiles_api.rb +482 -0
- data/lib/cloudreactor_api_client/api/run_environments_api.rb +479 -0
- data/lib/cloudreactor_api_client/api/task_executions_api.rb +409 -0
- data/lib/cloudreactor_api_client/api/tasks_api.rb +412 -0
- data/lib/cloudreactor_api_client/api/workflow_executions_api.rb +549 -0
- data/lib/cloudreactor_api_client/api/workflow_task_instances_api.rb +424 -0
- data/lib/cloudreactor_api_client/api/workflow_transitions_api.rb +406 -0
- data/lib/cloudreactor_api_client/api/workflows_api.rb +482 -0
- data/lib/cloudreactor_api_client/api_client.rb +390 -0
- data/lib/cloudreactor_api_client/api_error.rb +57 -0
- data/lib/cloudreactor_api_client/configuration.rb +277 -0
- data/lib/cloudreactor_api_client/models/alert_method.rb +449 -0
- data/lib/cloudreactor_api_client/models/aws_ecs_execution_method.rb +517 -0
- data/lib/cloudreactor_api_client/models/aws_ecs_execution_method_capability.rb +565 -0
- data/lib/cloudreactor_api_client/models/aws_ecs_launch_type.rb +37 -0
- data/lib/cloudreactor_api_client/models/aws_ecs_run_environment_execution_method_capability.rb +476 -0
- data/lib/cloudreactor_api_client/models/aws_ecs_service_load_balancer_details.rb +307 -0
- data/lib/cloudreactor_api_client/models/aws_ecs_service_options.rb +308 -0
- data/lib/cloudreactor_api_client/models/current_service_info.rb +255 -0
- data/lib/cloudreactor_api_client/models/email_notification_profile.rb +454 -0
- data/lib/cloudreactor_api_client/models/execution_method_capability.rb +54 -0
- data/lib/cloudreactor_api_client/models/failure_behavior_enum.rb +38 -0
- data/lib/cloudreactor_api_client/models/group.rb +268 -0
- data/lib/cloudreactor_api_client/models/link.rb +301 -0
- data/lib/cloudreactor_api_client/models/name_and_uuid.rb +236 -0
- data/lib/cloudreactor_api_client/models/notification_severity.rb +39 -0
- data/lib/cloudreactor_api_client/models/pager_duty_profile.rb +484 -0
- data/lib/cloudreactor_api_client/models/paginated_alert_method_list.rb +247 -0
- data/lib/cloudreactor_api_client/models/paginated_email_notification_profile_list.rb +247 -0
- data/lib/cloudreactor_api_client/models/paginated_pager_duty_profile_list.rb +247 -0
- data/lib/cloudreactor_api_client/models/paginated_run_environment_list.rb +247 -0
- data/lib/cloudreactor_api_client/models/paginated_task_execution_list.rb +247 -0
- data/lib/cloudreactor_api_client/models/paginated_task_list.rb +247 -0
- data/lib/cloudreactor_api_client/models/paginated_workflow_execution_summary_list.rb +247 -0
- data/lib/cloudreactor_api_client/models/paginated_workflow_summary_list.rb +247 -0
- data/lib/cloudreactor_api_client/models/paginated_workflow_task_instance_list.rb +247 -0
- data/lib/cloudreactor_api_client/models/paginated_workflow_transition_list.rb +247 -0
- data/lib/cloudreactor_api_client/models/patched_alert_method.rb +405 -0
- data/lib/cloudreactor_api_client/models/patched_email_notification_profile.rb +415 -0
- data/lib/cloudreactor_api_client/models/patched_pager_duty_profile.rb +436 -0
- data/lib/cloudreactor_api_client/models/patched_run_environment.rb +511 -0
- data/lib/cloudreactor_api_client/models/patched_task.rb +897 -0
- data/lib/cloudreactor_api_client/models/patched_task_execution.rb +1904 -0
- data/lib/cloudreactor_api_client/models/patched_workflow.rb +507 -0
- data/lib/cloudreactor_api_client/models/patched_workflow_execution.rb +559 -0
- data/lib/cloudreactor_api_client/models/patched_workflow_task_instance.rb +676 -0
- data/lib/cloudreactor_api_client/models/patched_workflow_transition.rb +432 -0
- data/lib/cloudreactor_api_client/models/propagate_tags_enum.rb +37 -0
- data/lib/cloudreactor_api_client/models/rule_type_enum.rb +43 -0
- data/lib/cloudreactor_api_client/models/run_environment.rb +555 -0
- data/lib/cloudreactor_api_client/models/start_transition_condition_enum.rb +39 -0
- data/lib/cloudreactor_api_client/models/stop_reason_enum.rb +42 -0
- data/lib/cloudreactor_api_client/models/task.rb +941 -0
- data/lib/cloudreactor_api_client/models/task_execution.rb +1954 -0
- data/lib/cloudreactor_api_client/models/task_execution_status.rb +46 -0
- data/lib/cloudreactor_api_client/models/threshold_property_enum.rb +39 -0
- data/lib/cloudreactor_api_client/models/timeout_behavior_enum.rb +40 -0
- data/lib/cloudreactor_api_client/models/unknown_execution_method_capability.rb +238 -0
- data/lib/cloudreactor_api_client/models/workflow.rb +556 -0
- data/lib/cloudreactor_api_client/models/workflow_execution.rb +629 -0
- data/lib/cloudreactor_api_client/models/workflow_execution_status.rb +42 -0
- data/lib/cloudreactor_api_client/models/workflow_execution_summary.rb +523 -0
- data/lib/cloudreactor_api_client/models/workflow_summary.rb +513 -0
- data/lib/cloudreactor_api_client/models/workflow_task_instance.rb +715 -0
- data/lib/cloudreactor_api_client/models/workflow_task_instance_execution.rb +280 -0
- data/lib/cloudreactor_api_client/models/workflow_task_instance_execution_base.rb +270 -0
- data/lib/cloudreactor_api_client/models/workflow_transition.rb +467 -0
- data/lib/cloudreactor_api_client/models/workflow_transition_evaluation.rb +280 -0
- data/lib/cloudreactor_api_client/version.rb +15 -0
- data/lib/cloudreactor_api_client.rb +121 -0
- data/lib/cloudreactor_wrapper_io/status_updater.rb +124 -0
- data/lib/cloudreactor_wrapper_io.rb +13 -0
- data/spec/api/alert_methods_api_spec.rb +114 -0
- data/spec/api/email_notification_profiles_api_spec.rb +114 -0
- data/spec/api/pagerduty_profiles_api_spec.rb +114 -0
- data/spec/api/run_environments_api_spec.rb +113 -0
- data/spec/api/task_executions_api_spec.rb +102 -0
- data/spec/api/tasks_api_spec.rb +103 -0
- data/spec/api/workflow_executions_api_spec.rb +124 -0
- data/spec/api/workflow_task_instances_api_spec.rb +107 -0
- data/spec/api/workflow_transitions_api_spec.rb +101 -0
- data/spec/api/workflows_api_spec.rb +114 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/integration/task_execution_integration_spec.rb +51 -0
- data/spec/models/alert_method_spec.rb +136 -0
- data/spec/models/aws_ecs_execution_method_capability_spec.rb +166 -0
- data/spec/models/aws_ecs_execution_method_spec.rb +148 -0
- data/spec/models/aws_ecs_launch_type_spec.rb +28 -0
- data/spec/models/aws_ecs_run_environment_execution_method_capability_spec.rb +130 -0
- data/spec/models/aws_ecs_service_load_balancer_details_spec.rb +46 -0
- data/spec/models/aws_ecs_service_options_spec.rb +88 -0
- data/spec/models/current_service_info_spec.rb +52 -0
- data/spec/models/email_notification_profile_spec.rb +118 -0
- data/spec/models/execution_method_capability_spec.rb +43 -0
- data/spec/models/failure_behavior_enum_spec.rb +28 -0
- data/spec/models/group_spec.rb +46 -0
- data/spec/models/link_spec.rb +70 -0
- data/spec/models/name_and_uuid_spec.rb +46 -0
- data/spec/models/notification_severity_spec.rb +28 -0
- data/spec/models/pager_duty_profile_spec.rb +118 -0
- data/spec/models/paginated_alert_method_list_spec.rb +52 -0
- data/spec/models/paginated_email_notification_profile_list_spec.rb +52 -0
- data/spec/models/paginated_pager_duty_profile_list_spec.rb +52 -0
- data/spec/models/paginated_run_environment_list_spec.rb +52 -0
- data/spec/models/paginated_task_execution_list_spec.rb +52 -0
- data/spec/models/paginated_task_list_spec.rb +52 -0
- data/spec/models/paginated_workflow_execution_summary_list_spec.rb +52 -0
- data/spec/models/paginated_workflow_summary_list_spec.rb +52 -0
- data/spec/models/paginated_workflow_task_instance_list_spec.rb +52 -0
- data/spec/models/paginated_workflow_transition_list_spec.rb +52 -0
- data/spec/models/patched_alert_method_spec.rb +136 -0
- data/spec/models/patched_email_notification_profile_spec.rb +118 -0
- data/spec/models/patched_pager_duty_profile_spec.rb +118 -0
- data/spec/models/patched_run_environment_spec.rb +136 -0
- data/spec/models/patched_task_execution_spec.rb +466 -0
- data/spec/models/patched_task_spec.rb +244 -0
- data/spec/models/patched_workflow_execution_spec.rb +172 -0
- data/spec/models/patched_workflow_spec.rb +142 -0
- data/spec/models/patched_workflow_task_instance_spec.rb +196 -0
- data/spec/models/patched_workflow_transition_spec.rb +118 -0
- data/spec/models/propagate_tags_enum_spec.rb +28 -0
- data/spec/models/rule_type_enum_spec.rb +28 -0
- data/spec/models/run_environment_spec.rb +136 -0
- data/spec/models/start_transition_condition_enum_spec.rb +28 -0
- data/spec/models/stop_reason_enum_spec.rb +28 -0
- data/spec/models/task_execution_spec.rb +466 -0
- data/spec/models/task_execution_status_spec.rb +28 -0
- data/spec/models/task_spec.rb +244 -0
- data/spec/models/threshold_property_enum_spec.rb +28 -0
- data/spec/models/timeout_behavior_enum_spec.rb +28 -0
- data/spec/models/unknown_execution_method_capability_spec.rb +40 -0
- data/spec/models/workflow_execution_spec.rb +172 -0
- data/spec/models/workflow_execution_status_spec.rb +28 -0
- data/spec/models/workflow_execution_summary_spec.rb +130 -0
- data/spec/models/workflow_spec.rb +142 -0
- data/spec/models/workflow_summary_spec.rb +124 -0
- data/spec/models/workflow_task_instance_execution_base_spec.rb +58 -0
- data/spec/models/workflow_task_instance_execution_spec.rb +64 -0
- data/spec/models/workflow_task_instance_spec.rb +196 -0
- data/spec/models/workflow_transition_evaluation_spec.rb +64 -0
- data/spec/models/workflow_transition_spec.rb +118 -0
- data/spec/spec_helper.rb +111 -0
- data/spec/wrapper_io/status_updater_spec.rb +147 -0
- metadata +305 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 70a23d1b882b2f0e0defd662b2ad5aef5d6d3856e4a1ff127a88c152bd8f00fd
|
4
|
+
data.tar.gz: e8746eff50901c569017ef66590e27d32caf2b1440ab2de79082e5867a965aae
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d3a5e8c9b4fde170a079c712bf554b62df83356598b1dd81472da461ad937cb4932e72bfca0d7007d496a3c8419e1cf8a40f69d19c3f079453d3abc03a62912c
|
7
|
+
data.tar.gz: 8574978d6be09200716ed455e45d790cc111440057f3a4ea4501247635db86f657640020844bb25b3503ef2b14a4b8454e61eb36b486b74e84cee02c84fa3a86
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
Copyright (c) 2022, CloudReactor, Inc.
|
2
|
+
|
3
|
+
Redistribution and use in source and binary forms, with or without
|
4
|
+
modification, are permitted provided that the following conditions are met:
|
5
|
+
|
6
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
7
|
+
list of conditions and the following disclaimer.
|
8
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
9
|
+
this list of conditions and the following disclaimer in the documentation
|
10
|
+
and/or other materials provided with the distribution.
|
11
|
+
|
12
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
13
|
+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
14
|
+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
15
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
16
|
+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
17
|
+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
18
|
+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
19
|
+
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
20
|
+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
21
|
+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
data/README.md
ADDED
@@ -0,0 +1,92 @@
|
|
1
|
+
# cloudreactor-ruby-client-wrapperio
|
2
|
+
|
3
|
+

|
4
|
+

|
5
|
+
|
6
|
+
## Overview
|
7
|
+
|
8
|
+
This Ruby gem consists of 2 parts:
|
9
|
+
|
10
|
+
1) The CloudReactor API client allows ruby applications to programmatically
|
11
|
+
create, monitor, and manage Tasks and Workflows. Most notably you can start and stop
|
12
|
+
Tasks and Workflows by creating Task Executions and Workflow Executions.
|
13
|
+
|
14
|
+
2) The Wrapper I/O module allows ruby applications to communicate with the
|
15
|
+
[CloudReactor wrapper](https://github.com/CloudReactor/cloudreactor-procwrapper)
|
16
|
+
which is the parent process.
|
17
|
+
|
18
|
+
See the [CloudReactor landing page](https://www.cloudreactor.io/) to see the
|
19
|
+
benefits of monitoring and managing your tasks with CloudReactor.
|
20
|
+
|
21
|
+
## API client
|
22
|
+
|
23
|
+
The API client allows your program to control various entities in CloudReactor,
|
24
|
+
most notable Tasks and Workflows. The code and
|
25
|
+
[documentation](cloudreactor_api_client.md) are generated by
|
26
|
+
[OpenAPI generator](https://github.com/OpenAPITools/openapi-generator).
|
27
|
+
|
28
|
+
To start an existing Task, create a TaskExecution linked to the Task, with a
|
29
|
+
status of `CloudReactorAPIClient::TaskExecutionStatus::MANUALLY_STARTED`:
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
config = CloudReactorAPIClient::Configuration.new
|
33
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
34
|
+
api_client = CloudReactorAPIClient::ApiClient.new(config)
|
35
|
+
|
36
|
+
task = CloudReactorAPIClient::NameAndUuid.new
|
37
|
+
task.name = 'Sample Task'
|
38
|
+
task_execution = CloudReactorAPIClient::TaskExecution.new
|
39
|
+
task_execution.task = task
|
40
|
+
task_execution.status = CloudReactorAPIClient::TaskExecutionStatus::MANUALLY_STARTED
|
41
|
+
te_api = CloudReactorAPIClient::TaskExecutionsApi.new(api_client)
|
42
|
+
te_api.task_executions_create(task_execution)
|
43
|
+
```
|
44
|
+
|
45
|
+
## Wrapper I/O
|
46
|
+
|
47
|
+
While running a ruby process that is wrapped by the CloudReactor proc_wrapper,
|
48
|
+
you can use `CloudReactorWrapperIO::StatusUpdater` to
|
49
|
+
send updates about your process to the wrapper. The wrapper will send those
|
50
|
+
updates to the CloudReactor API server during its next heartbeat.
|
51
|
+
Updates can include:
|
52
|
+
|
53
|
+
* success count
|
54
|
+
* error count
|
55
|
+
* skipped count
|
56
|
+
* expected count
|
57
|
+
* last status message
|
58
|
+
* any additional properties that can be serialized into JSON
|
59
|
+
|
60
|
+
Updates are communicated via a local UDP socket which means they are
|
61
|
+
theoretically unreliable. However, in practice, updates are almost always
|
62
|
+
picked up correctly.
|
63
|
+
|
64
|
+
### Example usage
|
65
|
+
|
66
|
+
```ruby
|
67
|
+
# Use the environment variables
|
68
|
+
# PROC_WRAPPER_ENABLE_STATUS_UPDATE_LISTENER
|
69
|
+
# PROC_WRAPPER_STATUS_UPDATE_SOCKET_PORT
|
70
|
+
# PROC_WRAPPER_STATUS_UPDATE_SOCKET_BIND_PORT
|
71
|
+
# to determine configuration. These environment variables are typically passed
|
72
|
+
# to the proc_wrapper module which then passes them on to your process.
|
73
|
+
status_updater = new CloudReactorWrapperIO::StatusUpdater()
|
74
|
+
|
75
|
+
begin
|
76
|
+
status_updater.send_update(
|
77
|
+
success_count: 1,
|
78
|
+
error_count: 2,
|
79
|
+
last_status_message: 'running'
|
80
|
+
)
|
81
|
+
ensure
|
82
|
+
status_updater.close()
|
83
|
+
end
|
84
|
+
```
|
85
|
+
|
86
|
+
## More documentation
|
87
|
+
|
88
|
+
* [CloudReactor API documentation](https://apidocs.cloudreactor.io/)
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
This project is covered by the [BSD 2-clause license](https://opensource.org/licenses/BSD-2-Clause).
|
@@ -0,0 +1,226 @@
|
|
1
|
+
# cloudreactor_api_client
|
2
|
+
|
3
|
+
CloudReactorAPIClient - the Ruby gem for the CloudReactor API
|
4
|
+
|
5
|
+
CloudReactor API Documentation
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 0.2.0
|
10
|
+
- Package version: 0.1.0.pre
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
For more information, please visit [https://cloudreactor.io/](https://cloudreactor.io/)
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
### Build a gem
|
17
|
+
|
18
|
+
To build the Ruby code into a gem:
|
19
|
+
|
20
|
+
```shell
|
21
|
+
gem build cloudreactor_api_client.gemspec
|
22
|
+
```
|
23
|
+
|
24
|
+
Then either install the gem locally:
|
25
|
+
|
26
|
+
```shell
|
27
|
+
gem install ./cloudreactor_api_client-0.1.0.pre.gem
|
28
|
+
```
|
29
|
+
|
30
|
+
(for development, run `gem install --dev ./cloudreactor_api_client-0.1.0.pre.gem` to install the development dependencies)
|
31
|
+
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
|
+
|
34
|
+
Finally add this to the Gemfile:
|
35
|
+
|
36
|
+
gem 'cloudreactor_api_client', '~> 0.1.0.pre'
|
37
|
+
|
38
|
+
### Install from Git
|
39
|
+
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
41
|
+
|
42
|
+
gem 'cloudreactor_api_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
43
|
+
|
44
|
+
### Include the Ruby code directly
|
45
|
+
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
47
|
+
|
48
|
+
```shell
|
49
|
+
ruby -Ilib script.rb
|
50
|
+
```
|
51
|
+
|
52
|
+
## Getting Started
|
53
|
+
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
# Load the gem
|
58
|
+
require 'cloudreactor_api_client'
|
59
|
+
|
60
|
+
# Setup authorization
|
61
|
+
CloudReactorAPIClient.configure do |config|
|
62
|
+
# Configure API key authorization: tokenAuth
|
63
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
64
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
65
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
66
|
+
end
|
67
|
+
|
68
|
+
api_instance = CloudReactorAPIClient::AlertMethodsApi.new
|
69
|
+
uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
70
|
+
alert_method = CloudReactorAPIClient::AlertMethod.new({url: 'url_example', uuid: 'uuid_example', name: 'name_example', dashboard_url: 'dashboard_url_example', method_details: { key: 3.56}, created_by_user: 'created_by_user_example', created_by_group: CloudReactorAPIClient::Group.new({id: 37, name: 'name_example', url: 'url_example'}), created_at: Time.now, updated_at: Time.now}) # AlertMethod |
|
71
|
+
|
72
|
+
begin
|
73
|
+
result = api_instance.alert_methods_clone_create(uuid, alert_method)
|
74
|
+
p result
|
75
|
+
rescue CloudReactorAPIClient::ApiError => e
|
76
|
+
puts "Exception when calling AlertMethodsApi->alert_methods_clone_create: #{e}"
|
77
|
+
end
|
78
|
+
|
79
|
+
```
|
80
|
+
|
81
|
+
## Documentation for API Endpoints
|
82
|
+
|
83
|
+
All URIs are relative to *https://api.cloudreactor.io/api/v1*
|
84
|
+
|
85
|
+
Class | Method | HTTP request | Description
|
86
|
+
------------ | ------------- | ------------- | -------------
|
87
|
+
*CloudReactorAPIClient::AlertMethodsApi* | [**alert_methods_clone_create**](docs/AlertMethodsApi.md#alert_methods_clone_create) | **POST** /alert_methods/{uuid}/clone/ |
|
88
|
+
*CloudReactorAPIClient::AlertMethodsApi* | [**alert_methods_create**](docs/AlertMethodsApi.md#alert_methods_create) | **POST** /alert_methods/ |
|
89
|
+
*CloudReactorAPIClient::AlertMethodsApi* | [**alert_methods_destroy**](docs/AlertMethodsApi.md#alert_methods_destroy) | **DELETE** /alert_methods/{uuid}/ |
|
90
|
+
*CloudReactorAPIClient::AlertMethodsApi* | [**alert_methods_list**](docs/AlertMethodsApi.md#alert_methods_list) | **GET** /alert_methods/ |
|
91
|
+
*CloudReactorAPIClient::AlertMethodsApi* | [**alert_methods_partial_update**](docs/AlertMethodsApi.md#alert_methods_partial_update) | **PATCH** /alert_methods/{uuid}/ |
|
92
|
+
*CloudReactorAPIClient::AlertMethodsApi* | [**alert_methods_retrieve**](docs/AlertMethodsApi.md#alert_methods_retrieve) | **GET** /alert_methods/{uuid}/ |
|
93
|
+
*CloudReactorAPIClient::AlertMethodsApi* | [**alert_methods_update**](docs/AlertMethodsApi.md#alert_methods_update) | **PUT** /alert_methods/{uuid}/ |
|
94
|
+
*CloudReactorAPIClient::EmailNotificationProfilesApi* | [**email_notification_profiles_clone_create**](docs/EmailNotificationProfilesApi.md#email_notification_profiles_clone_create) | **POST** /email_notification_profiles/{uuid}/clone/ |
|
95
|
+
*CloudReactorAPIClient::EmailNotificationProfilesApi* | [**email_notification_profiles_create**](docs/EmailNotificationProfilesApi.md#email_notification_profiles_create) | **POST** /email_notification_profiles/ |
|
96
|
+
*CloudReactorAPIClient::EmailNotificationProfilesApi* | [**email_notification_profiles_destroy**](docs/EmailNotificationProfilesApi.md#email_notification_profiles_destroy) | **DELETE** /email_notification_profiles/{uuid}/ |
|
97
|
+
*CloudReactorAPIClient::EmailNotificationProfilesApi* | [**email_notification_profiles_list**](docs/EmailNotificationProfilesApi.md#email_notification_profiles_list) | **GET** /email_notification_profiles/ |
|
98
|
+
*CloudReactorAPIClient::EmailNotificationProfilesApi* | [**email_notification_profiles_partial_update**](docs/EmailNotificationProfilesApi.md#email_notification_profiles_partial_update) | **PATCH** /email_notification_profiles/{uuid}/ |
|
99
|
+
*CloudReactorAPIClient::EmailNotificationProfilesApi* | [**email_notification_profiles_retrieve**](docs/EmailNotificationProfilesApi.md#email_notification_profiles_retrieve) | **GET** /email_notification_profiles/{uuid}/ |
|
100
|
+
*CloudReactorAPIClient::EmailNotificationProfilesApi* | [**email_notification_profiles_update**](docs/EmailNotificationProfilesApi.md#email_notification_profiles_update) | **PUT** /email_notification_profiles/{uuid}/ |
|
101
|
+
*CloudReactorAPIClient::PagerdutyProfilesApi* | [**pagerduty_profiles_clone_create**](docs/PagerdutyProfilesApi.md#pagerduty_profiles_clone_create) | **POST** /pagerduty_profiles/{uuid}/clone/ |
|
102
|
+
*CloudReactorAPIClient::PagerdutyProfilesApi* | [**pagerduty_profiles_create**](docs/PagerdutyProfilesApi.md#pagerduty_profiles_create) | **POST** /pagerduty_profiles/ |
|
103
|
+
*CloudReactorAPIClient::PagerdutyProfilesApi* | [**pagerduty_profiles_destroy**](docs/PagerdutyProfilesApi.md#pagerduty_profiles_destroy) | **DELETE** /pagerduty_profiles/{uuid}/ |
|
104
|
+
*CloudReactorAPIClient::PagerdutyProfilesApi* | [**pagerduty_profiles_list**](docs/PagerdutyProfilesApi.md#pagerduty_profiles_list) | **GET** /pagerduty_profiles/ |
|
105
|
+
*CloudReactorAPIClient::PagerdutyProfilesApi* | [**pagerduty_profiles_partial_update**](docs/PagerdutyProfilesApi.md#pagerduty_profiles_partial_update) | **PATCH** /pagerduty_profiles/{uuid}/ |
|
106
|
+
*CloudReactorAPIClient::PagerdutyProfilesApi* | [**pagerduty_profiles_retrieve**](docs/PagerdutyProfilesApi.md#pagerduty_profiles_retrieve) | **GET** /pagerduty_profiles/{uuid}/ |
|
107
|
+
*CloudReactorAPIClient::PagerdutyProfilesApi* | [**pagerduty_profiles_update**](docs/PagerdutyProfilesApi.md#pagerduty_profiles_update) | **PUT** /pagerduty_profiles/{uuid}/ |
|
108
|
+
*CloudReactorAPIClient::RunEnvironmentsApi* | [**run_environments_clone_create**](docs/RunEnvironmentsApi.md#run_environments_clone_create) | **POST** /run_environments/{uuid}/clone/ |
|
109
|
+
*CloudReactorAPIClient::RunEnvironmentsApi* | [**run_environments_create**](docs/RunEnvironmentsApi.md#run_environments_create) | **POST** /run_environments/ |
|
110
|
+
*CloudReactorAPIClient::RunEnvironmentsApi* | [**run_environments_destroy**](docs/RunEnvironmentsApi.md#run_environments_destroy) | **DELETE** /run_environments/{uuid}/ |
|
111
|
+
*CloudReactorAPIClient::RunEnvironmentsApi* | [**run_environments_list**](docs/RunEnvironmentsApi.md#run_environments_list) | **GET** /run_environments/ |
|
112
|
+
*CloudReactorAPIClient::RunEnvironmentsApi* | [**run_environments_partial_update**](docs/RunEnvironmentsApi.md#run_environments_partial_update) | **PATCH** /run_environments/{uuid}/ |
|
113
|
+
*CloudReactorAPIClient::RunEnvironmentsApi* | [**run_environments_retrieve**](docs/RunEnvironmentsApi.md#run_environments_retrieve) | **GET** /run_environments/{uuid}/ |
|
114
|
+
*CloudReactorAPIClient::RunEnvironmentsApi* | [**run_environments_update**](docs/RunEnvironmentsApi.md#run_environments_update) | **PUT** /run_environments/{uuid}/ |
|
115
|
+
*CloudReactorAPIClient::TaskExecutionsApi* | [**task_executions_create**](docs/TaskExecutionsApi.md#task_executions_create) | **POST** /task_executions/ |
|
116
|
+
*CloudReactorAPIClient::TaskExecutionsApi* | [**task_executions_destroy**](docs/TaskExecutionsApi.md#task_executions_destroy) | **DELETE** /task_executions/{uuid}/ |
|
117
|
+
*CloudReactorAPIClient::TaskExecutionsApi* | [**task_executions_list**](docs/TaskExecutionsApi.md#task_executions_list) | **GET** /task_executions/ |
|
118
|
+
*CloudReactorAPIClient::TaskExecutionsApi* | [**task_executions_partial_update**](docs/TaskExecutionsApi.md#task_executions_partial_update) | **PATCH** /task_executions/{uuid}/ |
|
119
|
+
*CloudReactorAPIClient::TaskExecutionsApi* | [**task_executions_retrieve**](docs/TaskExecutionsApi.md#task_executions_retrieve) | **GET** /task_executions/{uuid}/ |
|
120
|
+
*CloudReactorAPIClient::TaskExecutionsApi* | [**task_executions_update**](docs/TaskExecutionsApi.md#task_executions_update) | **PUT** /task_executions/{uuid}/ |
|
121
|
+
*CloudReactorAPIClient::TasksApi* | [**tasks_create**](docs/TasksApi.md#tasks_create) | **POST** /tasks/ |
|
122
|
+
*CloudReactorAPIClient::TasksApi* | [**tasks_destroy**](docs/TasksApi.md#tasks_destroy) | **DELETE** /tasks/{uuid}/ |
|
123
|
+
*CloudReactorAPIClient::TasksApi* | [**tasks_list**](docs/TasksApi.md#tasks_list) | **GET** /tasks/ |
|
124
|
+
*CloudReactorAPIClient::TasksApi* | [**tasks_partial_update**](docs/TasksApi.md#tasks_partial_update) | **PATCH** /tasks/{uuid}/ |
|
125
|
+
*CloudReactorAPIClient::TasksApi* | [**tasks_retrieve**](docs/TasksApi.md#tasks_retrieve) | **GET** /tasks/{uuid}/ |
|
126
|
+
*CloudReactorAPIClient::TasksApi* | [**tasks_update**](docs/TasksApi.md#tasks_update) | **PUT** /tasks/{uuid}/ |
|
127
|
+
*CloudReactorAPIClient::WorkflowExecutionsApi* | [**workflow_executions_create**](docs/WorkflowExecutionsApi.md#workflow_executions_create) | **POST** /workflow_executions/ |
|
128
|
+
*CloudReactorAPIClient::WorkflowExecutionsApi* | [**workflow_executions_destroy**](docs/WorkflowExecutionsApi.md#workflow_executions_destroy) | **DELETE** /workflow_executions/{uuid}/ |
|
129
|
+
*CloudReactorAPIClient::WorkflowExecutionsApi* | [**workflow_executions_list**](docs/WorkflowExecutionsApi.md#workflow_executions_list) | **GET** /workflow_executions/ |
|
130
|
+
*CloudReactorAPIClient::WorkflowExecutionsApi* | [**workflow_executions_partial_update**](docs/WorkflowExecutionsApi.md#workflow_executions_partial_update) | **PATCH** /workflow_executions/{uuid}/ |
|
131
|
+
*CloudReactorAPIClient::WorkflowExecutionsApi* | [**workflow_executions_retrieve**](docs/WorkflowExecutionsApi.md#workflow_executions_retrieve) | **GET** /workflow_executions/{uuid}/ |
|
132
|
+
*CloudReactorAPIClient::WorkflowExecutionsApi* | [**workflow_executions_retry_create**](docs/WorkflowExecutionsApi.md#workflow_executions_retry_create) | **POST** /workflow_executions/{uuid}/retry/ |
|
133
|
+
*CloudReactorAPIClient::WorkflowExecutionsApi* | [**workflow_executions_update**](docs/WorkflowExecutionsApi.md#workflow_executions_update) | **PUT** /workflow_executions/{uuid}/ |
|
134
|
+
*CloudReactorAPIClient::WorkflowExecutionsApi* | [**workflow_executions_workflow_task_instance_executions_create**](docs/WorkflowExecutionsApi.md#workflow_executions_workflow_task_instance_executions_create) | **POST** /workflow_executions/{uuid}/workflow_task_instance_executions/ |
|
135
|
+
*CloudReactorAPIClient::WorkflowTaskInstancesApi* | [**workflow_task_instances_create**](docs/WorkflowTaskInstancesApi.md#workflow_task_instances_create) | **POST** /workflow_task_instances/ |
|
136
|
+
*CloudReactorAPIClient::WorkflowTaskInstancesApi* | [**workflow_task_instances_destroy**](docs/WorkflowTaskInstancesApi.md#workflow_task_instances_destroy) | **DELETE** /workflow_task_instances/{uuid}/ |
|
137
|
+
*CloudReactorAPIClient::WorkflowTaskInstancesApi* | [**workflow_task_instances_list**](docs/WorkflowTaskInstancesApi.md#workflow_task_instances_list) | **GET** /workflow_task_instances/ |
|
138
|
+
*CloudReactorAPIClient::WorkflowTaskInstancesApi* | [**workflow_task_instances_partial_update**](docs/WorkflowTaskInstancesApi.md#workflow_task_instances_partial_update) | **PATCH** /workflow_task_instances/{uuid}/ |
|
139
|
+
*CloudReactorAPIClient::WorkflowTaskInstancesApi* | [**workflow_task_instances_retrieve**](docs/WorkflowTaskInstancesApi.md#workflow_task_instances_retrieve) | **GET** /workflow_task_instances/{uuid}/ |
|
140
|
+
*CloudReactorAPIClient::WorkflowTaskInstancesApi* | [**workflow_task_instances_update**](docs/WorkflowTaskInstancesApi.md#workflow_task_instances_update) | **PUT** /workflow_task_instances/{uuid}/ |
|
141
|
+
*CloudReactorAPIClient::WorkflowTransitionsApi* | [**workflow_transitions_create**](docs/WorkflowTransitionsApi.md#workflow_transitions_create) | **POST** /workflow_transitions/ |
|
142
|
+
*CloudReactorAPIClient::WorkflowTransitionsApi* | [**workflow_transitions_destroy**](docs/WorkflowTransitionsApi.md#workflow_transitions_destroy) | **DELETE** /workflow_transitions/{uuid}/ |
|
143
|
+
*CloudReactorAPIClient::WorkflowTransitionsApi* | [**workflow_transitions_list**](docs/WorkflowTransitionsApi.md#workflow_transitions_list) | **GET** /workflow_transitions/ |
|
144
|
+
*CloudReactorAPIClient::WorkflowTransitionsApi* | [**workflow_transitions_partial_update**](docs/WorkflowTransitionsApi.md#workflow_transitions_partial_update) | **PATCH** /workflow_transitions/{uuid}/ |
|
145
|
+
*CloudReactorAPIClient::WorkflowTransitionsApi* | [**workflow_transitions_retrieve**](docs/WorkflowTransitionsApi.md#workflow_transitions_retrieve) | **GET** /workflow_transitions/{uuid}/ |
|
146
|
+
*CloudReactorAPIClient::WorkflowTransitionsApi* | [**workflow_transitions_update**](docs/WorkflowTransitionsApi.md#workflow_transitions_update) | **PUT** /workflow_transitions/{uuid}/ |
|
147
|
+
*CloudReactorAPIClient::WorkflowsApi* | [**workflows_clone_create**](docs/WorkflowsApi.md#workflows_clone_create) | **POST** /workflows/{uuid}/clone/ |
|
148
|
+
*CloudReactorAPIClient::WorkflowsApi* | [**workflows_create**](docs/WorkflowsApi.md#workflows_create) | **POST** /workflows/ |
|
149
|
+
*CloudReactorAPIClient::WorkflowsApi* | [**workflows_destroy**](docs/WorkflowsApi.md#workflows_destroy) | **DELETE** /workflows/{uuid}/ |
|
150
|
+
*CloudReactorAPIClient::WorkflowsApi* | [**workflows_list**](docs/WorkflowsApi.md#workflows_list) | **GET** /workflows/ |
|
151
|
+
*CloudReactorAPIClient::WorkflowsApi* | [**workflows_partial_update**](docs/WorkflowsApi.md#workflows_partial_update) | **PATCH** /workflows/{uuid}/ |
|
152
|
+
*CloudReactorAPIClient::WorkflowsApi* | [**workflows_retrieve**](docs/WorkflowsApi.md#workflows_retrieve) | **GET** /workflows/{uuid}/ |
|
153
|
+
*CloudReactorAPIClient::WorkflowsApi* | [**workflows_update**](docs/WorkflowsApi.md#workflows_update) | **PUT** /workflows/{uuid}/ |
|
154
|
+
|
155
|
+
|
156
|
+
## Documentation for Models
|
157
|
+
|
158
|
+
- [CloudReactorAPIClient::AlertMethod](docs/AlertMethod.md)
|
159
|
+
- [CloudReactorAPIClient::AwsEcsExecutionMethod](docs/AwsEcsExecutionMethod.md)
|
160
|
+
- [CloudReactorAPIClient::AwsEcsExecutionMethodCapability](docs/AwsEcsExecutionMethodCapability.md)
|
161
|
+
- [CloudReactorAPIClient::AwsEcsLaunchType](docs/AwsEcsLaunchType.md)
|
162
|
+
- [CloudReactorAPIClient::AwsEcsRunEnvironmentExecutionMethodCapability](docs/AwsEcsRunEnvironmentExecutionMethodCapability.md)
|
163
|
+
- [CloudReactorAPIClient::AwsEcsServiceLoadBalancerDetails](docs/AwsEcsServiceLoadBalancerDetails.md)
|
164
|
+
- [CloudReactorAPIClient::AwsEcsServiceOptions](docs/AwsEcsServiceOptions.md)
|
165
|
+
- [CloudReactorAPIClient::CurrentServiceInfo](docs/CurrentServiceInfo.md)
|
166
|
+
- [CloudReactorAPIClient::EmailNotificationProfile](docs/EmailNotificationProfile.md)
|
167
|
+
- [CloudReactorAPIClient::ExecutionMethodCapability](docs/ExecutionMethodCapability.md)
|
168
|
+
- [CloudReactorAPIClient::FailureBehaviorEnum](docs/FailureBehaviorEnum.md)
|
169
|
+
- [CloudReactorAPIClient::Group](docs/Group.md)
|
170
|
+
- [CloudReactorAPIClient::Link](docs/Link.md)
|
171
|
+
- [CloudReactorAPIClient::NameAndUuid](docs/NameAndUuid.md)
|
172
|
+
- [CloudReactorAPIClient::NotificationSeverity](docs/NotificationSeverity.md)
|
173
|
+
- [CloudReactorAPIClient::PagerDutyProfile](docs/PagerDutyProfile.md)
|
174
|
+
- [CloudReactorAPIClient::PaginatedAlertMethodList](docs/PaginatedAlertMethodList.md)
|
175
|
+
- [CloudReactorAPIClient::PaginatedEmailNotificationProfileList](docs/PaginatedEmailNotificationProfileList.md)
|
176
|
+
- [CloudReactorAPIClient::PaginatedPagerDutyProfileList](docs/PaginatedPagerDutyProfileList.md)
|
177
|
+
- [CloudReactorAPIClient::PaginatedRunEnvironmentList](docs/PaginatedRunEnvironmentList.md)
|
178
|
+
- [CloudReactorAPIClient::PaginatedTaskExecutionList](docs/PaginatedTaskExecutionList.md)
|
179
|
+
- [CloudReactorAPIClient::PaginatedTaskList](docs/PaginatedTaskList.md)
|
180
|
+
- [CloudReactorAPIClient::PaginatedWorkflowExecutionSummaryList](docs/PaginatedWorkflowExecutionSummaryList.md)
|
181
|
+
- [CloudReactorAPIClient::PaginatedWorkflowSummaryList](docs/PaginatedWorkflowSummaryList.md)
|
182
|
+
- [CloudReactorAPIClient::PaginatedWorkflowTaskInstanceList](docs/PaginatedWorkflowTaskInstanceList.md)
|
183
|
+
- [CloudReactorAPIClient::PaginatedWorkflowTransitionList](docs/PaginatedWorkflowTransitionList.md)
|
184
|
+
- [CloudReactorAPIClient::PatchedAlertMethod](docs/PatchedAlertMethod.md)
|
185
|
+
- [CloudReactorAPIClient::PatchedEmailNotificationProfile](docs/PatchedEmailNotificationProfile.md)
|
186
|
+
- [CloudReactorAPIClient::PatchedPagerDutyProfile](docs/PatchedPagerDutyProfile.md)
|
187
|
+
- [CloudReactorAPIClient::PatchedRunEnvironment](docs/PatchedRunEnvironment.md)
|
188
|
+
- [CloudReactorAPIClient::PatchedTask](docs/PatchedTask.md)
|
189
|
+
- [CloudReactorAPIClient::PatchedTaskExecution](docs/PatchedTaskExecution.md)
|
190
|
+
- [CloudReactorAPIClient::PatchedWorkflow](docs/PatchedWorkflow.md)
|
191
|
+
- [CloudReactorAPIClient::PatchedWorkflowExecution](docs/PatchedWorkflowExecution.md)
|
192
|
+
- [CloudReactorAPIClient::PatchedWorkflowTaskInstance](docs/PatchedWorkflowTaskInstance.md)
|
193
|
+
- [CloudReactorAPIClient::PatchedWorkflowTransition](docs/PatchedWorkflowTransition.md)
|
194
|
+
- [CloudReactorAPIClient::PropagateTagsEnum](docs/PropagateTagsEnum.md)
|
195
|
+
- [CloudReactorAPIClient::RuleTypeEnum](docs/RuleTypeEnum.md)
|
196
|
+
- [CloudReactorAPIClient::RunEnvironment](docs/RunEnvironment.md)
|
197
|
+
- [CloudReactorAPIClient::StartTransitionConditionEnum](docs/StartTransitionConditionEnum.md)
|
198
|
+
- [CloudReactorAPIClient::StopReasonEnum](docs/StopReasonEnum.md)
|
199
|
+
- [CloudReactorAPIClient::Task](docs/Task.md)
|
200
|
+
- [CloudReactorAPIClient::TaskExecution](docs/TaskExecution.md)
|
201
|
+
- [CloudReactorAPIClient::TaskExecutionStatus](docs/TaskExecutionStatus.md)
|
202
|
+
- [CloudReactorAPIClient::ThresholdPropertyEnum](docs/ThresholdPropertyEnum.md)
|
203
|
+
- [CloudReactorAPIClient::TimeoutBehaviorEnum](docs/TimeoutBehaviorEnum.md)
|
204
|
+
- [CloudReactorAPIClient::UnknownExecutionMethodCapability](docs/UnknownExecutionMethodCapability.md)
|
205
|
+
- [CloudReactorAPIClient::Workflow](docs/Workflow.md)
|
206
|
+
- [CloudReactorAPIClient::WorkflowExecution](docs/WorkflowExecution.md)
|
207
|
+
- [CloudReactorAPIClient::WorkflowExecutionStatus](docs/WorkflowExecutionStatus.md)
|
208
|
+
- [CloudReactorAPIClient::WorkflowExecutionSummary](docs/WorkflowExecutionSummary.md)
|
209
|
+
- [CloudReactorAPIClient::WorkflowSummary](docs/WorkflowSummary.md)
|
210
|
+
- [CloudReactorAPIClient::WorkflowTaskInstance](docs/WorkflowTaskInstance.md)
|
211
|
+
- [CloudReactorAPIClient::WorkflowTaskInstanceExecution](docs/WorkflowTaskInstanceExecution.md)
|
212
|
+
- [CloudReactorAPIClient::WorkflowTaskInstanceExecutionBase](docs/WorkflowTaskInstanceExecutionBase.md)
|
213
|
+
- [CloudReactorAPIClient::WorkflowTransition](docs/WorkflowTransition.md)
|
214
|
+
- [CloudReactorAPIClient::WorkflowTransitionEvaluation](docs/WorkflowTransitionEvaluation.md)
|
215
|
+
|
216
|
+
|
217
|
+
## Documentation for Authorization
|
218
|
+
|
219
|
+
|
220
|
+
### tokenAuth
|
221
|
+
|
222
|
+
|
223
|
+
- **Type**: API key
|
224
|
+
- **API key parameter name**: Authorization
|
225
|
+
- **Location**: HTTP header
|
226
|
+
|