Class: OCI::ObjectStorage::Models::ListObjects

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/models/list_objects.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 = {}) ⇒ ListObjects

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 34

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

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

  if attributes[:'nextStartWith']
    self.next_start_with = attributes[:'nextStartWith']
  end

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

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

end

Instance Attribute Details

#next_start_with ⇒ String

The name of the object to use in the ‘startWith’ parameter to obtain the next page of a truncated ListObjects response. Avoid entering confidential information. Example: test/object1.log

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 26

def next_start_with
  @next_start_with
end

#objects ⇒ Array<OCI::ObjectStorage::Models::ObjectSummary>

[Required] An array of object summaries.

Returns:



14
15
16
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 14

def objects
  @objects
end

#prefixes ⇒ Array<String>

Prefixes that are common to the results returned by the request if the request specified a delimiter.

Returns:

  • (Array<String>) 


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

def prefixes
  @prefixes
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



62
63
64
65
66
67
68
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 62

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      objects == other_object.objects &&
      prefixes == other_object.prefixes &&
      next_start_with == other_object.next_start_with
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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 85

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


72
73
74
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 72

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



78
79
80
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 78

def hash
  [objects, prefixes, next_start_with].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 110

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



104
105
106
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 104

def to_s
  to_hash.to_s
end