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

Inherits:
Object
  • Object
show all
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 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.

Constant Summary collapse

PUBLIC_ACCESS_TYPE_ENUM = 
[
  PUBLIC_ACCESS_TYPE_NO_PUBLIC_ACCESS = 'NoPublicAccess'.freeze,
  PUBLIC_ACCESS_TYPE_OBJECT_READ = 'ObjectRead'.freeze,
  PUBLIC_ACCESS_TYPE_OBJECT_READ_WITHOUT_LIST = 'ObjectReadWithoutList'.freeze
].freeze
STORAGE_TIER_ENUM = 
[
  STORAGE_TIER_STANDARD = 'Standard'.freeze,
  STORAGE_TIER_ARCHIVE = 'Archive'.freeze
].freeze
VERSIONING_ENUM = 
[
  VERSIONING_ENABLED = 'Enabled'.freeze,
  VERSIONING_DISABLED = 'Disabled'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBucketDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :metadata (Hash<String, String>) —

    The value to assign to the #metadata property

  • :public_access_type (String) —

    The value to assign to the #public_access_type property

  • :storage_tier (String) —

    The value to assign to the #storage_tier property

  • :object_events_enabled (BOOLEAN) —

    The value to assign to the #object_events_enabled property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :kms_key_id (String) —

    The value to assign to the #kms_key_id property

  • :is_bucket_key_enabled (BOOLEAN) —

    The value to assign to the #is_bucket_key_enabled property

  • :versioning (String) —

    The value to assign to the #versioning property

  • :auto_tiering (String) —

    The value to assign to the #auto_tiering property

  • :bucket_scope (String) —

    The value to assign to the #bucket_scope property



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 179

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.is_bucket_key_enabled = attributes[:'isBucketKeyEnabled'] unless attributes[:'isBucketKeyEnabled'].nil?

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

  self.is_bucket_key_enabled = attributes[:'is_bucket_key_enabled'] unless attributes[:'is_bucket_key_enabled'].nil?

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

  self.bucket_scope = attributes[:'bucketScope'] if attributes[:'bucketScope']

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

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

Instance Attribute Details

#auto_tiering ⇒ String

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.

Returns:

  • (String) 


107
108
109
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 107

def auto_tiering
  @auto_tiering
end

#bucket_scope ⇒ String

Scope in which the bucket is unique. Default value is NAMESPACE. Bucket scope as NAMESPACE means that the bucket is unique only in the owning namespace/tenancy. Other tenancies can have a bucket with same name in their namespace. Bucket scope as REGION means that the bucket is regionally unique. No other tenancy can have a bucket with same name and scope REGION.

Returns:

  • (String) 


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

def bucket_scope
  @bucket_scope
end

#compartment_id ⇒ String

[Required] The ID of the compartment in which to create the bucket.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 39

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. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


81
82
83
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 81

def defined_tags
  @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. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


74
75
76
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 74

def freeform_tags
  @freeform_tags
end

#is_bucket_key_enabled ⇒ BOOLEAN

Specifies whether Object Storage should use intermediate cached Bucket Encryption Keys with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. This reduces calls to OCI Vault Key Management Service (KMS). Existing objects are not affected.

Returns:

  • (BOOLEAN) 


94
95
96
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 94

def is_bucket_key_enabled
  @is_bucket_key_enabled
end

#kms_key_id ⇒ String

The OCID 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.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 87

def kms_key_id
  @kms_key_id
end

#metadata ⇒ Hash<String, String>

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

Returns:

  • (Hash<String, String>) 


43
44
45
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 43

def metadata
  @metadata
end

#name ⇒ 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

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 35

def name
  @name
end

#object_events_enabled ⇒ BOOLEAN

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.

Returns:

  • (BOOLEAN) 


67
68
69
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 67

def object_events_enabled
  @object_events_enabled
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.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 52

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.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 60

def storage_tier
  @storage_tier
end

#versioning ⇒ 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.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 99

def versioning
  @versioning
end

Class Method Details

.attribute_map ⇒ Object

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 119

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',
    'is_bucket_key_enabled': :'isBucketKeyEnabled',
    'versioning': :'versioning',
    'auto_tiering': :'autoTiering',
    'bucket_scope': :'bucketScope'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 140

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',
    'is_bucket_key_enabled': :'BOOLEAN',
    'versioning': :'String',
    'auto_tiering': :'String',
    'bucket_scope': :'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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 283

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 &&
    is_bucket_key_enabled == other.is_bucket_key_enabled &&
    versioning == other.versioning &&
    auto_tiering == other.auto_tiering &&
    bucket_scope == other.bucket_scope
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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 325

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


305
306
307
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 305

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



314
315
316
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 314

def hash
  [name, compartment_id, metadata, public_access_type, storage_tier, object_events_enabled, freeform_tags, defined_tags, kms_key_id, is_bucket_key_enabled, versioning, auto_tiering, bucket_scope].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



358
359
360
361
362
363
364
365
366
367
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 358

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



352
353
354
 
# File 'lib/oci/object_storage/models/create_bucket_details.rb', line 352

def to_s
  to_hash.to_s
end