Class: OCI::Devops::Models::CreateOkeHelmChartDeployStageDetails

Inherits:
CreateDeployStageDetails show all
Defined in:
lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb

Overview

Specifies the Helm chart deployment to a Kubernetes cluster stage.

Instance Attribute Summary collapse

Attributes inherited from CreateDeployStageDetails

#defined_tags, #deploy_pipeline_id, #deploy_stage_predecessor_collection, #deploy_stage_type, #description, #display_name, #freeform_tags

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateDeployStageDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateOkeHelmChartDeployStageDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 101

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['deployStageType'] = 'OKE_HELM_CHART_DEPLOYMENT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.oke_cluster_deploy_environment_id = attributes[:'okeClusterDeployEnvironmentId'] if attributes[:'okeClusterDeployEnvironmentId']

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

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

  self.helm_chart_deploy_artifact_id = attributes[:'helmChartDeployArtifactId'] if attributes[:'helmChartDeployArtifactId']

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

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

  self.values_artifact_ids = attributes[:'valuesArtifactIds'] if attributes[:'valuesArtifactIds']

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

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

  self.release_name = attributes[:'releaseName'] if attributes[:'releaseName']

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

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

  self.namespace = attributes[:'namespace'] if attributes[:'namespace']
  self.namespace = "default" if namespace.nil? && !attributes.key?(:'namespace') # rubocop:disable Style/StringLiterals

  self.timeout_in_seconds = attributes[:'timeoutInSeconds'] if attributes[:'timeoutInSeconds']
  self.timeout_in_seconds = 300 if timeout_in_seconds.nil? && !attributes.key?(:'timeoutInSeconds') # rubocop:disable Style/StringLiterals

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

  self.timeout_in_seconds = attributes[:'timeout_in_seconds'] if attributes[:'timeout_in_seconds']
  self.timeout_in_seconds = 300 if timeout_in_seconds.nil? && !attributes.key?(:'timeoutInSeconds') && !attributes.key?(:'timeout_in_seconds') # rubocop:disable Style/StringLiterals

  self.rollback_policy = attributes[:'rollbackPolicy'] if attributes[:'rollbackPolicy']

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

  self.rollback_policy = attributes[:'rollback_policy'] if attributes[:'rollback_policy']
end

Instance Attribute Details

#helm_chart_deploy_artifact_id ⇒ String

**[Required]** Helm chart artifact OCID.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 17

def helm_chart_deploy_artifact_id
  @helm_chart_deploy_artifact_id
end

#namespace ⇒ String

Default namespace to be used for Kubernetes deployment when not specified in the manifest.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 29

def namespace
  @namespace
end

#oke_cluster_deploy_environment_id ⇒ String

**[Required]** Kubernetes cluster environment OCID for deployment.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 13

def oke_cluster_deploy_environment_id
  @oke_cluster_deploy_environment_id
end

#release_name ⇒ String

**[Required]** Default name of the chart instance. Must be unique within a Kubernetes namespace.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 25

def release_name
  @release_name
end

#rollback_policy ⇒ OCI::Devops::Models::DeployStageRollbackPolicy

Returns:



36
37
38
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 36

def rollback_policy
  @rollback_policy
end

#timeout_in_seconds ⇒ Integer

Time to wait for execution of a helm stage. Defaults to 300 seconds.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 33

def timeout_in_seconds
  @timeout_in_seconds
end

#values_artifact_ids ⇒ Array<String>

List of values.yaml file artifact OCIDs.

Returns:

  • (Array<String>) 


21
22
23
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 21

def values_artifact_ids
  @values_artifact_ids
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'description',
    'display_name': :'displayName',
    'deploy_stage_type': :'deployStageType',
    'deploy_pipeline_id': :'deployPipelineId',
    'deploy_stage_predecessor_collection': :'deployStagePredecessorCollection',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'oke_cluster_deploy_environment_id': :'okeClusterDeployEnvironmentId',
    'helm_chart_deploy_artifact_id': :'helmChartDeployArtifactId',
    'values_artifact_ids': :'valuesArtifactIds',
    'release_name': :'releaseName',
    'namespace': :'namespace',
    'timeout_in_seconds': :'timeoutInSeconds',
    'rollback_policy': :'rollbackPolicy'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 61

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'description': :'String',
    'display_name': :'String',
    'deploy_stage_type': :'String',
    'deploy_pipeline_id': :'String',
    'deploy_stage_predecessor_collection': :'OCI::Devops::Models::DeployStagePredecessorCollection',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'oke_cluster_deploy_environment_id': :'String',
    'helm_chart_deploy_artifact_id': :'String',
    'values_artifact_ids': :'Array<String>',
    'release_name': :'String',
    'namespace': :'String',
    'timeout_in_seconds': :'Integer',
    'rollback_policy': :'OCI::Devops::Models::DeployStageRollbackPolicy'
    # 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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 160

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    description == other.description &&
    display_name == other.display_name &&
    deploy_stage_type == other.deploy_stage_type &&
    deploy_pipeline_id == other.deploy_pipeline_id &&
    deploy_stage_predecessor_collection == other.deploy_stage_predecessor_collection &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    oke_cluster_deploy_environment_id == other.oke_cluster_deploy_environment_id &&
    helm_chart_deploy_artifact_id == other.helm_chart_deploy_artifact_id &&
    values_artifact_ids == other.values_artifact_ids &&
    release_name == other.release_name &&
    namespace == other.namespace &&
    timeout_in_seconds == other.timeout_in_seconds &&
    rollback_policy == other.rollback_policy
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 203

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


183
184
185
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 183

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



192
193
194
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 192

def hash
  [description, display_name, deploy_stage_type, deploy_pipeline_id, deploy_stage_predecessor_collection, freeform_tags, defined_tags, oke_cluster_deploy_environment_id, helm_chart_deploy_artifact_id, values_artifact_ids, release_name, namespace, timeout_in_seconds, rollback_policy].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 236

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



230
231
232
 
# File 'lib/oci/devops/models/create_oke_helm_chart_deploy_stage_details.rb', line 230

def to_s
  to_hash.to_s
end