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 = 
[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

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 65

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

  raise 'You cannot provide both :accessUri and :access_uri' if attributes.key?(:'accessUri') && attributes.key?(:'access_uri')

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

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

  raise 'You cannot provide both :objectName and :object_name' if attributes.key?(:'objectName') && attributes.key?(:'object_name')

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

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

  raise 'You cannot provide both :accessType and :access_type' if attributes.key?(:'accessType') && attributes.key?(:'access_type')

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

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

  raise 'You cannot provide both :timeExpires and :time_expires' if attributes.key?(:'timeExpires') && attributes.key?(:'time_expires')

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

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

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

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

end

Instance Attribute Details

#access_type ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def access_uri
  @access_uri
end

#id ⇒ String

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

Returns:

  • (String) 


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

def id
  @id
end

#name ⇒ String

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

Returns:

  • (String) 


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

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) 


38
39
40
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 38

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) 


53
54
55
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 53

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) 


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

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



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 143

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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 170

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


157
158
159
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 157

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 163

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



195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/object_storage/models/preauthenticated_request.rb', line 195

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



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

def to_s
  to_hash.to_s
end