Class: OCI::DatabaseManagement::Models::ImplementOptimizerStatisticsAdvisorRecommendationsJob

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

Overview

The job request details to implement the Optimizer Statistics Advisor task recommendations.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImplementOptimizerStatisticsAdvisorRecommendationsJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 76

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

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

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

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

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

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

  self.database_credential = attributes[:'databaseCredential'] if attributes[:'databaseCredential']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment in which the job resides.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 24

def compartment_id
  @compartment_id
end

#credentials ⇒ OCI::DatabaseManagement::Models::ManagedDatabaseCredential

Returns:



31
32
33
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 31

def credentials
  @credentials
end

#database_credential ⇒ OCI::DatabaseManagement::Models::DatabaseCredentialDetails

Returns:



34
35
36
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 34

def database_credential
  @database_credential
end

#description ⇒ String

The name of the execution.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 20

def description
  @description
end

#name ⇒ String

[Required] The name of the job. Valid characters are uppercase or lowercase letters, numbers, and "_". The name of the job cannot be modified. It must be unique in the compartment and must begin with an alphabetic character.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 16

def name
  @name
end

#result_location ⇒ OCI::DatabaseManagement::Models::JobExecutionResultLocation

This attribute is required.

Returns:



28
29
30
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 28

def result_location
  @result_location
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'result_location': :'resultLocation',
    'credentials': :'credentials',
    'database_credential': :'databaseCredential'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'result_location': :'OCI::DatabaseManagement::Models::JobExecutionResultLocation',
    'credentials': :'OCI::DatabaseManagement::Models::ManagedDatabaseCredential',
    'database_credential': :'OCI::DatabaseManagement::Models::DatabaseCredentialDetails'
    # 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



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 114

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    result_location == other.result_location &&
    credentials == other.credentials &&
    database_credential == other.database_credential
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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 149

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


129
130
131
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 129

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



138
139
140
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 138

def hash
  [name, description, compartment_id, result_location, credentials, database_credential].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 182

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



176
177
178
 
# File 'lib/oci/database_management/models/implement_optimizer_statistics_advisor_recommendations_job.rb', line 176

def to_s
  to_hash.to_s
end