Class: OCI::Devops::Models::CreateInvokeFunctionDeployStageDetails

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

Overview

Specifies Invoke Function 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 = {}) ⇒ CreateInvokeFunctionDeployStageDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 84

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

  attributes['deployStageType'] = 'INVOKE_FUNCTION'

  super(attributes)

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

  self.function_deploy_environment_id = attributes[:'functionDeployEnvironmentId'] if attributes[:'functionDeployEnvironmentId']

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

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

  self.deploy_artifact_id = attributes[:'deployArtifactId'] if attributes[:'deployArtifactId']

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

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

  self.is_async = attributes[:'isAsync'] unless attributes[:'isAsync'].nil?

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

  self.is_async = attributes[:'is_async'] unless attributes[:'is_async'].nil?

  self.is_validation_enabled = attributes[:'isValidationEnabled'] unless attributes[:'isValidationEnabled'].nil?

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

  self.is_validation_enabled = attributes[:'is_validation_enabled'] unless attributes[:'is_validation_enabled'].nil?
end

Instance Attribute Details

#deploy_artifact_id ⇒ String

Optional artifact OCID. The artifact will be included in the body for the function invocation during the stage's execution. If the DeployArtifact.argumentSubstituitionMode is set to SUBSTITUTE_PLACEHOLDERS, then the pipeline parameter values will be used to replace the placeholders in the artifact content.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 20

def deploy_artifact_id
  @deploy_artifact_id
end

#function_deploy_environment_id ⇒ String

[Required] Function environment OCID.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 14

def function_deploy_environment_id
  @function_deploy_environment_id
end

#is_async ⇒ BOOLEAN

[Required] A boolean flag specifies whether this stage executes asynchronously.

Returns:

  • (BOOLEAN) 


24
25
26
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 24

def is_async
  @is_async
end

#is_validation_enabled ⇒ BOOLEAN

[Required] A boolean flag specifies whether the invoked function should be validated.

Returns:

  • (BOOLEAN) 


28
29
30
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 28

def is_validation_enabled
  @is_validation_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 31

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',
    'function_deploy_environment_id': :'functionDeployEnvironmentId',
    'deploy_artifact_id': :'deployArtifactId',
    'is_async': :'isAsync',
    'is_validation_enabled': :'isValidationEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 50

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>>',
    'function_deploy_environment_id': :'String',
    'deploy_artifact_id': :'String',
    'is_async': :'BOOLEAN',
    'is_validation_enabled': :'BOOLEAN'
    # 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



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

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 &&
    function_deploy_environment_id == other.function_deploy_environment_id &&
    deploy_artifact_id == other.deploy_artifact_id &&
    is_async == other.is_async &&
    is_validation_enabled == other.is_validation_enabled
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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 166

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


146
147
148
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 146

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



155
156
157
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 155

def hash
  [description, display_name, deploy_stage_type, deploy_pipeline_id, deploy_stage_predecessor_collection, freeform_tags, defined_tags, function_deploy_environment_id, deploy_artifact_id, is_async, is_validation_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



199
200
201
202
203
204
205
206
207
208
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 199

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



193
194
195
 
# File 'lib/oci/devops/models/create_invoke_function_deploy_stage_details.rb', line 193

def to_s
  to_hash.to_s
end