Class: OCI::Oda::Models::StorageLocation

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/oda/models/storage_location.rb

Overview

Properties that point to a specific object in Object Storage.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StorageLocation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :region_id (String) —

    The value to assign to the #region_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :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

[View source]

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
98
99
100
101
102
103
 
# File 'lib/oci/oda/models/storage_location.rb', line 68

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  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']
end

Instance Attribute Details

#bucket_name ⇒ String

[Required] The name of the bucket.

Returns:

  • (String) 

25
26
27
 
# File 'lib/oci/oda/models/storage_location.rb', line 25

def bucket_name
  @bucket_name
end

#compartment_id ⇒ String

[Required] The unique identifier for the compartment.

Returns:

  • (String) 

17
18
19
 
# File 'lib/oci/oda/models/storage_location.rb', line 17

def compartment_id
  @compartment_id
end

#namespace_name ⇒ String

[Required] The Object Storage namespace.

Returns:

  • (String) 

21
22
23
 
# File 'lib/oci/oda/models/storage_location.rb', line 21

def namespace_name
  @namespace_name
end

#object_name ⇒ String

[Required] The name of the object.

Returns:

  • (String) 

29
30
31
 
# File 'lib/oci/oda/models/storage_location.rb', line 29

def object_name
  @object_name
end

#region_id ⇒ String

[Required] The region id.

Returns:

  • (String) 

13
14
15
 
# File 'lib/oci/oda/models/storage_location.rb', line 13

def region_id
  @region_id
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'region_id': :'regionId',
    'compartment_id': :'compartmentId',
    'namespace_name': :'namespaceName',
    'bucket_name': :'bucketName',
    'object_name': :'objectName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

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

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

[View source]

112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/oda/models/storage_location.rb', line 112

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

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

[View source]

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/oda/models/storage_location.rb', line 146

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
[View source]

126
127
128
 
# File 'lib/oci/oda/models/storage_location.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

135
136
137
 
# File 'lib/oci/oda/models/storage_location.rb', line 135

def hash
  [region_id, compartment_id, namespace_name, bucket_name, object_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/oda/models/storage_location.rb', line 179

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

[View source]

173
174
175
 
# File 'lib/oci/oda/models/storage_location.rb', line 173

def to_s
  to_hash.to_s
end