Class: OCI::DataSafe::Models::DownloadDiscoveryReportDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/download_discovery_report_details.rb

Overview

Details to download a discovery report.

Constant Summary collapse

REPORT_FORMAT_ENUM = 
[
  REPORT_FORMAT_PDF = 'PDF'.freeze,
  REPORT_FORMAT_XLS = 'XLS'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DownloadDiscoveryReportDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :discovery_job_id (String) —

    The value to assign to the #discovery_job_id property

  • :report_format (String) —

    The value to assign to the #report_format property



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 52

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

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

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

  self.report_format = attributes[:'reportFormat'] if attributes[:'reportFormat']
  self.report_format = "PDF" if report_format.nil? && !attributes.key?(:'reportFormat') # rubocop:disable Style/StringLiterals

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

  self.report_format = attributes[:'report_format'] if attributes[:'report_format']
  self.report_format = "PDF" if report_format.nil? && !attributes.key?(:'reportFormat') && !attributes.key?(:'report_format') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#discovery_job_id ⇒ String

The OCID of the discovery job.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 18

def discovery_job_id
  @discovery_job_id
end

#report_format ⇒ String

Format of the report.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 22

def report_format
  @report_format
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'discovery_job_id': :'discoveryJobId',
    'report_format': :'reportFormat'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 35

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'discovery_job_id': :'String',
    'report_format': :'String'
    # 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



88
89
90
91
92
93
94
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 88

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

  self.class == other.class &&
    discovery_job_id == other.discovery_job_id &&
    report_format == other.report_format
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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 119

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


99
100
101
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 99

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



108
109
110
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 108

def hash
  [discovery_job_id, report_format].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 152

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



146
147
148
 
# File 'lib/oci/data_safe/models/download_discovery_report_details.rb', line 146

def to_s
  to_hash.to_s
end