Class: OCI::Jms::Models::UpdateTaskScheduleDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/jms/models/update_task_schedule_details.rb

Overview

Attributes to update a task schedule.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateTaskScheduleDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  self.execution_recurrences = attributes[:'executionRecurrences'] if attributes[:'executionRecurrences']

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

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

  self.task_details = attributes[:'taskDetails'] if attributes[:'taskDetails']

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

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

Instance Attribute Details

#execution_recurrences ⇒ String

[Required] Recurrence specification for the task schedule execution (formatted according to RFC-5545). To run daily for 10 occurrences starts on September 2, 2024 09:00 UTC, it should be 'DTSTART=20240902T090000Z; RRULE:FREQ=DAILY;COUNT=10'. To run every 3 hours from 9:00 AM to 5:00 PM on August 5, 2024 UTC, it should be 'DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z'.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/jms/models/update_task_schedule_details.rb', line 19

def execution_recurrences
  @execution_recurrences
end

#fleet_id ⇒ String

[Required] The OCID of the Fleet.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/jms/models/update_task_schedule_details.rb', line 13

def fleet_id
  @fleet_id
end

#task_details ⇒ OCI::Jms::Models::TaskDetails

This attribute is required.

Returns:



23
24
25
 
# File 'lib/oci/jms/models/update_task_schedule_details.rb', line 23

def task_details
  @task_details
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
 
# File 'lib/oci/jms/models/update_task_schedule_details.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'fleet_id': :'fleetId',
    'execution_recurrences': :'executionRecurrences',
    'task_details': :'taskDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/jms/models/update_task_schedule_details.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'fleet_id': :'String',
    'execution_recurrences': :'String',
    'task_details': :'OCI::Jms::Models::TaskDetails'
    # 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



88
89
90
91
92
93
94
95
 
# File 'lib/oci/jms/models/update_task_schedule_details.rb', line 88

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

  self.class == other.class &&
    fleet_id == other.fleet_id &&
    execution_recurrences == other.execution_recurrences &&
    task_details == other.task_details
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



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

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


100
101
102
 
# File 'lib/oci/jms/models/update_task_schedule_details.rb', line 100

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/oci/jms/models/update_task_schedule_details.rb', line 109

def hash
  [fleet_id, execution_recurrences, task_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/jms/models/update_task_schedule_details.rb', line 153

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



147
148
149
 
# File 'lib/oci/jms/models/update_task_schedule_details.rb', line 147

def to_s
  to_hash.to_s
end