class Event
- Event
- Reference
- Object
Overview
The Event
class represents an event that triggers a deployment for a project.
It includes properties for the event's type, repository, environment, and schedule.
Included Modules
- YAML::Serializable
Defined in:
runway/models/config.crConstructors
Instance Method Summary
-
#cleanup : Bool | Nil
@return [Bool, nil] A flag to enable property cleanup, or
nil
if not specified. -
#cleanup=(cleanup : Bool | Nil)
@return [Bool, nil] A flag to enable property cleanup, or
nil
if not specified. -
#deployment_filter : Int32 | Nil
@return [Int32, nil] The deployment filter for the event, or
nil
if not specified. -
#deployment_filter=(deployment_filter : Int32 | Nil)
@return [Int32, nil] The deployment filter for the event, or
nil
if not specified. -
#environment : String | Nil
@return [String, nil] The environment for the event, or
nil
if not specified. -
#environment=(environment : String | Nil)
@return [String, nil] The environment for the event, or
nil
if not specified. -
#path : String | Nil
@return [String, nil] A path for a file, or
nil
if not specified. -
#path=(path : String | Nil)
@return [String, nil] A path for a file, or
nil
if not specified. -
#repo : String | Nil
@return [String, nil] The repository for the event, or
nil
if not specified. -
#repo=(repo : String | Nil)
@return [String, nil] The repository for the event, or
nil
if not specified. -
#schedule : Schedule
@return [Schedule] The schedule for the event.
-
#schedule=(schedule : Schedule)
@return [Schedule] The schedule for the event.
-
#type : String
@return [String] The type of the event.
-
#type=(type : String)
@return [String] The type of the event.
-
#uuid : String | Nil
@return [String, nil] The UUID for the event, or
nil
if not specified. -
#uuid=(uuid : String | Nil)
@return [String, nil] The UUID for the event, or
nil
if not specified.
Constructor Detail
Instance Method Detail
@return [Bool, nil] A flag to enable property cleanup, or nil
if not specified. Used by a few event types.
@return [Bool, nil] A flag to enable property cleanup, or nil
if not specified. Used by a few event types.
@return [Int32, nil] The deployment filter for the event, or nil
if not specified.
Deployment filters are used to filter out deployments to X number of most recent deployments
This helps save on API requests and prevent unnecessary deployments
This property is specific to the github_deployment event type
@return [Int32, nil] The deployment filter for the event, or nil
if not specified.
Deployment filters are used to filter out deployments to X number of most recent deployments
This helps save on API requests and prevent unnecessary deployments
This property is specific to the github_deployment event type
@return [String, nil] The environment for the event, or nil
if not specified.
@return [String, nil] The environment for the event, or nil
if not specified.
@return [String, nil] A path for a file, or nil
if not specified. Used by a few event types.
@return [String, nil] A path for a file, or nil
if not specified. Used by a few event types.
@return [String, nil] The repository for the event, or nil
if not specified.
@return [String, nil] The repository for the event, or nil
if not specified.
@return [String, nil] The UUID for the event, or nil
if not specified.
The application will generate a UUID for the event if one is not provided.
@return [String, nil] The UUID for the event, or nil
if not specified.
The application will generate a UUID for the event if one is not provided.