Class: OCI::GenerativeAi::Models::ObjectStorageObject

Inherits:
ModelDataSource show all
Defined in:
lib/oci/generative_ai/models/object_storage_object.rb

Overview

Details about the object storage location.

Constant Summary

Constants inherited from ModelDataSource

ModelDataSource::SOURCE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ModelDataSource

#source_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ModelDataSource

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ObjectStorageObject

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

  • :prefix_name (String) —

    The value to assign to the #prefix_name property

  • :region (String) —

    The value to assign to the #region property



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
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 67

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

  attributes['sourceType'] = 'OBJECT_STORAGE_OBJECT'

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

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

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

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

Instance Attribute Details

#bucket_name ⇒ String

[Required] The name of the Object Storage bucket.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 19

def bucket_name
  @bucket_name
end

#namespace_name ⇒ String

[Required] The namespace of the Object Storage where the files are stored.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 15

def namespace_name
  @namespace_name
end

#prefix_name ⇒ String

[Required] The prefix path (or folder) within the bucket where files are located.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 23

def prefix_name
  @prefix_name
end

#region ⇒ String

The full canonical Oracle Cloud region identifier (e.g., "us-ashburn-1") where the object storage bucket containing the files resides.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 29

def region
  @region
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'source_type': :'sourceType',
    'namespace_name': :'namespaceName',
    'bucket_name': :'bucketName',
    'prefix_name': :'prefixName',
    'region': :'region'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'source_type': :'String',
    'namespace_name': :'String',
    'bucket_name': :'String',
    'prefix_name': :'String',
    'region': :'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



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 105

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

  self.class == other.class &&
    source_type == other.source_type &&
    namespace_name == other.namespace_name &&
    bucket_name == other.bucket_name &&
    prefix_name == other.prefix_name &&
    region == other.region
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



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

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


119
120
121
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 128

def hash
  [source_type, namespace_name, bucket_name, prefix_name, region].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 172

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



166
167
168
 
# File 'lib/oci/generative_ai/models/object_storage_object.rb', line 166

def to_s
  to_hash.to_s
end