class OCI::Devops::Models::Deployment

A single execution or run of a pipeline. 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

Constants

DEPLOYMENT_TYPE_ENUM
LIFECYCLE_STATE_ENUM

Attributes

compartment_id[RW]

[Required] The OCID of a compartment. @return [String]

defined_tags[RW]

Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"foo-namespace": {"bar-key": "value"}}` @return [Hash<String, Hash<String, Object>>]

deploy_artifact_override_arguments[RW]

@return [OCI::Devops::Models::DeployArtifactOverrideArgumentCollection]

deploy_pipeline_artifacts[RW]

@return [OCI::Devops::Models::DeployPipelineArtifactCollection]

deploy_pipeline_environments[RW]

@return [OCI::Devops::Models::DeployPipelineEnvironmentCollection]

deploy_pipeline_id[RW]

[Required] The OCID of a pipeline. @return [String]

deployment_arguments[RW]

@return [OCI::Devops::Models::DeploymentArgumentCollection]

deployment_execution_progress[RW]

@return [OCI::Devops::Models::DeploymentExecutionProgress]

deployment_type[R]

[Required] Specifies type of Deployment @return [String]

display_name[RW]

Deployment identifier which can be renamed and is not necessarily unique. Avoid entering confidential information. @return [String]

freeform_tags[RW]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"bar-key": "value"}` @return [Hash<String, String>]

id[RW]

[Required] Unique identifier that is immutable on creation. @return [String]

lifecycle_details[RW]

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. @return [String]

lifecycle_state[R]

The current state of the deployment. @return [String]

project_id[RW]

[Required] The OCID of a project. @return [String]

system_tags[RW]

