Class: OCI::Devops::Models::DeployStage
- Inherits:
-
Object
- Object
- OCI::Devops::Models::DeployStage
- Defined in:
- lib/oci/devops/models/deploy_stage.rb
Overview
A single node in a pipeline. It is usually associated with some action on a specific set of OCI resources such as environments. For example, updating a Function or a Kubernetes cluster. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Direct Known Subclasses
ComputeInstanceGroupBlueGreenDeployStage, ComputeInstanceGroupBlueGreenTrafficShiftDeployStage, ComputeInstanceGroupCanaryApprovalDeployStage, ComputeInstanceGroupCanaryDeployStage, ComputeInstanceGroupCanaryTrafficShiftDeployStage, ComputeInstanceGroupDeployStage, FunctionDeployStage, InvokeFunctionDeployStage, LoadBalancerTrafficShiftDeployStage, ManualApprovalDeployStage, OkeBlueGreenDeployStage, OkeBlueGreenTrafficShiftDeployStage, OkeCanaryApprovalDeployStage, OkeCanaryDeployStage, OkeCanaryTrafficShiftDeployStage, OkeDeployStage, OkeHelmChartDeployStage, ShellDeployStage, WaitDeployStage
Constant Summary collapse
- DEPLOY_STAGE_TYPE_ENUM =
[ DEPLOY_STAGE_TYPE_WAIT = 'WAIT'.freeze, DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT = 'COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT'.freeze, DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT = 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT'.freeze, DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT = 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT'.freeze, DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT = 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT'.freeze, DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT = 'COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT'.freeze, DEPLOY_STAGE_TYPE_COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL = 'COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL'.freeze, DEPLOY_STAGE_TYPE_OKE_BLUE_GREEN_DEPLOYMENT = 'OKE_BLUE_GREEN_DEPLOYMENT'.freeze, DEPLOY_STAGE_TYPE_OKE_BLUE_GREEN_TRAFFIC_SHIFT = 'OKE_BLUE_GREEN_TRAFFIC_SHIFT'.freeze, DEPLOY_STAGE_TYPE_OKE_CANARY_DEPLOYMENT = 'OKE_CANARY_DEPLOYMENT'.freeze, DEPLOY_STAGE_TYPE_OKE_CANARY_TRAFFIC_SHIFT = 'OKE_CANARY_TRAFFIC_SHIFT'.freeze, DEPLOY_STAGE_TYPE_OKE_CANARY_APPROVAL = 'OKE_CANARY_APPROVAL'.freeze, DEPLOY_STAGE_TYPE_OKE_DEPLOYMENT = 'OKE_DEPLOYMENT'.freeze, DEPLOY_STAGE_TYPE_DEPLOY_FUNCTION = 'DEPLOY_FUNCTION'.freeze, DEPLOY_STAGE_TYPE_INVOKE_FUNCTION = 'INVOKE_FUNCTION'.freeze, DEPLOY_STAGE_TYPE_LOAD_BALANCER_TRAFFIC_SHIFT = 'LOAD_BALANCER_TRAFFIC_SHIFT'.freeze, DEPLOY_STAGE_TYPE_MANUAL_APPROVAL = 'MANUAL_APPROVAL'.freeze, DEPLOY_STAGE_TYPE_OKE_HELM_CHART_DEPLOYMENT = 'OKE_HELM_CHART_DEPLOYMENT'.freeze, DEPLOY_STAGE_TYPE_SHELL = 'SHELL'.freeze, DEPLOY_STAGE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of a compartment.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#deploy_pipeline_id ⇒ String
[Required] The OCID of a pipeline.
- #deploy_stage_predecessor_collection ⇒ OCI::Devops::Models::DeployStagePredecessorCollection
-
#deploy_stage_type ⇒ String
[Required] Deployment stage type.
-
#description ⇒ String
Optional description about the deployment stage.
-
#display_name ⇒ String
Deployment stage display name, which can be renamed and is not necessarily unique.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] Unique identifier that is immutable on creation.
-
#lifecycle_details ⇒ String
A message describing the current state in more detail.
-
#lifecycle_state ⇒ String
The current state of the deployment stage.
-
#project_id ⇒ String
[Required] The OCID of a project.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
Time the deployment stage was created.
-
#time_updated ⇒ DateTime
Time the deployment stage was updated.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ DeployStage
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ DeployStage
Initializes the object
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 205 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.id = attributes[:'id'] if attributes[:'id'] self.description = attributes[:'description'] if attributes[:'description'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.project_id = attributes[:'projectId'] if attributes[:'projectId'] raise 'You cannot provide both :projectId and :project_id' if attributes.key?(:'projectId') && attributes.key?(:'project_id') self.project_id = attributes[:'project_id'] if attributes[:'project_id'] self.deploy_pipeline_id = attributes[:'deployPipelineId'] if attributes[:'deployPipelineId'] raise 'You cannot provide both :deployPipelineId and :deploy_pipeline_id' if attributes.key?(:'deployPipelineId') && attributes.key?(:'deploy_pipeline_id') self.deploy_pipeline_id = attributes[:'deploy_pipeline_id'] if attributes[:'deploy_pipeline_id'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.deploy_stage_type = attributes[:'deployStageType'] if attributes[:'deployStageType'] raise 'You cannot provide both :deployStageType and :deploy_stage_type' if attributes.key?(:'deployStageType') && attributes.key?(:'deploy_stage_type') self.deploy_stage_type = attributes[:'deploy_stage_type'] if attributes[:'deploy_stage_type'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails'] raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details') self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details'] self.deploy_stage_predecessor_collection = attributes[:'deployStagePredecessorCollection'] if attributes[:'deployStagePredecessorCollection'] raise 'You cannot provide both :deployStagePredecessorCollection and :deploy_stage_predecessor_collection' if attributes.key?(:'deployStagePredecessorCollection') && attributes.key?(:'deploy_stage_predecessor_collection') self.deploy_stage_predecessor_collection = attributes[:'deploy_stage_predecessor_collection'] if attributes[:'deploy_stage_predecessor_collection'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of a compartment.
68 69 70 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 68 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
99 100 101 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 99 def @defined_tags end |
#deploy_pipeline_id ⇒ String
[Required] The OCID of a pipeline.
64 65 66 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 64 def deploy_pipeline_id @deploy_pipeline_id end |
#deploy_stage_predecessor_collection ⇒ OCI::Devops::Models::DeployStagePredecessorCollection
91 92 93 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 91 def deploy_stage_predecessor_collection @deploy_stage_predecessor_collection end |
#deploy_stage_type ⇒ String
[Required] Deployment stage type.
72 73 74 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 72 def deploy_stage_type @deploy_stage_type end |
#description ⇒ String
Optional description about the deployment stage.
52 53 54 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 52 def description @description end |
#display_name ⇒ String
Deployment stage display name, which can be renamed and is not necessarily unique. Avoid entering confidential information.
56 57 58 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 56 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {\"bar-key\": \"value\"}
95 96 97 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 95 def @freeform_tags end |
#id ⇒ String
[Required] Unique identifier that is immutable on creation.
48 49 50 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 48 def id @id end |
#lifecycle_details ⇒ String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
88 89 90 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 88 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
The current state of the deployment stage.
84 85 86 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 84 def lifecycle_state @lifecycle_state end |
#project_id ⇒ String
[Required] The OCID of a project.
60 61 62 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 60 def project_id @project_id end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}
103 104 105 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 103 def @system_tags end |
#time_created ⇒ DateTime
Time the deployment stage was created. Format defined by RFC3339.
76 77 78 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 76 def time_created @time_created end |
#time_updated ⇒ DateTime
Time the deployment stage was updated. Format defined by RFC3339.
80 81 82 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 80 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 106 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'description': :'description', 'display_name': :'displayName', 'project_id': :'projectId', 'deploy_pipeline_id': :'deployPipelineId', 'compartment_id': :'compartmentId', 'deploy_stage_type': :'deployStageType', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'deploy_stage_predecessor_collection': :'deployStagePredecessorCollection', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 156 def self.get_subtype(object_hash) type = object_hash[:'deployStageType'] # rubocop:disable Style/SymbolLiteral return 'OCI::Devops::Models::ComputeInstanceGroupBlueGreenTrafficShiftDeployStage' if type == 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_TRAFFIC_SHIFT' return 'OCI::Devops::Models::LoadBalancerTrafficShiftDeployStage' if type == 'LOAD_BALANCER_TRAFFIC_SHIFT' return 'OCI::Devops::Models::ShellDeployStage' if type == 'SHELL' return 'OCI::Devops::Models::InvokeFunctionDeployStage' if type == 'INVOKE_FUNCTION' return 'OCI::Devops::Models::OkeCanaryDeployStage' if type == 'OKE_CANARY_DEPLOYMENT' return 'OCI::Devops::Models::OkeDeployStage' if type == 'OKE_DEPLOYMENT' return 'OCI::Devops::Models::OkeCanaryTrafficShiftDeployStage' if type == 'OKE_CANARY_TRAFFIC_SHIFT' return 'OCI::Devops::Models::FunctionDeployStage' if type == 'DEPLOY_FUNCTION' return 'OCI::Devops::Models::OkeBlueGreenDeployStage' if type == 'OKE_BLUE_GREEN_DEPLOYMENT' return 'OCI::Devops::Models::OkeCanaryApprovalDeployStage' if type == 'OKE_CANARY_APPROVAL' return 'OCI::Devops::Models::ComputeInstanceGroupCanaryTrafficShiftDeployStage' if type == 'COMPUTE_INSTANCE_GROUP_CANARY_TRAFFIC_SHIFT' return 'OCI::Devops::Models::ComputeInstanceGroupCanaryApprovalDeployStage' if type == 'COMPUTE_INSTANCE_GROUP_CANARY_APPROVAL' return 'OCI::Devops::Models::WaitDeployStage' if type == 'WAIT' return 'OCI::Devops::Models::OkeHelmChartDeployStage' if type == 'OKE_HELM_CHART_DEPLOYMENT' return 'OCI::Devops::Models::ComputeInstanceGroupBlueGreenDeployStage' if type == 'COMPUTE_INSTANCE_GROUP_BLUE_GREEN_DEPLOYMENT' return 'OCI::Devops::Models::ComputeInstanceGroupCanaryDeployStage' if type == 'COMPUTE_INSTANCE_GROUP_CANARY_DEPLOYMENT' return 'OCI::Devops::Models::OkeBlueGreenTrafficShiftDeployStage' if type == 'OKE_BLUE_GREEN_TRAFFIC_SHIFT' return 'OCI::Devops::Models::ManualApprovalDeployStage' if type == 'MANUAL_APPROVAL' return 'OCI::Devops::Models::ComputeInstanceGroupDeployStage' if type == 'COMPUTE_INSTANCE_GROUP_ROLLING_DEPLOYMENT' # TODO: Log a warning when the subtype is not found. 'OCI::Devops::Models::DeployStage' end |
.swagger_types ⇒ Object
Attribute type mapping.
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 129 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'description': :'String', 'display_name': :'String', 'project_id': :'String', 'deploy_pipeline_id': :'String', 'compartment_id': :'String', 'deploy_stage_type': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'deploy_stage_predecessor_collection': :'OCI::Devops::Models::DeployStagePredecessorCollection', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 327 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && description == other.description && display_name == other.display_name && project_id == other.project_id && deploy_pipeline_id == other.deploy_pipeline_id && compartment_id == other.compartment_id && deploy_stage_type == other.deploy_stage_type && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && deploy_stage_predecessor_collection == other.deploy_stage_predecessor_collection && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 371 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
351 352 353 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 351 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
360 361 362 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 360 def hash [id, description, display_name, project_id, deploy_pipeline_id, compartment_id, deploy_stage_type, time_created, time_updated, lifecycle_state, lifecycle_details, deploy_stage_predecessor_collection, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
404 405 406 407 408 409 410 411 412 413 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 404 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
398 399 400 |
# File 'lib/oci/devops/models/deploy_stage.rb', line 398 def to_s to_hash.to_s end |