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](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Tasks/viewingworkrequest.htm).

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED',
LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS',
LIFECYCLE_STATE_FAILED = 'FAILED',
LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute 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):



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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 80

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}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

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

This attribute is required.

Returns:



21
22
23
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 21

def error_details
  @error_details
end

#id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the work request.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the work request.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 30

def lifecycle_state
  @lifecycle_state
end

#load_balancer_id ⇒ String

[Required] The [OCID](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the load balancer with which the work request is associated.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 36

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) 


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

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) 


55
56
57
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 55

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) 


62
63
64
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 62

def time_finished
  @time_finished
end

#type ⇒ String

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

Returns:

  • (String) 


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

def type
  @type
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 162

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      error_details == other_object.error_details &&
      id == other_object.id &&
      lifecycle_state == other_object.lifecycle_state &&
      load_balancer_id == other_object.load_balancer_id &&
      message == other_object.message &&
      time_accepted == other_object.time_accepted &&
      time_finished == other_object.time_finished &&
      type == other_object.type
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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 190

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


177
178
179
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 177

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



183
184
185
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 183

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 215

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



209
210
211
 
# File 'lib/oci/load_balancer/models/work_request.rb', line 209

def to_s
  to_hash.to_s
end