Class: OCI::ObjectStorage::Models::BucketSummary
- Inherits:
-
Object
- Object
- OCI::ObjectStorage::Models::BucketSummary
- Defined in:
- lib/oci/object_storage/models/bucket_summary.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).
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The compartment ID in which the bucket is authorized.
-
#created_by ⇒ String
[Required] The OCID of the user who created the bucket.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#etag ⇒ String
[Required] The entity tag for the bucket.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#name ⇒ String
[Required] The name of the bucket.
-
#namespace ⇒ String
[Required] The namespace in which the bucket lives.
-
#time_created ⇒ DateTime
[Required] The date and time the bucket was created, as described in [RFC 2616](tools.ietf.org/rfc/rfc2616), section 14.29.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BucketSummary
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 = {}) ⇒ BucketSummary
Initializes the object
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 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 98 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.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.created_by = attributes[:'createdBy'] if attributes[:'createdBy'] raise 'You cannot provide both :createdBy and :created_by' if attributes.key?(:'createdBy') && attributes.key?(:'created_by') self.created_by = attributes[:'created_by'] if attributes[:'created_by'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.etag = attributes[:'etag'] if attributes[:'etag'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The compartment ID in which the bucket is authorized.
24 25 26 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 24 def compartment_id @compartment_id end |
#created_by ⇒ String
[Required] The OCID of the user who created the bucket.
28 29 30 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 28 def created_by @created_by 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"}`
50 51 52 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 50 def @defined_tags end |
#etag ⇒ String
[Required] The entity tag for the bucket.
36 37 38 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 36 def etag @etag 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"`
43 44 45 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 43 def @freeform_tags end |
#name ⇒ String
[Required] The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1
20 21 22 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 20 def name @name end |
#namespace ⇒ String
[Required] The namespace in which the bucket lives.
14 15 16 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 14 def namespace @namespace end |
#time_created ⇒ DateTime
[Required] The date and time the bucket was created, as described in [RFC 2616](tools.ietf.org/rfc/rfc2616), section 14.29.
32 33 34 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 32 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 53 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'namespace': :'namespace', 'name': :'name', 'compartment_id': :'compartmentId', 'created_by': :'createdBy', 'time_created': :'timeCreated', 'etag': :'etag', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 69 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'namespace': :'String', 'name': :'String', 'compartment_id': :'String', 'created_by': :'String', 'time_created': :'DateTime', 'etag': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 148 def ==(other) return true if equal?(other) self.class == other.class && namespace == other.namespace && name == other.name && compartment_id == other.compartment_id && created_by == other.created_by && time_created == other.time_created && etag == other.etag && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 184 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
164 165 166 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 164 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
173 174 175 |
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 173 def hash [namespace, name, compartment_id, created_by, time_created, etag, , ].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/bucket_summary.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/bucket_summary.rb', line 210 def to_s to_hash.to_s end |