Usage of system tag keys. These predefined keys are scoped to namespaces. See [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` @return [Hash<String, Hash<String, Object>>]

time_created[RW]

Time the deployment was created. Format defined by [RFC3339](datatracker.ietf.org/doc/html/rfc3339). @return [DateTime]

time_updated[RW]

Time the deployment was updated. Format defined by [RFC3339](datatracker.ietf.org/doc/html/rfc3339). @return [DateTime]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/devops/models/deployment.rb, line 97
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'deploy_pipeline_artifacts': :'deployPipelineArtifacts',
    'deploy_pipeline_environments': :'deployPipelineEnvironments',
    'deployment_type': :'deploymentType',
    'id': :'id',
    'display_name': :'displayName',
    'project_id': :'projectId',
    'deploy_pipeline_id': :'deployPipelineId',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'deployment_arguments': :'deploymentArguments',
    'deploy_artifact_override_arguments': :'deployArtifactOverrideArguments',
    'deployment_execution_progress': :'deploymentExecutionProgress',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end
get_subtype(object_hash) click to toggle source

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

# File lib/oci/devops/models/deployment.rb, line 153
def self.get_subtype(object_hash)
  type = object_hash[:'deploymentType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Devops::Models::DeployPipelineDeployment' if type == 'PIPELINE_DEPLOYMENT'
  return 'OCI::Devops::Models::DeployPipelineRedeployment' if type == 'PIPELINE_REDEPLOYMENT'
  return 'OCI::Devops::Models::SingleDeployStageDeployment' if type == 'SINGLE_STAGE_DEPLOYMENT'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Devops::Models::Deployment'
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [OCI::Devops::Models::DeployPipelineArtifactCollection] :deploy_pipeline_artifacts The value to assign to the {#deploy_pipeline_artifacts} property @option attributes [OCI::Devops::Models::DeployPipelineEnvironmentCollection] :deploy_pipeline_environments The value to assign to the {#deploy_pipeline_environments} property @option attributes [String] :deployment_type The value to assign to the {#deployment_type} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :project_id The value to assign to the {#project_id} property @option attributes [String] :deploy_pipeline_id The value to assign to the {#deploy_pipeline_id} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :lifecycle_details The value to assign to the {#lifecycle_details} property @option attributes [OCI::Devops::Models::DeploymentArgumentCollection] :deployment_arguments The value to assign to the {#deployment_arguments} property @option attributes [OCI::Devops::Models::DeployArtifactOverrideArgumentCollection] :deploy_artifact_override_arguments The value to assign to the {#deploy_artifact_override_arguments} property @option attributes [OCI::Devops::Models::DeploymentExecutionProgress] :deployment_execution_progress The value to assign to the {#deployment_execution_progress} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [Hash<String, Hash<String, Object>>] :system_tags The value to assign to the {#system_tags} property

# File lib/oci/devops/models/deployment.rb, line 189
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.deploy_pipeline_artifacts = attributes[:'deployPipelineArtifacts'] if attributes[:'deployPipelineArtifacts']

  raise 'You cannot provide both :deployPipelineArtifacts and :deploy_pipeline_artifacts' if attributes.key?(:'deployPipelineArtifacts') && attributes.key?(:'deploy_pipeline_artifacts')

  self.deploy_pipeline_artifacts = attributes[:'deploy_pipeline_artifacts'] if attributes[:'deploy_pipeline_artifacts']

  self.deploy_pipeline_environments = attributes[:'deployPipelineEnvironments'] if attributes[:'deployPipelineEnvironments']

  raise 'You cannot provide both :deployPipelineEnvironments and :deploy_pipeline_environments' if attributes.key?(:'deployPipelineEnvironments') && attributes.key?(:'deploy_pipeline_environments')

  self.deploy_pipeline_environments = attributes[:'deploy_pipeline_environments'] if attributes[:'deploy_pipeline_environments']

  self.deployment_type = attributes[:'deploymentType'] if attributes[:'deploymentType']

  raise 'You cannot provide both :deploymentType and :deployment_type' if attributes.key?(:'deploymentType') && attributes.key?(:'deployment_type')

  self.deployment_type = attributes[:'deployment_type'] if attributes[:'deployment_type']

  self.id = attributes[:'id'] if attributes[:'id']

  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.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.deployment_arguments = attributes[:'deploymentArguments'] if attributes[:'deploymentArguments']

  raise 'You cannot provide both :deploymentArguments and :deployment_arguments' if attributes.key?(:'deploymentArguments') && attributes.key?(:'deployment_arguments')

  self.deployment_arguments = attributes[:'deployment_arguments'] if attributes[:'deployment_arguments']

  self.deploy_artifact_override_arguments = attributes[:'deployArtifactOverrideArguments'] if attributes[:'deployArtifactOverrideArguments']

  raise 'You cannot provide both :deployArtifactOverrideArguments and :deploy_artifact_override_arguments' if attributes.key?(:'deployArtifactOverrideArguments') && attributes.key?(:'deploy_artifact_override_arguments')

  self.deploy_artifact_override_arguments = attributes[:'deploy_artifact_override_arguments'] if attributes[:'deploy_artifact_override_arguments']

  self.deployment_execution_progress = attributes[:'deploymentExecutionProgress'] if attributes[:'deploymentExecutionProgress']

  raise 'You cannot provide both :deploymentExecutionProgress and :deployment_execution_progress' if attributes.key?(:'deploymentExecutionProgress') && attributes.key?(:'deployment_execution_progress')

  self.deployment_execution_progress = attributes[:'deployment_execution_progress'] if attributes[:'deployment_execution_progress']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/devops/models/deployment.rb, line 123
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'deploy_pipeline_artifacts': :'OCI::Devops::Models::DeployPipelineArtifactCollection',
    'deploy_pipeline_environments': :'OCI::Devops::Models::DeployPipelineEnvironmentCollection',
    'deployment_type': :'String',
    'id': :'String',
    'display_name': :'String',
    'project_id': :'String',
    'deploy_pipeline_id': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'deployment_arguments': :'OCI::Devops::Models::DeploymentArgumentCollection',
    'deploy_artifact_override_arguments': :'OCI::Devops::Models::DeployArtifactOverrideArgumentCollection',
    'deployment_execution_progress': :'OCI::Devops::Models::DeploymentExecutionProgress',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/devops/models/deployment.rb, line 333
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    deploy_pipeline_artifacts == other.deploy_pipeline_artifacts &&
    deploy_pipeline_environments == other.deploy_pipeline_environments &&
    deployment_type == other.deployment_type &&
    id == other.id &&
    display_name == other.display_name &&
    project_id == other.project_id &&
    deploy_pipeline_id == other.deploy_pipeline_id &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    deployment_arguments == other.deployment_arguments &&
    deploy_artifact_override_arguments == other.deploy_artifact_override_arguments &&
    deployment_execution_progress == other.deployment_execution_progress &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/devops/models/deployment.rb, line 380
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
deployment_type=(deployment_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] deployment_type Object to be assigned

# File lib/oci/devops/models/deployment.rb, line 304
def deployment_type=(deployment_type)
  # rubocop:disable Style/ConditionalAssignment
  if deployment_type && !DEPLOYMENT_TYPE_ENUM.include?(deployment_type)
    OCI.logger.debug("Unknown value for 'deployment_type' [" + deployment_type + "]. Mapping to 'DEPLOYMENT_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @deployment_type = DEPLOYMENT_TYPE_UNKNOWN_ENUM_VALUE
  else
    @deployment_type = deployment_type
  end
  # rubocop:enable Style/ConditionalAssignment
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/devops/models/deployment.rb, line 360
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/devops/models/deployment.rb, line 369
def hash
  [deploy_pipeline_artifacts, deploy_pipeline_environments, deployment_type, id, display_name, project_id, deploy_pipeline_id, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, deployment_arguments, deploy_artifact_override_arguments, deployment_execution_progress, freeform_tags, defined_tags, system_tags].hash
end
lifecycle_state=(lifecycle_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state Object to be assigned

# File lib/oci/devops/models/deployment.rb, line 317
def lifecycle_state=(lifecycle_state)
  # rubocop:disable Style/ConditionalAssignment
  if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
    OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
  else
    @lifecycle_state = lifecycle_state
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/devops/models/deployment.rb, line 413
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/devops/models/deployment.rb, line 407
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/devops/models/deployment.rb, line 430
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end