Class: OCI::ObjectStorage::Models::CreatePreauthenticatedRequestDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/object_storage/models/create_preauthenticated_request_details.rb

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']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePreauthenticatedRequestDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

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



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/object_storage/models/create_preauthenticated_request_details.rb', line 37

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[:'name']
    self.name = attributes[:'name']
  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

end

Instance Attribute Details

#access_type ⇒ String

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

Returns:

  • (String) 


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

def access_type
  @access_type
end

#name ⇒ String

[Required] A user-specified name for the pre-authenticated request. Helpful for management purposes.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/object_storage/models/create_preauthenticated_request_details.rb', line 15

def name
  @name
end

#object_name ⇒ String

The name of object that is being granted access to by the pre-authenticated request. This can be null and if it is, the pre-authenticated request grants access to the entire bucket.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/object_storage/models/create_preauthenticated_request_details.rb', line 19

def object_name
  @object_name
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) 


28
29
30
 
# File 'lib/oci/object_storage/models/create_preauthenticated_request_details.rb', line 28

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



91
92
93
94
95
96
97
98
 
# File 'lib/oci/object_storage/models/create_preauthenticated_request_details.rb', line 91

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      name == other_object.name &&
      object_name == other_object.object_name &&
      access_type == other_object.access_type &&
      time_expires == other_object.time_expires
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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/object_storage/models/create_preauthenticated_request_details.rb', line 115

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


102
103
104
 
# File 'lib/oci/object_storage/models/create_preauthenticated_request_details.rb', line 102

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



108
109
110
 
# File 'lib/oci/object_storage/models/create_preauthenticated_request_details.rb', line 108

def hash
  [name, object_name, access_type, time_expires].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/object_storage/models/create_preauthenticated_request_details.rb', line 140

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



134
135
136
 
# File 'lib/oci/object_storage/models/create_preauthenticated_request_details.rb', line 134

def to_s
  to_hash.to_s
end