Class: OCI::LoadBalancer::Models::WorkRequest

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

Overview

Many of the API requests you use to create and configure load balancing do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility for in-progress work flows. For more information about work requests, see Viewing the State of a Work Request.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_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):



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
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
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 129

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

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

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

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

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

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

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

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

  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_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']

  self.error_details = attributes[:'errorDetails'] if attributes[:'errorDetails']

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

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

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment containing the load balancer.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 43

def compartment_id
  @compartment_id
end

#error_details ⇒ Array<OCI::LoadBalancer::Models::WorkRequestError>

This attribute is required.

Returns:



78
79
80
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 78

def error_details
  @error_details
end

#id ⇒ String

[Required] The OCID of the work request.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 26

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the work request.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 48

def lifecycle_state
  @lifecycle_state
end

#load_balancer_id ⇒ String

[Required] The OCID of the load balancer with which the work request is associated.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 32

def load_balancer_id
  @load_balancer_id
end

#message ⇒ String

[Required] A collection of data, related to the load balancer provisioning process, that helps with debugging in the event of failure. Possible data elements include:

  • workflow name

  • event ID

  • work request ID

  • load balancer ID

  • workflow completion message

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 60

def message
  @message
end

#time_accepted ⇒ DateTime

[Required] The date and time the work request was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 67

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The date and time the work request was completed, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


74
75
76
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 74

def time_finished
  @time_finished
end

#type ⇒ String

[Required] The type of action the work request represents.

Example: CreateListener

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 39

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 81

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'load_balancer_id': :'loadBalancerId',
    'type': :'type',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'message': :'message',
    'time_accepted': :'timeAccepted',
    'time_finished': :'timeFinished',
    'error_details': :'errorDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 98

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'load_balancer_id': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'message': :'String',
    'time_accepted': :'DateTime',
    'time_finished': :'DateTime',
    'error_details': :'Array<OCI::LoadBalancer::Models::WorkRequestError>'
    # 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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 198

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

  self.class == other.class &&
    id == other.id &&
    load_balancer_id == other.load_balancer_id &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    message == other.message &&
    time_accepted == other.time_accepted &&
    time_finished == other.time_finished &&
    error_details == other.error_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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 236

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


216
217
218
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 216

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



225
226
227
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 225

def hash
  [id, load_balancer_id, type, compartment_id, lifecycle_state, message, time_accepted, time_finished, error_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



269
270
271
272
273
274
275
276
277
278
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 269

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



263
264
265
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 263

def to_s
  to_hash.to_s
end