Class: OCI::OsManagementHub::Models::SearchSoftwareSourceModulesDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management_hub/models/search_software_source_modules_details.rb

Overview

Provides the information used to search for a set of modules from a list software sources.

Constant Summary collapse

SORT_ORDER_ENUM = 
[
  SORT_ORDER_ASC = 'ASC'.freeze,
  SORT_ORDER_DESC = 'DESC'.freeze
].freeze
SORT_BY_ENUM = 
[
  SORT_BY_NAME = 'NAME'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchSoftwareSourceModulesDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :software_source_ids (Array<String>) —

    The value to assign to the #software_source_ids property

  • :sort_order (String) —

    The value to assign to the #sort_order property

  • :name (String) —

    The value to assign to the #name property

  • :name_contains (String) —

    The value to assign to the #name_contains property

  • :sort_by (String) —

    The value to assign to the #sort_by property

[View source]

78
79
80
81
82
83
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
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 78

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

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

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

  self.sort_order = attributes[:'sortOrder'] if attributes[:'sortOrder']

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

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

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

  self.name_contains = attributes[:'nameContains'] if attributes[:'nameContains']

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

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

  self.sort_by = attributes[:'sortBy'] if attributes[:'sortBy']

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

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

Instance Attribute Details

#name ⇒ String

The name of a module.

Returns:

  • (String) 

31
32
33
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 31

def name
  @name
end

#name_contains ⇒ String

A filter to return modules with a name that contains the given string.

Returns:

  • (String) 

35
36
37
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 35

def name_contains
  @name_contains
end

#software_source_ids ⇒ Array<String>

[Required] List of sofware source OCIDs.

Returns:

  • (Array<String>) 

22
23
24
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 22

def software_source_ids
  @software_source_ids
end

#sort_by ⇒ String

The field to sort by.

Returns:

  • (String) 

39
40
41
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 39

def sort_by
  @sort_by
end

#sort_order ⇒ String

The sort order.

Returns:

  • (String) 

26
27
28
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 26

def sort_order
  @sort_order
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'software_source_ids': :'softwareSourceIds',
    'sort_order': :'sortOrder',
    'name': :'name',
    'name_contains': :'nameContains',
    'sort_by': :'sortBy'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 55

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'software_source_ids': :'Array<String>',
    'sort_order': :'String',
    'name': :'String',
    'name_contains': :'String',
    'sort_by': :'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

[View source]

134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 134

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

  self.class == other.class &&
    software_source_ids == other.software_source_ids &&
    sort_order == other.sort_order &&
    name == other.name &&
    name_contains == other.name_contains &&
    sort_by == other.sort_by
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

[View source]

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

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
[View source]

148
149
150
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 148

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

157
158
159
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 157

def hash
  [software_source_ids, sort_order, name, name_contains, sort_by].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

201
202
203
204
205
206
207
208
209
210
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 201

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

[View source]

195
196
197
 
# File 'lib/oci/os_management_hub/models/search_software_source_modules_details.rb', line 195

def to_s
  to_hash.to_s
end