class OCI::DataIntegration::Models::TaskSummaryFromRestTask

The information about the Generic REST task.

Constants

API_CALL_MODE_ENUM
CANCEL_METHOD_TYPE_ENUM
METHOD_TYPE_ENUM

Attributes

api_call_mode[R]

The invocation type to be used for Generic REST invocation. @return [String]

auth_details[RW]

@return [OCI::DataIntegration::Models::AuthDetails]

cancel_endpoint[RW]

@return [OCI::DataIntegration::Models::Expression]

cancel_method_type[R]

The REST method to use for canceling the original request. @return [String]

endpoint[RW]

@return [OCI::DataIntegration::Models::Expression]

headers[RW]

The headers for the REST call. @return [Object]

json_data[RW]

JSON data for payload body. @return [String]

method_type[R]

The REST method to use. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/data_integration/models/task_summary_from_rest_task.rb, line 62
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'description': :'description',
    'object_version': :'objectVersion',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'input_ports': :'inputPorts',
    'output_ports': :'outputPorts',
    'parameters': :'parameters',
    'op_config_values': :'opConfigValues',
    'config_provider_delegate': :'configProviderDelegate',
    'metadata': :'metadata',
    'key_map': :'keyMap',
    'auth_details': :'authDetails',
    'endpoint': :'endpoint',
    'method_type': :'methodType',
    'headers': :'headers',
    'json_data': :'jsonData',
    'api_call_mode': :'apiCallMode',
    'cancel_endpoint': :'cancelEndpoint',
    'cancel_method_type': :'cancelMethodType'
    # 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] :key The value to assign to the {OCI::DataIntegration::Models::TaskSummary#key key} proprety @option attributes [String] :model_version The value to assign to the {OCI::DataIntegration::Models::TaskSummary#model_version model_version} proprety @option attributes [OCI::DataIntegration::Models::ParentReference] :parent_ref The value to assign to the {OCI::DataIntegration::Models::TaskSummary#parent_ref parent_ref} proprety @option attributes [String] :name The value to assign to the {OCI::DataIntegration::Models::TaskSummary#name name} proprety @option attributes [String] :description The value to assign to the {OCI::DataIntegration::Models::TaskSummary#description description} proprety @option attributes [Integer] :object_version The value to assign to the {OCI::DataIntegration::Models::TaskSummary#object_version object_version} proprety @option attributes [Integer] :object_status The value to assign to the {OCI::DataIntegration::Models::TaskSummary#object_status object_status} proprety @option attributes [String] :identifier The value to assign to the {OCI::DataIntegration::Models::TaskSummary#identifier identifier} proprety @option attributes [Array<OCI::DataIntegration::Models::InputPort>] :input_ports The value to assign to the {OCI::DataIntegration::Models::TaskSummary#input_ports input_ports} proprety @option attributes [Array<OCI::DataIntegration::Models::OutputPort>] :output_ports The value to assign to the {OCI::DataIntegration::Models::TaskSummary#output_ports output_ports} proprety @option attributes [Array<OCI::DataIntegration::Models::Parameter>] :parameters The value to assign to the {OCI::DataIntegration::Models::TaskSummary#parameters parameters} proprety @option attributes [OCI::DataIntegration::Models::ConfigValues] :op_config_values The value to assign to the {OCI::DataIntegration::Models::TaskSummary#op_config_values op_config_values} proprety @option attributes [OCI::DataIntegration::Models::ConfigProvider] :config_provider_delegate The value to assign to the {OCI::DataIntegration::Models::TaskSummary#config_provider_delegate config_provider_delegate} proprety @option attributes [OCI::DataIntegration::Models::ObjectMetadata] :metadata The value to assign to the {OCI::DataIntegration::Models::TaskSummary#metadata metadata} proprety @option attributes [Hash<String, String>] :key_map The value to assign to the {OCI::DataIntegration::Models::TaskSummary#key_map key_map} proprety @option attributes [OCI::DataIntegration::Models::AuthDetails] :auth_details The value to assign to the {#auth_details} property @option attributes [OCI::DataIntegration::Models::Expression] :endpoint The value to assign to the {#endpoint} property @option attributes [String] :method_type The value to assign to the {#method_type} property @option attributes [Object] :headers The value to assign to the {#headers} property @option attributes [String] :json_data The value to assign to the {#json_data} property @option attributes [String] :api_call_mode The value to assign to the {#api_call_mode} property @option attributes [OCI::DataIntegration::Models::Expression] :cancel_endpoint The value to assign to the {#cancel_endpoint} property @option attributes [String] :cancel_method_type The value to assign to the {#cancel_method_type} property

