Class: OCI::ObjectStorage::Models::UpdateBucketDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/models/update_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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateBucketDetails

Initializes the object

Options Hash (attributes):

  • :namespace (String) —

    The value to assign to the #namespace property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :name (String) —

    The value to assign to the #name 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

  • :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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 121

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

The compartmentId for the compartment to move the bucket to.



24
25
26
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 24

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.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}



62
63
64
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 62

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`



55
56
57
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 55

def freeform_tags
  @freeform_tags
end

#kms_key_id ⇒ String

A KMS key OCID that will be associated with the given bucket. If it is empty the Update operation will actually remove the KMS key, if there is one, from the given bucket. Note that the old kms key should still be enbaled in KMS otherwise all the objects in the bucket encrypted with the old KMS key will no longer be accessible.



70
71
72
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 70

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.



34
35
36
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 34

def metadata
  @metadata
end

#name ⇒ String

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1



30
31
32
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 30

def name
  @name
end

#namespace ⇒ String

The Object Storage namespace in which the bucket lives.



20
21
22
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 20

def namespace
  @namespace
end

#object_events_enabled ⇒ BOOLEAN

A property that determines whether events will be generated for operations on objects in this bucket. This is false by default.



48
49
50
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 48

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.



42
43
44
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 42

def public_access_type
  @public_access_type
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 73

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'namespace': :'namespace',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'metadata': :'metadata',
    'public_access_type': :'publicAccessType',
    'object_events_enabled': :'objectEventsEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'kms_key_id': :'kmsKeyId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 90

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'namespace': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'metadata': :'Hash<String, String>',
    'public_access_type': :'String',
    'object_events_enabled': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'kms_key_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 185

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

  self.class == other.class &&
    namespace == other.namespace &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    metadata == other.metadata &&
    public_access_type == other.public_access_type &&
    object_events_enabled == other.object_events_enabled &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    kms_key_id == other.kms_key_id
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 223

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

See Also:

  • `==` method


203
204
205
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 203

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



212
213
214
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 212

def hash
  [namespace, compartment_id, name, metadata, public_access_type, object_events_enabled, freeform_tags, defined_tags, kms_key_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
265
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 256

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



250
251
252
 
# File 'lib/oci/object_storage/models/update_bucket_details.rb', line 250

def to_s
  to_hash.to_s
end