OpenAperture.Builder.Request
Methods and Request struct for Builder requests
Summary↑
| from_payload(payload) | Method to convert a map into a Request struct |
| publish_success_notification(builder_request, message) | Convenience wrapper to publish a “success” notification to the associated Workflow |
| save_workflow(builder_request) | Convenience wrapper to save the updated Workflow |
| set_aws_config(builder_request, config) | Convenience wrapper to add Fleet configuration to the request |
| set_fleet_config(builder_request, config) | Convenience wrapper to add Fleet configuration to the request |
| set_notifications_config(builder_request, config) | Convenience wrapper to add Notifications configuration to the request |
Types ↑
t :: %OpenAperture.Builder.Request{orchestrator_request: OpenAperture.WorkflowOrchestratorApi.Request.t, workflow: OpenAperture.WorkflowOrchestratorApi.Workflow.t, delivery_tag: term, deployment_repo: term, image_found: term, last_total_duration_warning: term, stderr_build_log_tail_pid: term, stdout_build_log_tail_pid: term}
Functions
Specs:
- from_payload(Map) :: OpenAperture.Builder.Request.t
Method to convert a map into a Request struct
Options
The payload option defines the Map containing the request
Return Values
OpenAperture.WorkflowOrchestratorApi.Request.t
Specs:
- publish_success_notification(OpenAperture.Builder.Request.t, String.t) :: OpenAperture.Builder.Request.t
Convenience wrapper to publish a “success” notification to the associated Workflow
Options
The builder_request option defines the Request
The message option defines the message to publish
Return values
Request
Specs:
- save_workflow(OpenAperture.Builder.Request.t) :: OpenAperture.Builder.Request.t
Convenience wrapper to save the updated Workflow
Options
The builder_request option defines the Request
The message option defines the message to publish
Return values
Request
Specs:
- set_aws_config(OpenAperture.Builder.Request.t, Map) :: OpenAperture.Builder.Request.t
Convenience wrapper to add Fleet configuration to the request
Options
The builder_request option defines the Request
The config option represents the Notifications configuration options
Return values
Request
Specs:
- set_fleet_config(OpenAperture.Builder.Request.t, Map) :: OpenAperture.Builder.Request.t
Convenience wrapper to add Fleet configuration to the request
Options
The builder_request option defines the Request
The config option represents the Notifications configuration options
Return values
Request
Specs:
- set_notifications_config(OpenAperture.Builder.Request.t, Map) :: OpenAperture.Builder.Request.t
Convenience wrapper to add Notifications configuration to the request
Options
The builder_request option defines the Request
The config option represents the Notifications configuration options
Return values
Request