class OCI::ObjectStorage::Models::ListObjects
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).
Attributes
The name of the object to use in the `start` parameter to obtain the next page of a truncated ListObjects
response. Avoid entering confidential information. Example: test/object1.log
@return [String]
[Required] An array of object summaries.
@return [Array<OCI::ObjectStorage::Models::ObjectSummary>]
Prefixes that are common to the results returned by the request if the request specified a delimiter.
@return [Array<String>]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/object_storage/models/list_objects.rb, line 31 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'objects': :'objects', 'prefixes': :'prefixes', 'next_start_with': :'nextStartWith' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Array<OCI::ObjectStorage::Models::ObjectSummary>] :objects The value to assign to the {#objects} property @option attributes [Array<String>] :prefixes The value to assign to the {#prefixes} property @option attributes [String] :next_start_with The value to assign to the {#next_start_with} property
# File lib/oci/object_storage/models/list_objects.rb, line 61 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.objects = attributes[:'objects'] if attributes[:'objects'] self.prefixes = attributes[:'prefixes'] if attributes[:'prefixes'] self.next_start_with = attributes[:'nextStartWith'] if attributes[:'nextStartWith'] raise 'You cannot provide both :nextStartWith and :next_start_with' if attributes.key?(:'nextStartWith') && attributes.key?(:'next_start_with') self.next_start_with = attributes[:'next_start_with'] if attributes[:'next_start_with'] end
Attribute type mapping.
# File lib/oci/object_storage/models/list_objects.rb, line 42 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'objects': :'Array<OCI::ObjectStorage::Models::ObjectSummary>', 'prefixes': :'Array<String>', 'next_start_with': :'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/list_objects.rb, line 85 def ==(other) return true if equal?(other) self.class == other.class && objects == other.objects && prefixes == other.prefixes && next_start_with == other.next_start_with 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/list_objects.rb, line 117 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/list_objects.rb, line 97 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/object_storage/models/list_objects.rb, line 106 def hash [objects, prefixes, next_start_with].hash 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/list_objects.rb, line 150 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/list_objects.rb, line 144 def to_s to_hash.to_s 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/list_objects.rb, line 167 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