Class: OCI::Oda::Models::DigitalAssistantParameterSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/oda/models/digital_assistant_parameter_summary.rb

Overview

Metadata for a Digital Assistant Parameter property.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_STRING = 'STRING'.freeze,
  TYPE_INTEGER = 'INTEGER'.freeze,
  TYPE_FLOAT = 'FLOAT'.freeze,
  TYPE_BOOLEAN = 'BOOLEAN'.freeze,
  TYPE_SECURE = 'SECURE'.freeze,
  TYPE_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_INACTIVE = 'INACTIVE'.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 = {}) ⇒ DigitalAssistantParameterSummary

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :type (String) —

    The value to assign to the #type property

  • :value (String) —

    The value to assign to the #value property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 96

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

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

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

  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']
end

Instance Attribute Details

#description ⇒ String

A description of the Parameter.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 42

def description
  @description
end

#display_name ⇒ String

[Required] The display name for the Parameter.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 38

def display_name
  @display_name
end

#lifecycle_state ⇒ String

[Required] The Parameter's current state.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 54

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The Parameter name. This must be unique within the parent resource.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 34

def name
  @name
end

#type ⇒ String

[Required] The value type.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 46

def type
  @type
end

#value ⇒ String

The current value. The value will be interpreted based on the type.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 50

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 57

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'display_name': :'displayName',
    'description': :'description',
    'type': :'type',
    'value': :'value',
    'lifecycle_state': :'lifecycleState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 71

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



156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 156

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

  self.class == other.class &&
    name == other.name &&
    display_name == other.display_name &&
    description == other.description &&
    type == other.type &&
    value == other.value &&
    lifecycle_state == other.lifecycle_state
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 191

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


171
172
173
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 171

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 180

def hash
  [name, display_name, description, type, value, lifecycle_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 224

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



218
219
220
 
# File 'lib/oci/oda/models/digital_assistant_parameter_summary.rb', line 218

def to_s
  to_hash.to_s
end