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

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# 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

Instance Attribute Details

#next_start_withString

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

Returns:

  • (String)


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

def next_start_with
  @next_start_with
end

#objectsArray<OCI::ObjectStorage::Models::ObjectSummary>

[Required] An array of object summaries.



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

def objects
  @objects
end

#prefixesArray<String>

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

Returns:

  • (Array<String>)


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

def prefixes
  @prefixes
end

Class Method Details

.attribute_mapObject

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



31
32
33
34
35
36
37
38
39
# 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

.swagger_typesObject

Attribute type mapping.



42
43
44
45
46
47
48
49
50
# 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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



85
86
87
88
89
90
91
92
# 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

#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



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

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


97
98
99
# File 'lib/oci/object_storage/models/list_objects.rb', line 97

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



106
107
108
# File 'lib/oci/object_storage/models/list_objects.rb', line 106

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



150
151
152
153
154
155
156
157
158
159
# 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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



144
145
146
# File 'lib/oci/object_storage/models/list_objects.rb', line 144

def to_s
  to_hash.to_s
end