class OCI::ObjectStorage::Models::PreauthenticatedRequest
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).
Constants
- ACCESS_TYPE_ENUM
- BUCKET_LISTING_ACTION_ENUM
Attributes
[Required] The operation that can be performed on this resource. @return [String]
[Required] The URI to embed in the URL when using the pre-authenticated request. @return [String]
Specifies whether a list operation is allowed on a PAR with accessType "AnyObjectRead" or "AnyObjectReadWrite". Deny: Prevents the user from performing a list operation. ListObjects: Authorizes the user to perform a list operation.
@return [String]
[Required] The unique identifier to use when directly addressing the pre-authenticated request. @return [String]
[Required] The user-provided name of the pre-authenticated request. @return [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. Example: test/object1.log
@return [String]
[Required] The date when the pre-authenticated request was created as per specification [RFC 3339](tools.ietf.org/html/rfc3339).
@return [DateTime]
[Required] The expiration date for the pre-authenticated request as per [RFC 3339](tools.ietf.org/html/rfc3339). After this date the pre-authenticated request will no longer be valid.
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 78 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'name': :'name', 'access_uri': :'accessUri', 'object_name': :'objectName', 'bucket_listing_action': :'bucketListingAction', 'access_type': :'accessType', 'time_expires': :'timeExpires', 'time_created': :'timeCreated' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :access_uri The value to assign to the {#access_uri} property @option attributes [String] :object_name The value to assign to the {#object_name} property @option attributes [String] :bucket_listing_action The value to assign to the {#bucket_listing_action} property @option attributes [String] :access_type The value to assign to the {#access_type} property @option attributes [DateTime] :time_expires The value to assign to the {#time_expires} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 123 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.bucket_listing_action = attributes[:'bucketListingAction'] if attributes[:'bucketListingAction'] raise 'You cannot provide both :bucketListingAction and :bucket_listing_action' if attributes.key?(:'bucketListingAction') && attributes.key?(:'bucket_listing_action') self.bucket_listing_action = attributes[:'bucket_listing_action'] if attributes[:'bucket_listing_action'] 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
Attribute type mapping.
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 94 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'name': :'String', 'access_uri': :'String', 'object_name': :'String', 'bucket_listing_action': :'String', 'access_type': :'String', 'time_expires': :'DateTime', 'time_created': :'DateTime' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 203 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 && bucket_listing_action == other.bucket_listing_action && access_type == other.access_type && time_expires == other.time_expires && time_created == other.time_created end
Custom attribute writer method checking allowed values (enum). @param [Object] access_type
Object
to be assigned
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 187 def access_type=(access_type) # rubocop:disable Style/ConditionalAssignment if access_type && !ACCESS_TYPE_ENUM.include?(access_type) OCI.logger.debug("Unknown value for 'access_type' [" + access_type + "]. Mapping to 'ACCESS_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @access_type = ACCESS_TYPE_UNKNOWN_ENUM_VALUE else @access_type = access_type end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] bucket_listing_action
Object
to be assigned
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 174 def bucket_listing_action=(bucket_listing_action) # rubocop:disable Style/ConditionalAssignment if bucket_listing_action && !BUCKET_LISTING_ACTION_ENUM.include?(bucket_listing_action) OCI.logger.debug("Unknown value for 'bucket_listing_action' [" + bucket_listing_action + "]. Mapping to 'BUCKET_LISTING_ACTION_UNKNOWN_ENUM_VALUE'") if OCI.logger @bucket_listing_action = BUCKET_LISTING_ACTION_UNKNOWN_ENUM_VALUE else @bucket_listing_action = bucket_listing_action end # rubocop:enable Style/ConditionalAssignment end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 240 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 220 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 229 def hash [id, name, access_uri, object_name, bucket_listing_action, access_type, time_expires, time_created].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 273 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 267 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/object_storage/models/preauthenticated_request.rb, line 290 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end