class OCI::ObjectStorage::Models::CreatePreauthenticatedRequestDetails

CreatePreauthenticatedRequestDetails model.

Constants

ACCESS_TYPE_ENUM

Attributes

access_type[R]

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

bucket_listing_action[RW]

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]

name[RW]

[Required] A user-specified name for the pre-authenticated request. Names can be helpful in managing pre-authenticated requests. Avoid entering confidential information.

@return [String]

object_name[RW]

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 if the access type allows that. The object name can be a prefix as well, in that case pre-authenticated request grants access to all the objects within the bucket starting with that prefix provided that we have the correct access type.

@return [String]

time_expires[RW]

[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_map() click to toggle source

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

# File lib/oci/object_storage/models/create_preauthenticated_request_details.rb, line 51
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'bucket_listing_action': :'bucketListingAction',
    'object_name': :'objectName',
    'access_type': :'accessType',
    'time_expires': :'timeExpires'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :bucket_listing_action The value to assign to the {#bucket_listing_action} property @option attributes [String] :object_name The value to assign to the {#object_name} 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

# File lib/oci/object_storage/models/create_preauthenticated_request_details.rb, line 87
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.name = attributes[:'name'] if attributes[:'name']

  self.bucket_listing_action = attributes[:'bucketListingAction'] if attributes[:'bucketListingAction']
  self.bucket_listing_action = "Deny" if bucket_listing_action.nil? && !attributes.key?(:'bucketListingAction') # rubocop:disable Style/StringLiterals

  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.bucket_listing_action = "Deny" if bucket_listing_action.nil? && !attributes.key?(:'bucketListingAction') && !attributes.key?(:'bucket_listing_action') # rubocop:disable Style/StringLiterals

  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']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/object_storage/models/create_preauthenticated_request_details.rb, line 64
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'bucket_listing_action': :'String',
    'object_name': :'String',
    'access_type': :'String',
    'time_expires': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/object_storage/models/create_preauthenticated_request_details.rb, line 137
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    bucket_listing_action == other.bucket_listing_action &&
    object_name == other.object_name &&
    access_type == other.access_type &&
    time_expires == other.time_expires
end
access_type=(access_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] access_type Object to be assigned

# File lib/oci/object_storage/models/create_preauthenticated_request_details.rb, line 126
def access_type=(access_type)
  raise "Invalid value for 'access_type': this must be one of the values in ACCESS_TYPE_ENUM." if access_type && !ACCESS_TYPE_ENUM.include?(access_type)

  @access_type = access_type
end
build_from_hash(attributes) click to toggle source

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/create_preauthenticated_request_details.rb, line 171
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/object_storage/models/create_preauthenticated_request_details.rb, line 151
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/object_storage/models/create_preauthenticated_request_details.rb, line 160
def hash
  [name, bucket_listing_action, object_name, access_type, time_expires].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/object_storage/models/create_preauthenticated_request_details.rb, line 204
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/object_storage/models/create_preauthenticated_request_details.rb, line 198
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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/create_preauthenticated_request_details.rb, line 221
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