# File lib/oci/data_integration/models/task_summary_from_rest_task.rb, line 154
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['modelType'] = 'REST_TASK'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.auth_details = attributes[:'authDetails'] if attributes[:'authDetails']

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

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

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

  self.method_type = attributes[:'methodType'] if attributes[:'methodType']

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

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

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

  self.json_data = attributes[:'jsonData'] if attributes[:'jsonData']

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

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

  self.api_call_mode = attributes[:'apiCallMode'] if attributes[:'apiCallMode']
  self.api_call_mode = "SYNCHRONOUS" if api_call_mode.nil? && !attributes.key?(:'apiCallMode') # rubocop:disable Style/StringLiterals

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

  self.api_call_mode = attributes[:'api_call_mode'] if attributes[:'api_call_mode']
  self.api_call_mode = "SYNCHRONOUS" if api_call_mode.nil? && !attributes.key?(:'apiCallMode') && !attributes.key?(:'api_call_mode') # rubocop:disable Style/StringLiterals

  self.cancel_endpoint = attributes[:'cancelEndpoint'] if attributes[:'cancelEndpoint']

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

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

  self.cancel_method_type = attributes[:'cancelMethodType'] if attributes[:'cancelMethodType']

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

  self.cancel_method_type = attributes[:'cancel_method_type'] if attributes[:'cancel_method_type']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/data_integration/models/task_summary_from_rest_task.rb, line 94
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'description': :'String',
    'object_version': :'Integer',
    'object_status': :'Integer',
    'identifier': :'String',
    'input_ports': :'Array<OCI::DataIntegration::Models::InputPort>',
    'output_ports': :'Array<OCI::DataIntegration::Models::OutputPort>',
    'parameters': :'Array<OCI::DataIntegration::Models::Parameter>',
    'op_config_values': :'OCI::DataIntegration::Models::ConfigValues',
    'config_provider_delegate': :'OCI::DataIntegration::Models::ConfigProvider',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata',
    'key_map': :'Hash<String, String>',
    'auth_details': :'OCI::DataIntegration::Models::AuthDetails',
    'endpoint': :'OCI::DataIntegration::Models::Expression',
    'method_type': :'String',
    'headers': :'Object',
    'json_data': :'String',
    'api_call_mode': :'String',
    'cancel_endpoint': :'OCI::DataIntegration::Models::Expression',
    'cancel_method_type': :'String'
    # 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/data_integration/models/task_summary_from_rest_task.rb, line 238
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    model_type == other.model_type &&
    key == other.key &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    description == other.description &&
    object_version == other.object_version &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    input_ports == other.input_ports &&
    output_ports == other.output_ports &&
    parameters == other.parameters &&
    op_config_values == other.op_config_values &&
    config_provider_delegate == other.config_provider_delegate &&
    metadata == other.metadata &&
    key_map == other.key_map &&
    auth_details == other.auth_details &&
    endpoint == other.endpoint &&
    method_type == other.method_type &&
    headers == other.headers &&
    json_data == other.json_data &&
    api_call_mode == other.api_call_mode &&
    cancel_endpoint == other.cancel_endpoint &&
    cancel_method_type == other.cancel_method_type
end
api_call_mode=(api_call_mode) click to toggle source

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

# File lib/oci/data_integration/models/task_summary_from_rest_task.rb, line 219
def api_call_mode=(api_call_mode)
  raise "Invalid value for 'api_call_mode': this must be one of the values in API_CALL_MODE_ENUM." if api_call_mode && !API_CALL_MODE_ENUM.include?(api_call_mode)

  @api_call_mode = api_call_mode
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/data_integration/models/task_summary_from_rest_task.rb, line 291
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
cancel_method_type=(cancel_method_type) click to toggle source

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

# File lib/oci/data_integration/models/task_summary_from_rest_task.rb, line 227
def cancel_method_type=(cancel_method_type)
  raise "Invalid value for 'cancel_method_type': this must be one of the values in CANCEL_METHOD_TYPE_ENUM." if cancel_method_type && !CANCEL_METHOD_TYPE_ENUM.include?(cancel_method_type)

  @cancel_method_type = cancel_method_type
end
eql?(other) click to toggle source

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

# File lib/oci/data_integration/models/task_summary_from_rest_task.rb, line 271
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/data_integration/models/task_summary_from_rest_task.rb, line 280
def hash
  [model_type, key, model_version, parent_ref, name, description, object_version, object_status, identifier, input_ports, output_ports, parameters, op_config_values, config_provider_delegate, metadata, key_map, auth_details, endpoint, method_type, headers, json_data, api_call_mode, cancel_endpoint, cancel_method_type].hash
end
method_type=(method_type) click to toggle source

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

# File lib/oci/data_integration/models/task_summary_from_rest_task.rb, line 211
def method_type=(method_type)
  raise "Invalid value for 'method_type': this must be one of the values in METHOD_TYPE_ENUM." if method_type && !METHOD_TYPE_ENUM.include?(method_type)

  @method_type = method_type
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/data_integration/models/task_summary_from_rest_task.rb, line 324
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/data_integration/models/task_summary_from_rest_task.rb, line 318
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/data_integration/models/task_summary_from_rest_task.rb, line 341
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