Class: OCI::DataIntegration::Models::Schedule

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_integration/models/schedule.rb

Overview

The schedule object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Schedule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/data_integration/models/schedule.rb', line 122

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

  self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion']

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

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

  self.model_type = attributes[:'modelType'] if attributes[:'modelType']

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

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

  self.parent_ref = attributes[:'parentRef'] if attributes[:'parentRef']

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

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

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

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

  self.object_version = attributes[:'objectVersion'] if attributes[:'objectVersion']

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

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

  self.object_status = attributes[:'objectStatus'] if attributes[:'objectStatus']

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

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

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

  self.frequency_details = attributes[:'frequencyDetails'] if attributes[:'frequencyDetails']

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

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

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

  self.is_daylight_adjustment_enabled = attributes[:'isDaylightAdjustmentEnabled'] unless attributes[:'isDaylightAdjustmentEnabled'].nil?

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

  self.is_daylight_adjustment_enabled = attributes[:'is_daylight_adjustment_enabled'] unless attributes[:'is_daylight_adjustment_enabled'].nil?

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

Instance Attribute Details

#description ⇒ String

Detailed description for the object.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_integration/models/schedule.rb', line 33

def description
  @description
end

#frequency_details ⇒ OCI::DataIntegration::Models::AbstractFrequencyDetails

Returns:



48
49
50
 
# File 'lib/oci/data_integration/models/schedule.rb', line 48

def frequency_details
  @frequency_details
end

#identifier ⇒ String

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_integration/models/schedule.rb', line 45

def identifier
  @identifier
end

#is_daylight_adjustment_enabled ⇒ BOOLEAN

A flag to indicate daylight saving.

Returns:

  • (BOOLEAN) 


56
57
58
 
# File 'lib/oci/data_integration/models/schedule.rb', line 56

def is_daylight_adjustment_enabled
  @is_daylight_adjustment_enabled
end

#key ⇒ String

Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/data_integration/models/schedule.rb', line 14

def key
  @key
end

#metadata ⇒ OCI::DataIntegration::Models::ObjectMetadata

Returns:



59
60
61
 
# File 'lib/oci/data_integration/models/schedule.rb', line 59

def metadata
  @metadata
end

#model_type ⇒ String

The type of the object.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/data_integration/models/schedule.rb', line 22

def model_type
  @model_type
end

#model_version ⇒ String

This is a version number that is used by the service to upgrade objects if needed through releases of the service.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/data_integration/models/schedule.rb', line 18

def model_version
  @model_version
end

#name ⇒ String

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_integration/models/schedule.rb', line 29

def name
  @name
end

#object_status ⇒ Integer

The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:

  • (Integer) 


41
42
43
 
# File 'lib/oci/data_integration/models/schedule.rb', line 41

def object_status
  @object_status
end

#object_version ⇒ Integer

This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.

Returns:

  • (Integer) 


37
38
39
 
# File 'lib/oci/data_integration/models/schedule.rb', line 37

def object_version
  @object_version
end

#parent_ref ⇒ OCI::DataIntegration::Models::ParentReference

Returns:



25
26
27
 
# File 'lib/oci/data_integration/models/schedule.rb', line 25

def parent_ref
  @parent_ref
end

#timezone ⇒ String

The timezone for the schedule.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/data_integration/models/schedule.rb', line 52

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/data_integration/models/schedule.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'model_version': :'modelVersion',
    'model_type': :'modelType',
    'parent_ref': :'parentRef',
    'name': :'name',
    'description': :'description',
    'object_version': :'objectVersion',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'frequency_details': :'frequencyDetails',
    'timezone': :'timezone',
    'is_daylight_adjustment_enabled': :'isDaylightAdjustmentEnabled',
    'metadata': :'metadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/data_integration/models/schedule.rb', line 83

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'model_version': :'String',
    'model_type': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'description': :'String',
    'object_version': :'Integer',
    'object_status': :'Integer',
    'identifier': :'String',
    'frequency_details': :'OCI::DataIntegration::Models::AbstractFrequencyDetails',
    'timezone': :'String',
    'is_daylight_adjustment_enabled': :'BOOLEAN',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata'
    # 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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/data_integration/models/schedule.rb', line 190

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

  self.class == other.class &&
    key == other.key &&
    model_version == other.model_version &&
    model_type == other.model_type &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    description == other.description &&
    object_version == other.object_version &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    frequency_details == other.frequency_details &&
    timezone == other.timezone &&
    is_daylight_adjustment_enabled == other.is_daylight_adjustment_enabled &&
    metadata == other.metadata
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/data_integration/models/schedule.rb', line 232

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


212
213
214
 
# File 'lib/oci/data_integration/models/schedule.rb', line 212

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



221
222
223
 
# File 'lib/oci/data_integration/models/schedule.rb', line 221

def hash
  [key, model_version, model_type, parent_ref, name, description, object_version, object_status, identifier, frequency_details, timezone, is_daylight_adjustment_enabled, metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/data_integration/models/schedule.rb', line 265

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



259
260
261
 
# File 'lib/oci/data_integration/models/schedule.rb', line 259

def to_s
  to_hash.to_s
end