Class: OCI::DataLabelingServiceDataplane::Models::ObjectStorageSourceDetails

Inherits:
SourceDetails
  • Object
show all
Defined in:
lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb

Overview

Object Storage Source Details.

Constant Summary

Constants inherited from SourceDetails

SourceDetails::SOURCE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from SourceDetails

#source_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SourceDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ObjectStorageSourceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :relative_path (String) —

    The value to assign to the #relative_path property

  • :path (String) —

    The value to assign to the #path property

  • :offset (Float) —

    The value to assign to the #offset property

  • :length (Float) —

    The value to assign to the #length property



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 64

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

  attributes['sourceType'] = '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.relative_path = attributes[:'relativePath'] if attributes[:'relativePath']

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

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

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

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

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

Instance Attribute Details

#length ⇒ Float

The length from the offset into the file containing the content.

Returns:

  • (Float) 


26
27
28
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 26

def length
  @length
end

#offset ⇒ Float

The offset into the file containing the content.

Returns:

  • (Float) 


22
23
24
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 22

def offset
  @offset
end

#path ⇒ String

[Required] The full path of the file this record belongs to.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 18

def path
  @path
end

#relative_path ⇒ String

[Required] The path relative to the prefix specified in the dataset source details (file name).

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 14

def relative_path
  @relative_path
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/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'source_type': :'sourceType',
    'relative_path': :'relativePath',
    'path': :'path',
    'offset': :'offset',
    'length': :'length'
    # 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/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'source_type': :'String',
    'relative_path': :'String',
    'path': :'String',
    'offset': :'Float',
    'length': :'Float'
    # 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



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 94

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

  self.class == other.class &&
    source_type == other.source_type &&
    relative_path == other.relative_path &&
    path == other.path &&
    offset == other.offset &&
    length == other.length
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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 128

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


108
109
110
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 117

def hash
  [source_type, relative_path, path, offset, length].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 161

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



155
156
157
 
# File 'lib/oci/data_labeling_service_dataplane/models/object_storage_source_details.rb', line 155

def to_s
  to_hash.to_s
end