Class: OCI::ObjectStorage::Models::CreateBucketDetails
- Inherits:
-
Object
- Object
- OCI::ObjectStorage::Models::CreateBucketDetails
- Defined in:
- lib/oci/object_storage/models/create_bucket_details.rb
Overview
To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
Constant Summary collapse
- PUBLIC_ACCESS_TYPE_ENUM =
[PUBLIC_ACCESS_TYPE_NO_PUBLIC_ACCESS = 'NoPublicAccess', PUBLIC_ACCESS_TYPE_OBJECT_READ = 'ObjectRead', PUBLIC_ACCESS_TYPE_OBJECT_READ_WITHOUT_LIST = 'ObjectReadWithoutList']
- STORAGE_TIER_ENUM =
[STORAGE_TIER_STANDARD = 'Standard', STORAGE_TIER_ARCHIVE = 'Archive']
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The ID of the compartment in which to create the bucket.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#metadata ⇒ Hash<String, String>
Arbitrary string, up to 4KB, of keys and values for user-defined metadata.
-
#name ⇒ String
[Required] The name of the bucket.
-
#public_access_type ⇒ String
The type of public access enabled on this bucket.
-
#storage_tier ⇒ String
The type of storage tier of this bucket.
Instance Method Summary collapse
-
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other_object) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateBucketDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ CreateBucketDetails
Initializes the object
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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 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/object_storage/models/create_bucket_details.rb', line 76 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 raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') if attributes[:'compartment_id'] self.compartment_id = attributes[:'compartment_id'] end if attributes[:'metadata'] self. = attributes[:'metadata'] end if attributes[:'publicAccessType'] self.public_access_type = attributes[:'publicAccessType'] end raise 'You cannot provide both :publicAccessType and :public_access_type' if attributes.key?(:'publicAccessType') && attributes.key?(:'public_access_type') if attributes[:'public_access_type'] self.public_access_type = attributes[:'public_access_type'] end if attributes[:'storageTier'] self.storage_tier = attributes[:'storageTier'] end raise 'You cannot provide both :storageTier and :storage_tier' if attributes.key?(:'storageTier') && attributes.key?(:'storage_tier') if attributes[:'storage_tier'] self.storage_tier = attributes[:'storage_tier'] end if attributes[:'freeformTags'] self. = attributes[:'freeformTags'] end raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') if attributes[:'freeform_tags'] self. = attributes[:'freeform_tags'] end if attributes[:'definedTags'] self. = attributes[:'definedTags'] end raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') if attributes[:'defined_tags'] self. = attributes[:'defined_tags'] end end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The ID of the compartment in which to create the bucket.
29 30 31 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 29 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}`
64 65 66 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 64 def @defined_tags end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`
57 58 59 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 57 def @freeform_tags end |
#metadata ⇒ Hash<String, String>
Arbitrary string, up to 4KB, of keys and values for user-defined metadata.
33 34 35 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 33 def @metadata end |
#name ⇒ String
[Required] The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, and dashes. Bucket names must be unique within the namespace. Avoid entering confidential information. example: Example: my-new-bucket1
25 26 27 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 25 def name @name end |
#public_access_type ⇒ String
The type of public access enabled on this bucket. A bucket is set to ‘NoPublicAccess` by default, which only allows an authenticated caller to access the bucket and its contents. When `ObjectRead` is enabled on the bucket, public access is allowed for the `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled on the bucket, public access is allowed for the `GetObject` and `HeadObject` operations.
42 43 44 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 42 def public_access_type @public_access_type end |
#storage_tier ⇒ String
The type of storage tier of this bucket. A bucket is set to ‘Standard’ tier by default, which means the bucket will be put in the standard storage tier. When ‘Archive’ tier type is set explicitly, the bucket is put in the Archive Storage tier. The ‘storageTier’ property is immutable after bucket is created.
50 51 52 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 50 def storage_tier @storage_tier end |
Instance Method Details
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 164 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 && == other_object. && public_access_type == other_object.public_access_type && storage_tier == other_object.storage_tier && == other_object. && == other_object. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 191 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.public_method("#{key}=").call(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.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_object) ⇒ Boolean
178 179 180 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 178 def eql?(other_object) self == other_object end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
184 185 186 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 184 def hash [name, compartment_id, , public_access_type, storage_tier, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
216 217 218 219 220 221 222 223 224 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 216 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
210 211 212 |
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 210 def to_s to_hash.to_s end |