Class: OCI::GenerativeAi::Models::ScheduleConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai/models/schedule_config.rb

Overview

The Schedule configuration of a VectorStoreConnector to trigger a File Sync Operation. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

ScheduleCronConfig, ScheduleIntervalConfig

Constant Summary collapse

STATE_ENUM = 
[
  STATE_ENABLED = 'ENABLED'.freeze,
  STATE_DISABLED = 'DISABLED'.freeze,
  STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CONFIG_TYPE_ENUM = 
[
  CONFIG_TYPE_INTERVAL = 'INTERVAL'.freeze,
  CONFIG_TYPE_CRON = 'CRON'.freeze,
  CONFIG_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScheduleConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :state (String) —

    The value to assign to the #state property

  • :config_type (String) —

    The value to assign to the #config_type property

  • :time_start (DateTime) —

    The value to assign to the #time_start property

  • :time_end (DateTime) —

    The value to assign to the #time_end property



95
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/generative_ai/models/schedule_config.rb', line 95

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.state = attributes[:'state'] if attributes[:'state']
  self.state = "ENABLED" if state.nil? && !attributes.key?(:'state') # rubocop:disable Style/StringLiterals

  self.config_type = attributes[:'configType'] if attributes[:'configType']

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

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

  self.time_start = attributes[:'timeStart'] if attributes[:'timeStart']

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

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

  self.time_end = attributes[:'timeEnd'] if attributes[:'timeEnd']

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

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

Instance Attribute Details

#config_type ⇒ String

[Required] The schedule config type

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 31

def config_type
  @config_type
end

#state ⇒ String

The state of the schedule. The state can be either ENABLED or DISABLED.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 27

def state
  @state
end

#time_end ⇒ DateTime

The schedule end date time, if null, the schedule will never expire. Format is defined by RFC3339.

Returns:

  • (DateTime) 


43
44
45
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 43

def time_end
  @time_end
end

#time_start ⇒ DateTime

The schedule starting date time, if null, System set the time when schedule is created. Format is defined by RFC3339.

Returns:

  • (DateTime) 


37
38
39
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 37

def time_start
  @time_start
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'state': :'state',
    'config_type': :'configType',
    'time_start': :'timeStart',
    'time_end': :'timeEnd'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 74

def self.get_subtype(object_hash)
  type = object_hash[:'configType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::GenerativeAi::Models::ScheduleCronConfig' if type == 'CRON'
  return 'OCI::GenerativeAi::Models::ScheduleIntervalConfig' if type == 'INTERVAL'

  # TODO: Log a warning when the subtype is not found.
  'OCI::GenerativeAi::Models::ScheduleConfig'
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'state': :'String',
    'config_type': :'String',
    'time_start': :'DateTime',
    'time_end': :'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



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

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

  self.class == other.class &&
    state == other.state &&
    config_type == other.config_type &&
    time_start == other.time_start &&
    time_end == other.time_end
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



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

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


169
170
171
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 169

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



178
179
180
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 178

def hash
  [state, config_type, time_start, time_end].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 222

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



216
217
218
 
# File 'lib/oci/generative_ai/models/schedule_config.rb', line 216

def to_s
  to_hash.to_s
end