Class: OCI::Devops::Models::DeployArtifact

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/devops/models/deploy_artifact.rb

Overview

Artifacts are deployment manifests that are referenced in a pipeline stage for automated deployment to the target environment. DevOps artifacts can be an OCI Container image repository, Kubernetes manifest, an Artifact Registry artifact, or defined inline.

Constant Summary collapse

DEPLOY_ARTIFACT_TYPE_ENUM = 
[
  DEPLOY_ARTIFACT_TYPE_DEPLOYMENT_SPEC = 'DEPLOYMENT_SPEC'.freeze,
  DEPLOY_ARTIFACT_TYPE_JOB_SPEC = 'JOB_SPEC'.freeze,
  DEPLOY_ARTIFACT_TYPE_KUBERNETES_MANIFEST = 'KUBERNETES_MANIFEST'.freeze,
  DEPLOY_ARTIFACT_TYPE_GENERIC_FILE = 'GENERIC_FILE'.freeze,
  DEPLOY_ARTIFACT_TYPE_DOCKER_IMAGE = 'DOCKER_IMAGE'.freeze,
  DEPLOY_ARTIFACT_TYPE_HELM_CHART = 'HELM_CHART'.freeze,
  DEPLOY_ARTIFACT_TYPE_HELM_COMMAND_SPEC = 'HELM_COMMAND_SPEC'.freeze,
  DEPLOY_ARTIFACT_TYPE_COMMAND_SPEC = 'COMMAND_SPEC'.freeze,
  DEPLOY_ARTIFACT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ARGUMENT_SUBSTITUTION_MODE_ENUM = 
[
  ARGUMENT_SUBSTITUTION_MODE_NONE = 'NONE'.freeze,
  ARGUMENT_SUBSTITUTION_MODE_SUBSTITUTE_PLACEHOLDERS = 'SUBSTITUTE_PLACEHOLDERS'.freeze,
  ARGUMENT_SUBSTITUTION_MODE_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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeployArtifact

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
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
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 167

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

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

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

  self.argument_substitution_mode = attributes[:'argumentSubstitutionMode'] if attributes[:'argumentSubstitutionMode']

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

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

  self.deploy_artifact_source = attributes[:'deployArtifactSource'] if attributes[:'deployArtifactSource']

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

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

  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.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

Instance Attribute Details

#argument_substitution_mode ⇒ String

[Required] Mode for artifact parameter substitution.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 66

def argument_substitution_mode
  @argument_substitution_mode
end

#compartment_id ⇒ String

[Required] The OCID of a compartment.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 58

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\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


94
95
96
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 94

def defined_tags
  @defined_tags
end

#deploy_artifact_source ⇒ OCI::Devops::Models::DeployArtifactSource

This attribute is required.

Returns:



70
71
72
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 70

def deploy_artifact_source
  @deploy_artifact_source
end

#deploy_artifact_type ⇒ String

[Required] Type of the deployment artifact.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 62

def deploy_artifact_type
  @deploy_artifact_type
end

#description ⇒ String

Optional description about the artifact to be deployed.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 46

def description
  @description
end

#display_name ⇒ String

Deployment artifact identifier, which can be renamed and is not necessarily unique. Avoid entering confidential information.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 50

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\"}

Returns:

  • (Hash<String, String>) 


90
91
92
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 90

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 42

def id
  @id
end

#lifecycle_details ⇒ String

A detailed message describing the current state. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 86

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

Current state of the deployment artifact.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 82

def lifecycle_state
  @lifecycle_state
end

#project_id ⇒ String

[Required] The OCID of a project.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 54

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\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


98
99
100
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 98

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

Time the deployment artifact was created. Format defined by RFC3339.

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 74

def time_created
  @time_created
end

#time_updated ⇒ DateTime

Time the deployment artifact was updated. Format defined by RFC3339.

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 78

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 101

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'description': :'description',
    'display_name': :'displayName',
    'project_id': :'projectId',
    'compartment_id': :'compartmentId',
    'deploy_artifact_type': :'deployArtifactType',
    'argument_substitution_mode': :'argumentSubstitutionMode',
    'deploy_artifact_source': :'deployArtifactSource',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 124

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'description': :'String',
    'display_name': :'String',
    'project_id': :'String',
    'compartment_id': :'String',
    'deploy_artifact_type': :'String',
    'argument_substitution_mode': :'String',
    'deploy_artifact_source': :'OCI::Devops::Models::DeployArtifactSource',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    '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.

Parameters:

  • other (Object) —

    the other object to be compared



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 302

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 &&
    compartment_id == other.compartment_id &&
    deploy_artifact_type == other.deploy_artifact_type &&
    argument_substitution_mode == other.argument_substitution_mode &&
    deploy_artifact_source == other.deploy_artifact_source &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 346

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


326
327
328
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 326

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



335
336
337
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 335

def hash
  [id, description, display_name, project_id, compartment_id, deploy_artifact_type, argument_substitution_mode, deploy_artifact_source, time_created, time_updated, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 379

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

Returns:

  • (String) —

    String presentation of the object



373
374
375
 
# File 'lib/oci/devops/models/deploy_artifact.rb', line 373

def to_s
  to_hash.to_s
end