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

Inherits:
Object
  • Object
show all
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 [Managing Access to Buckets and Objects](docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingaccess.htm).

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Constant Summary collapse

ACCESS_TYPE_ENUM =

rubocop:disable Metrics/LineLength

[
  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 = {}) ⇒ PreauthenticatedRequest

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

  • :access_uri (String) —

    The value to assign to the #access_uri 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



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

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.

Returns:

  • (String) 


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

def access_type
  @access_type
end

#access_uri ⇒ String

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

Returns:

  • (String) 


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

def access_uri
  @access_uri
end

#id ⇒ String

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

Returns:

  • (String) 


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

def id
  @id
end

#name ⇒ String

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

Returns:

  • (String) 


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

def name
  @name
end

#object_name ⇒ String

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) 


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

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).

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 56

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.

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 50

def time_expires
  @time_expires
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 59

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.



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 74

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.

Parameters:

  • other (Object) —

    the other object to be compared



164
165
166
167
168
169
170
171
172
173
174
 
# 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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 199

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


179
180
181
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 179

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



188
189
190
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 188

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

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 231

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

Returns:

  • (String) —

    String presentation of the object



225
226
227
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 225

def to_s
  to_hash.to_s
end