Class: OCI::ObjectStorage::Models::PreauthenticatedRequest

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

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PreauthenticatedRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 51

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

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

  if attributes[:'accessUri']
    self.access_uri = attributes[:'accessUri']
  end

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

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

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

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

end

Instance Attribute Details

#access_typeString

The operation that can be performed on this resource.

Returns:

  • (String)


35
36
37
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 35

def access_type
  @access_type
end

#access_uriString

The URI to embed in the URL when using the pre-authenticated request.

Returns:

  • (String)


24
25
26
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 24

def access_uri
  @access_uri
end

#idString

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

Returns:

  • (String)


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

def id
  @id
end

#nameString

The user-provided name of the pre-authenticated request.

Returns:

  • (String)


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

def name
  @name
end

#object_nameString

The name of the object that is being granted access to by the pre-authenticated request. This can be null and if so, the pre-authenticated request grants access to the entire bucket. Avoid entering confidential information. Example: test/object1.log

Returns:

  • (String)


31
32
33
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 31

def object_name
  @object_name
end

#time_createdDateTime

The date when the pre-authenticated request was created as per specification [RFC 3339](tools.ietf.org/rfc/rfc3339).

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_expiresDateTime

The expiration date for the pre-authenticated request as per [RFC 3339](tools.ietf.org/rfc/rfc3339). After this date the pre-authenticated request will no longer be valid.

Returns:

  • (DateTime)


40
41
42
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 40

def time_expires
  @time_expires
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object)

    to be compared



99
100
101
102
103
104
105
106
107
108
109
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 99

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      id == other_object.id &&
      name == other_object.name &&
      access_uri == other_object.access_uri &&
      object_name == other_object.object_name &&
      access_type == other_object.access_type &&
      time_expires == other_object.time_expires &&
      time_created == other_object.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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 126

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


113
114
115
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 113

def eql?(other_object)
  self == other_object
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



119
120
121
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 119

def hash
  [id, name, access_uri, 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



151
152
153
154
155
156
157
158
159
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 151

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



145
146
147
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 145

def to_s
  to_hash.to_s
end