Class: OCI::ObjectStorage::Models::BucketSummary

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

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BucketSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :namespace (String) —

    The value to assign to the #namespace property

  • :name (String) —

    The value to assign to the #name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :created_by (String) —

    The value to assign to the #created_by property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :etag (String) —

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 62

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

  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[:'createdBy']
    self.created_by = attributes[:'createdBy']
  end

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

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

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

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

  if attributes[:'freeformTags']
    self.freeform_tags = 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.freeform_tags = attributes[:'freeform_tags']
  end

  if attributes[:'definedTags']
    self.defined_tags = 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.defined_tags = attributes[:'defined_tags']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The compartment ID in which the bucket is authorized.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 23

def compartment_id
  @compartment_id
end

#created_by ⇒ String

[Required] The OCID of the user who created the bucket.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 27

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"}`

Returns:

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


49
50
51
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 49

def defined_tags
  @defined_tags
end

#etag ⇒ String

[Required] The entity tag for the bucket.

Returns:

  • (String) 


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

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"`

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#name ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 19

def name
  @name
end

#namespace ⇒ String

[Required] The namespace in which the bucket lives.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 13

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.

Returns:

  • (DateTime) 


31
32
33
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 31

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 134

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      namespace == other_object.namespace &&
      name == other_object.name &&
      compartment_id == other_object.compartment_id &&
      created_by == other_object.created_by &&
      time_created == other_object.time_created &&
      etag == other_object.etag &&
      freeform_tags == other_object.freeform_tags &&
      defined_tags == other_object.defined_tags
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 162

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

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 149

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



155
156
157
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 155

def hash
  [namespace, name, compartment_id, created_by, time_created, etag, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 187

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



181
182
183
 
# File 'lib/oci/object_storage/models/bucket_summary.rb', line 181

def to_s
  to_hash.to_s
end