Class: OCI::ObjectStorage::Models::PreauthenticatedRequest
- Inherits:
-
Object
- Object
- OCI::ObjectStorage::Models::PreauthenticatedRequest
- Defined in:
- lib/oci/object_storage/models/preauthenticated_request.rb
Overview
Pre-authenticated requests provide a way to let users access a bucket or an object without having their own credentials. When you create a pre-authenticated request, a unique URL is generated. Users in your organization, partners, or third parties can use this URL to access the targets identified in the pre-authenticated request. See [Using Pre-Authenticated Requests](docs.cloud.oracle.com/Content/Object/Tasks/usingpreauthenticatedrequests.htm).
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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
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
-
#access_type ⇒ String
[Required] The operation that can be performed on this resource.
-
#access_uri ⇒ String
[Required] The URI to embed in the URL when using the pre-authenticated request.
-
#id ⇒ String
[Required] The unique identifier to use when directly addressing the pre-authenticated request.
-
#name ⇒ String
[Required] The user-provided name of the pre-authenticated request.
-
#object_name ⇒ String
The name of the object that is being granted access to by the pre-authenticated request.
-
#time_created ⇒ DateTime
[Required] The date when the pre-authenticated request was created as per specification [RFC 3339](tools.ietf.org/rfc/rfc3339).
-
#time_expires ⇒ DateTime
[Required] The expiration date for the pre-authenticated request as per [RFC 3339](tools.ietf.org/rfc/rfc3339).
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PreauthenticatedRequest
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ PreauthenticatedRequest
Initializes the object
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 103 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.access_uri = attributes[:'accessUri'] if attributes[:'accessUri'] raise 'You cannot provide both :accessUri and :access_uri' if attributes.key?(:'accessUri') && attributes.key?(:'access_uri') self.access_uri = attributes[:'access_uri'] if attributes[:'access_uri'] 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_type ⇒ String
[Required] The operation that can be performed on this resource.
46 47 48 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 46 def access_type @access_type end |
#access_uri ⇒ String
[Required] The URI to embed in the URL when using the pre-authenticated request.
36 37 38 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 36 def access_uri @access_uri end |
#id ⇒ String
[Required] The unique identifier to use when directly addressing the pre-authenticated request.
28 29 30 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 28 def id @id end |
#name ⇒ String
[Required] The user-provided name of the pre-authenticated request.
32 33 34 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 32 def name @name end |
#object_name ⇒ String
The name of the object that is being granted access to by the pre-authenticated request. Avoid entering confidential information. The object name can be null and if so, the pre-authenticated request grants access to the entire bucket.
42 43 44 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 42 def object_name @object_name end |
#time_created ⇒ DateTime
[Required] The date when the pre-authenticated request was created as per specification [RFC 3339](tools.ietf.org/rfc/rfc3339).
58 59 60 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 58 def time_created @time_created end |
#time_expires ⇒ DateTime
[Required] 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.
52 53 54 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 52 def time_expires @time_expires end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 61 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'name': :'name', 'access_uri': :'accessUri', 'object_name': :'objectName', 'access_type': :'accessType', 'time_expires': :'timeExpires', 'time_created': :'timeCreated' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 76 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'name': :'String', 'access_uri': :'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.
164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 164 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && name == other.name && access_uri == other.access_uri && 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
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 200 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
180 181 182 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 180 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
189 190 191 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 189 def hash [id, name, access_uri, object_name, access_type, time_expires, time_created].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
233 234 235 236 237 238 239 240 241 242 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 233 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
227 228 229 |
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 227 def to_s to_hash.to_s end |