Class: OCI::Bds::Models::WorkRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/work_request.rb

Overview

Description of the work request status.

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_CREATE_BDS = 'CREATE_BDS'.freeze,
  OPERATION_TYPE_UPDATE_BDS = 'UPDATE_BDS'.freeze,
  OPERATION_TYPE_DELETE_BDS = 'DELETE_BDS'.freeze,
  OPERATION_TYPE_ADD_BLOCK_STORAGE = 'ADD_BLOCK_STORAGE'.freeze,
  OPERATION_TYPE_ADD_MASTER_NODES = 'ADD_MASTER_NODES'.freeze,
  OPERATION_TYPE_ADD_UTILITY_NODES = 'ADD_UTILITY_NODES'.freeze,
  OPERATION_TYPE_ADD_WORKER_NODES = 'ADD_WORKER_NODES'.freeze,
  OPERATION_TYPE_ADD_CLOUD_SQL = 'ADD_CLOUD_SQL'.freeze,
  OPERATION_TYPE_REMOVE_CLOUD_SQL = 'REMOVE_CLOUD_SQL'.freeze,
  OPERATION_TYPE_CHANGE_COMPARTMENT_FOR_BDS = 'CHANGE_COMPARTMENT_FOR_BDS'.freeze,
  OPERATION_TYPE_CHANGE_SHAPE = 'CHANGE_SHAPE'.freeze,
  OPERATION_TYPE_UPDATE_INFRA = 'UPDATE_INFRA'.freeze,
  OPERATION_TYPE_RESTART_NODE = 'RESTART_NODE'.freeze,
  OPERATION_TYPE_REMOVE_NODE = 'REMOVE_NODE'.freeze,
  OPERATION_TYPE_CREATE_AUTOSCALE_CONFIG = 'CREATE_AUTOSCALE_CONFIG'.freeze,
  OPERATION_TYPE_UPDATE_AUTOSCALE_CONFIG = 'UPDATE_AUTOSCALE_CONFIG'.freeze,
  OPERATION_TYPE_DELETE_AUTOSCALE_CONFIG = 'DELETE_AUTOSCALE_CONFIG'.freeze,
  OPERATION_TYPE_AUTOSCALE_CONFIG = 'AUTOSCALE_CONFIG'.freeze,
  OPERATION_TYPE_AUTOSCALE_RUN = 'AUTOSCALE_RUN'.freeze,
  OPERATION_TYPE_CREATE_API_KEY = 'CREATE_API_KEY'.freeze,
  OPERATION_TYPE_DELETE_API_KEY = 'DELETE_API_KEY'.freeze,
  OPERATION_TYPE_TEST_OBJECT_STORE_CONNECTION = 'TEST_OBJECT_STORE_CONNECTION'.freeze,
  OPERATION_TYPE_CREATE_METASTORE_CONFIG = 'CREATE_METASTORE_CONFIG'.freeze,
  OPERATION_TYPE_DELETE_METASTORE_CONFIG = 'DELETE_METASTORE_CONFIG'.freeze,
  OPERATION_TYPE_UPDATE_METASTORE_CONFIG = 'UPDATE_METASTORE_CONFIG'.freeze,
  OPERATION_TYPE_ACTIVATE_METASTORE_CONFIG = 'ACTIVATE_METASTORE_CONFIG'.freeze,
  OPERATION_TYPE_TEST_METASTORE_CONFIG = 'TEST_METASTORE_CONFIG'.freeze,
  OPERATION_TYPE_PATCH_BDS = 'PATCH_BDS'.freeze,
  OPERATION_TYPE_PATCH_ODH = 'PATCH_ODH'.freeze,
  OPERATION_TYPE_PATCH_OS = 'PATCH_OS'.freeze,
  OPERATION_TYPE_STOP_BDS = 'STOP_BDS'.freeze,
  OPERATION_TYPE_START_BDS = 'START_BDS'.freeze,
  OPERATION_TYPE_ADD_KAFKA = 'ADD_KAFKA'.freeze,
  OPERATION_TYPE_REMOVE_KAFKA = 'REMOVE_KAFKA'.freeze,
  OPERATION_TYPE_EXECUTE_BOOTSTRAP_SCRIPT = 'EXECUTE_BOOTSTRAP_SCRIPT'.freeze,
  OPERATION_TYPE_ODH_SERVICE_CERTIFICATE_UPDATE = 'ODH_SERVICE_CERTIFICATE_UPDATE'.freeze,
  OPERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_CANCELING = 'CANCELING'.freeze,
  STATUS_CANCELED = 'CANCELED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/bds/models/work_request.rb', line 151

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

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

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

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

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

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

  self.percent_complete = attributes[:'percentComplete'] if attributes[:'percentComplete']

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

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

  self.time_accepted = attributes[:'timeAccepted'] if attributes[:'timeAccepted']

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

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

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

  self.time_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/bds/models/work_request.rb', line 69

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The ID of the work request.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/bds/models/work_request.rb', line 64

def id
  @id
end

#operation_type ⇒ String

[Required] The type of this work request.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/bds/models/work_request.rb', line 73

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] Percentage of this work request completed.

Returns:

  • (Float) 


85
86
87
 
# File 'lib/oci/bds/models/work_request.rb', line 85

def percent_complete
  @percent_complete
end

#resources ⇒ Array<OCI::Bds::Models::WorkRequestResource>

[Required] The resources affected by this work request.

Returns:



81
82
83
 
# File 'lib/oci/bds/models/work_request.rb', line 81

def resources
  @resources
end

#status ⇒ String

[Required] The status of this work request.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/bds/models/work_request.rb', line 77

def status
  @status
end

#time_accepted ⇒ DateTime

[Required] The date and time the request was created, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


90
91
92
 
# File 'lib/oci/bds/models/work_request.rb', line 90

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The time the object was finished, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


100
101
102
 
# File 'lib/oci/bds/models/work_request.rb', line 100

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The time the request was started, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


95
96
97
 
# File 'lib/oci/bds/models/work_request.rb', line 95

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/bds/models/work_request.rb', line 103

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'operation_type': :'operationType',
    'status': :'status',
    'resources': :'resources',
    'percent_complete': :'percentComplete',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/bds/models/work_request.rb', line 120

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'operation_type': :'String',
    'status': :'String',
    'resources': :'Array<OCI::Bds::Models::WorkRequestResource>',
    'percent_complete': :'Float',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime'
    # 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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/bds/models/work_request.rb', line 233

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    operation_type == other.operation_type &&
    status == other.status &&
    resources == other.resources &&
    percent_complete == other.percent_complete &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished
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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/oci/bds/models/work_request.rb', line 271

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


251
252
253
 
# File 'lib/oci/bds/models/work_request.rb', line 251

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



260
261
262
 
# File 'lib/oci/bds/models/work_request.rb', line 260

def hash
  [id, compartment_id, operation_type, status, resources, percent_complete, time_accepted, time_started, time_finished].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/bds/models/work_request.rb', line 304

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



298
299
300
 
# File 'lib/oci/bds/models/work_request.rb', line 298

def to_s
  to_hash.to_s
end