class OCI::ObjectStorage::Models::CreateBucketDetails
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
Constants
- PUBLIC_ACCESS_TYPE_ENUM
- STORAGE_TIER_ENUM
- VERSIONING_ENUM
Attributes
Set the auto tiering status on the bucket. By default, a bucket is created with auto tiering `Disabled`. Use this option to enable auto tiering during bucket creation. Objects in a bucket with auto tiering set to `InfrequentAccess` are transitioned automatically between the 'Standard' and 'InfrequentAccess' tiers based on the access pattern of the objects.
@return [String]
[Required] The ID of the compartment in which to create the bucket. @return [String]
The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.
@return [String]
Arbitrary string, up to 4KB, of keys and values for user-defined metadata. @return [Hash<String, String>]
[Required] The name of the bucket. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. Bucket names must be unique within an Object
Storage namespace. Avoid entering confidential information. example: Example: my-new-bucket1
@return [String]
Whether or not events are emitted for object state changes in this bucket. By default, `objectEventsEnabled` is set to `false`. Set `objectEventsEnabled` to `true` to emit events for object state changes. For more information about events, see [Overview of Events](docs.cloud.oracle.com/Content/Events/Concepts/eventsoverview.htm).
@return [BOOLEAN]
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.
@return [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.
@return [String]
Set the versioning status on the bucket. By default, a bucket is created with versioning `Disabled`. Use this option to enable versioning during bucket creation. Objects in a version enabled bucket are protected from overwrites and deletions. Previous versions of the same object will be available in the bucket.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/object_storage/models/create_bucket_details.rb, line 102 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'name': :'name', 'compartment_id': :'compartmentId', 'metadata': :'metadata', 'public_access_type': :'publicAccessType', 'storage_tier': :'storageTier', 'object_events_enabled': :'objectEventsEnabled', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'kms_key_id': :'kmsKeyId', 'versioning': :'versioning', 'auto_tiering': :'autoTiering' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Hash<String, String>] :metadata The value to assign to the {#metadata} property @option attributes [String] :public_access_type The value to assign to the {#public_access_type} property @option attributes [String] :storage_tier The value to assign to the {#storage_tier} property @option attributes [BOOLEAN] :object_events_enabled The value to assign to the {#object_events_enabled} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [String] :kms_key_id The value to assign to the {#kms_key_id} property @option attributes [String] :versioning The value to assign to the {#versioning} property @option attributes [String] :auto_tiering The value to assign to the {#auto_tiering} property
# File lib/oci/object_storage/models/create_bucket_details.rb, line 156 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.name = attributes[:'name'] if attributes[:'name'] 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.metadata = attributes[:'metadata'] if attributes[:'metadata'] self.public_access_type = attributes[:'publicAccessType'] if attributes[:'publicAccessType'] raise 'You cannot provide both :publicAccessType and :public_access_type' if attributes.key?(:'publicAccessType') && attributes.key?(:'public_access_type') self.public_access_type = attributes[:'public_access_type'] if attributes[:'public_access_type'] self.storage_tier = attributes[:'storageTier'] if attributes[:'storageTier'] raise 'You cannot provide both :storageTier and :storage_tier' if attributes.key?(:'storageTier') && attributes.key?(:'storage_tier') self.storage_tier = attributes[:'storage_tier'] if attributes[:'storage_tier'] self.object_events_enabled = attributes[:'objectEventsEnabled'] unless attributes[:'objectEventsEnabled'].nil? raise 'You cannot provide both :objectEventsEnabled and :object_events_enabled' if attributes.key?(:'objectEventsEnabled') && attributes.key?(:'object_events_enabled') self.object_events_enabled = attributes[:'object_events_enabled'] unless attributes[:'object_events_enabled'].nil? self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId'] raise 'You cannot provide both :kmsKeyId and :kms_key_id' if attributes.key?(:'kmsKeyId') && attributes.key?(:'kms_key_id') self.kms_key_id = attributes[:'kms_key_id'] if attributes[:'kms_key_id'] self.versioning = attributes[:'versioning'] if attributes[:'versioning'] self.auto_tiering = attributes[:'autoTiering'] if attributes[:'autoTiering'] raise 'You cannot provide both :autoTiering and :auto_tiering' if attributes.key?(:'autoTiering') && attributes.key?(:'auto_tiering') self.auto_tiering = attributes[:'auto_tiering'] if attributes[:'auto_tiering'] end
Attribute type mapping.
# File lib/oci/object_storage/models/create_bucket_details.rb, line 121 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'name': :'String', 'compartment_id': :'String', 'metadata': :'Hash<String, String>', 'public_access_type': :'String', 'storage_tier': :'String', 'object_events_enabled': :'BOOLEAN', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'kms_key_id': :'String', 'versioning': :'String', 'auto_tiering': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/object_storage/models/create_bucket_details.rb, line 248 def ==(other) return true if equal?(other) self.class == other.class && name == other.name && compartment_id == other.compartment_id && metadata == other.metadata && public_access_type == other.public_access_type && storage_tier == other.storage_tier && object_events_enabled == other.object_events_enabled && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags && kms_key_id == other.kms_key_id && versioning == other.versioning && auto_tiering == other.auto_tiering end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/object_storage/models/create_bucket_details.rb, line 288 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/object_storage/models/create_bucket_details.rb, line 268 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/object_storage/models/create_bucket_details.rb, line 277 def hash [name, compartment_id, metadata, public_access_type, storage_tier, object_events_enabled, freeform_tags, defined_tags, kms_key_id, versioning, auto_tiering].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] public_access_type
Object
to be assigned
# File lib/oci/object_storage/models/create_bucket_details.rb, line 221 def public_access_type=(public_access_type) raise "Invalid value for 'public_access_type': this must be one of the values in PUBLIC_ACCESS_TYPE_ENUM." if public_access_type && !PUBLIC_ACCESS_TYPE_ENUM.include?(public_access_type) @public_access_type = public_access_type end
Custom attribute writer method checking allowed values (enum). @param [Object] storage_tier
Object
to be assigned
# File lib/oci/object_storage/models/create_bucket_details.rb, line 229 def storage_tier=(storage_tier) raise "Invalid value for 'storage_tier': this must be one of the values in STORAGE_TIER_ENUM." if storage_tier && !STORAGE_TIER_ENUM.include?(storage_tier) @storage_tier = storage_tier end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/object_storage/models/create_bucket_details.rb, line 321 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/object_storage/models/create_bucket_details.rb, line 315 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] versioning Object
to be assigned
# File lib/oci/object_storage/models/create_bucket_details.rb, line 237 def versioning=(versioning) raise "Invalid value for 'versioning': this must be one of the values in VERSIONING_ENUM." if versioning && !VERSIONING_ENUM.include?(versioning) @versioning = versioning end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/object_storage/models/create_bucket_details.rb, line 338 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end