Class: OCI::ObjectStorage::Models::PreauthenticatedRequestSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/models/preauthenticated_request_summary.rb

Overview

Get summary information about pre-authenticated requests.

Constant Summary collapse

ACCESS_TYPE_ENUM =
[
  ACCESS_TYPE_OBJECT_READ = 'ObjectRead'.freeze,
  ACCESS_TYPE_OBJECT_WRITE = 'ObjectWrite'.freeze,
  ACCESS_TYPE_OBJECT_READ_WRITE = 'ObjectReadWrite'.freeze,
  ACCESS_TYPE_ANY_OBJECT_WRITE = 'AnyObjectWrite'.freeze,
  ACCESS_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PreauthenticatedRequestSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String)

    The value to assign to the #id property

  • :name (String)

    The value to assign to the #name property

  • :object_name (String)

    The value to assign to the #object_name property

  • :access_type (String)

    The value to assign to the #access_type property

  • :time_expires (DateTime)

    The value to assign to the #time_expires property

  • :time_created (DateTime)

    The value to assign to the #time_created property



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
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 88

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.id = attributes[:'id'] if attributes[:'id']

  self.name = attributes[:'name'] if attributes[:'name']

  self.object_name = attributes[:'objectName'] if attributes[:'objectName']

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

  self.object_name = attributes[:'object_name'] if attributes[:'object_name']

  self.access_type = attributes[:'accessType'] if attributes[:'accessType']

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

  self.access_type = attributes[:'access_type'] if attributes[:'access_type']

  self.time_expires = attributes[:'timeExpires'] if attributes[:'timeExpires']

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

  self.time_expires = attributes[:'time_expires'] if attributes[:'time_expires']

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

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

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

Instance Attribute Details

#access_typeString

[Required] The operation that can be performed on this resource.

Returns:

  • (String)


36
37
38
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 36

def access_type
  @access_type
end

#idString

[Required] The unique identifier to use when directly addressing the pre-authenticated request.

Returns:

  • (String)


22
23
24
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 22

def id
  @id
end

#nameString

[Required] The user-provided name of the pre-authenticated request.

Returns:

  • (String)


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

def name
  @name
end

#object_nameString

The name of object that is being granted access to by the pre-authenticated request. This can be null and if it is, the pre-authenticated request grants access to the entire bucket.

Returns:

  • (String)


32
33
34
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 32

def object_name
  @object_name
end

#time_createdDateTime

[Required] The date when the pre-authenticated request was created as per RFC 3339.

Returns:

  • (DateTime)


46
47
48
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 46

def time_created
  @time_created
end

#time_expiresDateTime

[Required] The expiration date for the pre-authenticated request as per RFC 3339. After this date the pre-authenticated request will no longer be valid.

Returns:

  • (DateTime)


41
42
43
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 41

def time_expires
  @time_expires
end

Class Method Details

.attribute_mapObject

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



49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'object_name': :'objectName',
    'access_type': :'accessType',
    'time_expires': :'timeExpires',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'object_name': :'String',
    'access_type': :'String',
    'time_expires': :'DateTime',
    'time_created': :'DateTime'
    # 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



143
144
145
146
147
148
149
150
151
152
153
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 143

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    object_name == other.object_name &&
    access_type == other.access_type &&
    time_expires == other.time_expires &&
    time_created == other.time_created
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 178

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


158
159
160
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 158

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



167
168
169
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 167

def hash
  [id, name, object_name, access_type, time_expires, time_created].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
220
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 211

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



205
206
207
# File 'lib/oci/object_storage/models/preauthenticated_request_summary.rb', line 205

def to_s
  to_hash.to_s
end