Class: OCI::UsageApi::Models::ObjectStorageLocation

Inherits:
ResultLocation show all
Defined in:
lib/oci/usage_api/models/object_storage_location.rb

Overview

The object storage location where usage or cost CSVs will be uploaded.

Constant Summary

Constants inherited from ResultLocation

ResultLocation::LOCATION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ResultLocation

#location_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ResultLocation

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ObjectStorageLocation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :region (String) —

    The value to assign to the #region property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :bucket_name (String) —

    The value to assign to the #bucket_name property



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 57

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

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

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

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

Instance Attribute Details

#bucket_name ⇒ String

[Required] The bucket name where usage or cost CSVs will be uploaded.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 22

def bucket_name
  @bucket_name
end

#namespace ⇒ String

[Required] The namespace needed to determine the object storage bucket.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 18

def namespace
  @namespace
end

#region ⇒ String

[Required] The destination Object Store Region specified by the customer.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 14

def region
  @region
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
33
34
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'location_type': :'locationType',
    'region': :'region',
    'namespace': :'namespace',
    'bucket_name': :'bucketName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'location_type': :'String',
    'region': :'String',
    'namespace': :'String',
    'bucket_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



85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 85

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

  self.class == other.class &&
    location_type == other.location_type &&
    region == other.region &&
    namespace == other.namespace &&
    bucket_name == other.bucket_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



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

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


98
99
100
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 98

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



107
108
109
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 107

def hash
  [location_type, region, namespace, bucket_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 151

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



145
146
147
 
# File 'lib/oci/usage_api/models/object_storage_location.rb', line 145

def to_s
  to_hash.to_s
end