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

Class Method 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):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 60

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

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) 


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

def next_start_with
  @next_start_with
end

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

[Required] An array of object summaries.

Returns:



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

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>) 


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

def prefixes
  @prefixes
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'objects': :'objects',
    'prefixes': :'prefixes',
    'next_start_with': :'nextStartWith'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 41

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



84
85
86
87
88
89
90
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 84

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

#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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 115

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


95
96
97
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 95

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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



147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 147

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



141
142
143
 
# File 'lib/oci/object_storage/models/list_objects.rb', line 141

def to_s
  to_hash.to_s
end