Class: OCI::DatabaseManagement::Models::SpmEvolveTaskParameters

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/spm_evolve_task_parameters.rb

Overview

The set of parameters used in an SPM evolve task.

Constant Summary collapse

ALTERNATE_PLAN_SOURCES_ENUM = 
[
  ALTERNATE_PLAN_SOURCES_AUTO = 'AUTO'.freeze,
  ALTERNATE_PLAN_SOURCES_AUTOMATIC_WORKLOAD_REPOSITORY = 'AUTOMATIC_WORKLOAD_REPOSITORY'.freeze,
  ALTERNATE_PLAN_SOURCES_CURSOR_CACHE = 'CURSOR_CACHE'.freeze,
  ALTERNATE_PLAN_SOURCES_SQL_TUNING_SET = 'SQL_TUNING_SET'.freeze,
  ALTERNATE_PLAN_SOURCES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ALTERNATE_PLAN_BASELINES_ENUM = 
[
  ALTERNATE_PLAN_BASELINES_AUTO = 'AUTO'.freeze,
  ALTERNATE_PLAN_BASELINES_EXISTING = 'EXISTING'.freeze,
  ALTERNATE_PLAN_BASELINES_NEW = 'NEW'.freeze,
  ALTERNATE_PLAN_BASELINES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SpmEvolveTaskParameters

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



87
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
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 87

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

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

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

  self.alternate_plan_baselines = attributes[:'alternatePlanBaselines'] if attributes[:'alternatePlanBaselines']

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

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

  self.alternate_plan_limit = attributes[:'alternatePlanLimit'] if attributes[:'alternatePlanLimit']

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

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

  self.are_plans_auto_accepted = attributes[:'arePlansAutoAccepted'] unless attributes[:'arePlansAutoAccepted'].nil?

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

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

  self.allowed_time_limit = attributes[:'allowedTimeLimit'] if attributes[:'allowedTimeLimit']

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

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

Instance Attribute Details

#allowed_time_limit ⇒ Integer

The global time limit in seconds. This is the total time allowed for the task.

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 48

def allowed_time_limit
  @allowed_time_limit
end

#alternate_plan_baselines ⇒ Array<String>

Determines which alternative plans should be loaded.

Returns:

  • (Array<String>) 


33
34
35
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 33

def alternate_plan_baselines
  @alternate_plan_baselines
end

#alternate_plan_limit ⇒ Integer

Specifies the maximum number of plans to load in total (that is, not the limit for each SQL statement). A value of zero indicates UNLIMITED number of plans.

Returns:

  • (Integer) 


40
41
42
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 40

def alternate_plan_limit
  @alternate_plan_limit
end

#alternate_plan_sources ⇒ Array<String>

Determines which sources to search for additional plans.

Returns:

  • (Array<String>) 


29
30
31
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 29

def alternate_plan_sources
  @alternate_plan_sources
end

#are_plans_auto_accepted ⇒ BOOLEAN

Specifies whether to accept recommended plans automatically.

Returns:

  • (BOOLEAN) 


44
45
46
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 44

def are_plans_auto_accepted
  @are_plans_auto_accepted
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'alternate_plan_sources': :'alternatePlanSources',
    'alternate_plan_baselines': :'alternatePlanBaselines',
    'alternate_plan_limit': :'alternatePlanLimit',
    'are_plans_auto_accepted': :'arePlansAutoAccepted',
    'allowed_time_limit': :'allowedTimeLimit'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'alternate_plan_sources': :'Array<String>',
    'alternate_plan_baselines': :'Array<String>',
    'alternate_plan_limit': :'Integer',
    'are_plans_auto_accepted': :'BOOLEAN',
    'allowed_time_limit': :'Integer'
    # 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



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 171

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

  self.class == other.class &&
    alternate_plan_sources == other.alternate_plan_sources &&
    alternate_plan_baselines == other.alternate_plan_baselines &&
    alternate_plan_limit == other.alternate_plan_limit &&
    are_plans_auto_accepted == other.are_plans_auto_accepted &&
    allowed_time_limit == other.allowed_time_limit
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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 205

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


185
186
187
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 185

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 194

def hash
  [alternate_plan_sources, alternate_plan_baselines, alternate_plan_limit, are_plans_auto_accepted, allowed_time_limit].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



238
239
240
241
242
243
244
245
246
247
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 238

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



232
233
234
 
# File 'lib/oci/database_management/models/spm_evolve_task_parameters.rb', line 232

def to_s
  to_hash.to_s
end