Class: OCI::Database::Models::CreateSchedulingPolicyDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/create_scheduling_policy_details.rb

Overview

Request to create Scheduling Policy resource with Maintenance windows per cadence.

Constant Summary collapse

CADENCE_ENUM = 
[
  CADENCE_HALFYEARLY = 'HALFYEARLY'.freeze,
  CADENCE_QUARTERLY = 'QUARTERLY'.freeze,
  CADENCE_MONTHLY = 'MONTHLY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSchedulingPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



88
89
90
91
92
93
94
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
122
123
124
125
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 88

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.cadence_start_month = attributes[:'cadenceStartMonth'] if attributes[:'cadenceStartMonth']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#cadence ⇒ String

[Required] The cadence period.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 28

def cadence
  @cadence
end

#cadence_start_month ⇒ OCI::Database::Models::Month

Start of the month to be followed during the cadence period.

Returns:



32
33
34
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 32

def cadence_start_month
  @cadence_start_month
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 20

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

  • (Hash<String, Hash<String, Object>>) 


46
47
48
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 46

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The user-friendly name for the Scheduling Policy. The name does not need to be unique.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 24

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


40
41
42
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 40

def freeform_tags
  @freeform_tags
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'cadence': :'cadence',
    'cadence_start_month': :'cadenceStartMonth',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 63

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'cadence': :'String',
    'cadence_start_month': :'OCI::Database::Models::Month',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 142

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    cadence == other.cadence &&
    cadence_start_month == other.cadence_start_month &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 177

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


157
158
159
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 157

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



166
167
168
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 166

def hash
  [compartment_id, display_name, cadence, cadence_start_month, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 210

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



204
205
206
 
# File 'lib/oci/database/models/create_scheduling_policy_details.rb', line 204

def to_s
  to_hash.to_s
end