Class: OCI::DataCatalog::Models::FacetedSearchDateFilterRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/faceted_search_date_filter_request.rb

Overview

Object with date filter criteria

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FacetedSearchDateFilterRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :field_name (String) —

    The value to assign to the #field_name property

  • :time_after (DateTime) —

    The value to assign to the #time_after property

  • :time_before (DateTime) —

    The value to assign to the #time_before property



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

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

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

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

  self.time_after = attributes[:'timeAfter'] if attributes[:'timeAfter']

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

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

  self.time_before = attributes[:'timeBefore'] if attributes[:'timeBefore']

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

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

Instance Attribute Details

#field_name ⇒ String

Date field name that needs to be filtered by. Acceptable fields include TimeCreated and TimeUpdated.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_catalog/models/faceted_search_date_filter_request.rb', line 13

def field_name
  @field_name
end

#time_after ⇒ DateTime

The date and time the request was created, as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


19
20
21
 
# File 'lib/oci/data_catalog/models/faceted_search_date_filter_request.rb', line 19

def time_after
  @time_after
end

#time_before ⇒ DateTime

The date and time the request was created, as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


25
26
27
 
# File 'lib/oci/data_catalog/models/faceted_search_date_filter_request.rb', line 25

def time_before
  @time_before
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/data_catalog/models/faceted_search_date_filter_request.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'field_name': :'fieldName',
    'time_after': :'timeAfter',
    'time_before': :'timeBefore'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/data_catalog/models/faceted_search_date_filter_request.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'field_name': :'String',
    'time_after': :'DateTime',
    'time_before': :'DateTime'
    # 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



90
91
92
93
94
95
96
97
 
# File 'lib/oci/data_catalog/models/faceted_search_date_filter_request.rb', line 90

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

  self.class == other.class &&
    field_name == other.field_name &&
    time_after == other.time_after &&
    time_before == other.time_before
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



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

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


102
103
104
 
# File 'lib/oci/data_catalog/models/faceted_search_date_filter_request.rb', line 102

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



111
112
113
 
# File 'lib/oci/data_catalog/models/faceted_search_date_filter_request.rb', line 111

def hash
  [field_name, time_after, time_before].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/data_catalog/models/faceted_search_date_filter_request.rb', line 155

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



149
150
151
 
# File 'lib/oci/data_catalog/models/faceted_search_date_filter_request.rb', line 149

def to_s
  to_hash.to_s
end