Class: OCI::Devops::Models::BuildPipelineParameter

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

Overview

Parameter name for which the values will be supplied at the time of running the build.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BuildPipelineParameter

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :default_value (String) —

    The value to assign to the #default_value property

  • :description (String) —

    The value to assign to the #description property



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 56

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

  self.default_value = attributes[:'defaultValue'] if attributes[:'defaultValue']

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

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

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

Instance Attribute Details

#default_value ⇒ String

[Required] Default value of the parameter.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 19

def default_value
  @default_value
end

#description ⇒ String

Description of the parameter.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 23

def description
  @description
end

#name ⇒ String

[Required] Name of the parameter (case-sensitive). Parameter name must be 1[a-zA-Z_0-9]*$. Example: 'Build_Pipeline_param' is not same as 'build_pipeline_Param'

1 a-zA-Z

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 15

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'default_value': :'defaultValue',
    'description': :'description'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'default_value': :'String',
    'description': :'String'
    # 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



80
81
82
83
84
85
86
87
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 80

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

  self.class == other.class &&
    name == other.name &&
    default_value == other.default_value &&
    description == other.description
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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 112

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


92
93
94
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 92

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



101
102
103
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 101

def hash
  [name, default_value, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 145

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



139
140
141
 
# File 'lib/oci/devops/models/build_pipeline_parameter.rb', line 139

def to_s
  to_hash.to_s
end