Class: OCI::ObjectStorage::Models::CreateBucketDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/models/create_bucket_details.rb

Constant Summary collapse

PUBLIC_ACCESS_TYPE_ENUM = 
[PUBLIC_ACCESS_TYPE_NO_PUBLIC_ACCESS = 'NoPublicAccess',
PUBLIC_ACCESS_TYPE_OBJECT_READ = 'ObjectRead']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBucketDetails

Initializes the object



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 36

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}

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

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

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

  if attributes[:'publicAccessType']
    self.public_access_type = attributes[:'publicAccessType']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

The ID of the compartment in which to create the bucket.



19
20
21
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 19

def compartment_id
  @compartment_id
end

#metadata ⇒ Hash<String, String>

Arbitrary string, up to 4KB, of keys and values for user-defined metadata.



23
24
25
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 23

def metadata
  @metadata
end

#name ⇒ String

The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, and dashes. Bucket names must be unique within the namespace.



15
16
17
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 15

def name
  @name
end

#public_access_type ⇒ String

The type of public access available on this bucket. Allows authenticated caller to access the bucket or contents of this bucket. By default a bucket is set to NoPublicAccess. It is treated as NoPublicAccess when this value is not specified. When the type is NoPublicAccess the bucket does not allow any public access. When the type is ObjectRead the bucket allows public access to the GetObject, HeadObject, ListObjects.



31
32
33
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 31

def public_access_type
  @public_access_type
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.



72
73
74
75
76
77
78
79
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 72

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      name == other_object.name &&
      compartment_id == other_object.compartment_id &&
      metadata == other_object.metadata &&
      public_access_type == other_object.public_access_type
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 96

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)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", 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_object) ⇒ Boolean

See Also:

  • `==` method


83
84
85
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 83

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



89
90
91
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 89

def hash
  [name, compartment_id, metadata, public_access_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 121

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



115
116
117
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 115

def to_s
  to_hash.to_s
end