class OCI::LoadBalancer::Models::WorkRequest

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.cloud.oracle.com/Content/Balance/Tasks/viewingworkrequest.htm).

Constants

LIFECYCLE_STATE_ENUM

Attributes

compartment_id[RW]

The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer. @return [String]

error_details[RW]

This attribute is required. @return [Array<OCI::LoadBalancer::Models::WorkRequestError>]

id[RW]

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the work request. @return [String]

lifecycle_state[R]

[Required] The current state of the work request.

@return [String]

load_balancer_id[RW]

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer with which the work request is associated.

@return [String]

message[RW]

[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

@return [String]

time_accepted[RW]

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

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

@return [DateTime]

time_finished[RW]

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

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

@return [DateTime]

type[RW]

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

Example: `CreateListener`

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/load_balancer/models/work_request.rb, line 80
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :load_balancer_id The value to assign to the {#load_balancer_id} property @option attributes [String] :type The value to assign to the {#type} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :message The value to assign to the {#message} property @option attributes [DateTime] :time_accepted The value to assign to the {#time_accepted} property @option attributes [DateTime] :time_finished The value to assign to the {#time_finished} property @option attributes [Array<OCI::LoadBalancer::Models::WorkRequestError>] :error_details The value to assign to the {#error_details} property

# File lib/oci/load_balancer/models/work_request.rb, line 128
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/load_balancer/models/work_request.rb, line 97
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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/load_balancer/models/work_request.rb, line 197
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/load_balancer/models/work_request.rb, line 235
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/load_balancer/models/work_request.rb, line 215
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/load_balancer/models/work_request.rb, line 224
def hash
  [id, load_balancer_id, type, compartment_id, lifecycle_state, message, time_accepted, time_finished, error_details].hash
end
lifecycle_state=(lifecycle_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state Object to be assigned

# File lib/oci/load_balancer/models/work_request.rb, line 181
def lifecycle_state=(lifecycle_state)
  # rubocop:disable Style/ConditionalAssignment
  if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
    OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
  else
    @lifecycle_state = lifecycle_state
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/load_balancer/models/work_request.rb, line 268
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/load_balancer/models/work_request.rb, line 262
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/load_balancer/models/work_request.rb, line 285
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end