Class: OCI::AiDocument::Models::ObjectStorageDocumentDetails

Inherits:
DocumentDetails
  • Object
show all
Defined in:
lib/oci/ai_document/models/object_storage_document_details.rb

Overview

A document in OCI Object Storage.

Constant Summary

Constants inherited from DocumentDetails

DocumentDetails::SOURCE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DocumentDetails

#source

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DocumentDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ObjectStorageDocumentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :namespace_name (String) —

    The value to assign to the #namespace_name property

  • :bucket_name (String) —

    The value to assign to the #bucket_name property

  • :object_name (String) —

    The value to assign to the #object_name property

  • :page_range (Array<String>) —

    The value to assign to the #page_range property



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 64

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['source'] = 'OBJECT_STORAGE'

  super(attributes)

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

  self.namespace_name = attributes[:'namespaceName'] if attributes[:'namespaceName']

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

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

  self.bucket_name = attributes[:'bucketName'] if attributes[:'bucketName']

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

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

  self.object_name = attributes[:'objectName'] if attributes[:'objectName']

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

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

  self.page_range = attributes[:'pageRange'] if attributes[:'pageRange']

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

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

Instance Attribute Details

#bucket_name ⇒ String

[Required] The Object Storage bucket name.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 18

def bucket_name
  @bucket_name
end

#namespace_name ⇒ String

[Required] The Object Storage namespace.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 14

def namespace_name
  @namespace_name
end

#object_name ⇒ String

[Required] The Object Storage object name.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 22

def object_name
  @object_name
end

#page_range ⇒ Array<String>

The page ranges to be analysed.

Returns:

  • (Array<String>) 


26
27
28
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 26

def page_range
  @page_range
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'source': :'source',
    'namespace_name': :'namespaceName',
    'bucket_name': :'bucketName',
    'object_name': :'objectName',
    'page_range': :'pageRange'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'source': :'String',
    'namespace_name': :'String',
    'bucket_name': :'String',
    'object_name': :'String',
    'page_range': :'Array<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



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 106

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

  self.class == other.class &&
    source == other.source &&
    namespace_name == other.namespace_name &&
    bucket_name == other.bucket_name &&
    object_name == other.object_name &&
    page_range == other.page_range
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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 140

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


120
121
122
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 120

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 129

def hash
  [source, namespace_name, bucket_name, object_name, page_range].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 173

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



167
168
169
 
# File 'lib/oci/ai_document/models/object_storage_document_details.rb', line 167

def to_s
  to_hash.to_s
end