Class: OCI::ApmSynthetics::Models::ScriptParameter

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_synthetics/models/script_parameter.rb

Overview

Details of the script parameters, paramName must be from the script content and these details can be used to overwrite the default parameter present in the script content.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScriptParameter

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :param_name (String)

    The value to assign to the #param_name property

  • :param_value (String)

    The value to assign to the #param_value property

  • :is_secret (BOOLEAN)

    The value to assign to the #is_secret property



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 55

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

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

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

  self.param_value = attributes[:'paramValue'] if attributes[:'paramValue']

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

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

  self.is_secret = attributes[:'isSecret'] unless attributes[:'isSecret'].nil?
  self.is_secret = false if is_secret.nil? && !attributes.key?(:'isSecret') # rubocop:disable Style/StringLiterals

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

  self.is_secret = attributes[:'is_secret'] unless attributes[:'is_secret'].nil?
  self.is_secret = false if is_secret.nil? && !attributes.key?(:'isSecret') && !attributes.key?(:'is_secret') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#is_secretBOOLEAN

If the parameter value is secret and should be kept confidential, then set isSecret to true.

Returns:

  • (BOOLEAN)


22
23
24
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 22

def is_secret
  @is_secret
end

#param_nameString

[Required] Name of the parameter.

Returns:

  • (String)


14
15
16
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 14

def param_name
  @param_name
end

#param_valueString

Value of the parameter.

Returns:

  • (String)


18
19
20
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 18

def param_value
  @param_value
end

Class Method Details

.attribute_mapObject

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



25
26
27
28
29
30
31
32
33
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'param_name': :'paramName',
    'param_value': :'paramValue',
    'is_secret': :'isSecret'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



36
37
38
39
40
41
42
43
44
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 36

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'param_name': :'String',
    'param_value': :'String',
    'is_secret': :'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



89
90
91
92
93
94
95
96
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 89

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

  self.class == other.class &&
    param_name == other.param_name &&
    param_value == other.param_value &&
    is_secret == other.is_secret
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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 121

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


101
102
103
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 101

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



110
111
112
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 110

def hash
  [param_name, param_value, is_secret].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



154
155
156
157
158
159
160
161
162
163
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 154

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



148
149
150
# File 'lib/oci/apm_synthetics/models/script_parameter.rb', line 148

def to_s
  to_hash.to_s
end