Class: OCI::Lockbox::Models::CreateAccessRequestDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/lockbox/models/create_access_request_details.rb

Overview

The configuration details for a new access request. We don't accept a compartmentId parameter because it is implied to be the same as the lockbox as a subsidiary resource. The requestorId is also based on the caller user info.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAccessRequestDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :lockbox_id (String) —

    The value to assign to the #lockbox_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :context (Hash<String, String>) —

    The value to assign to the #context property

  • :access_duration (String) —

    The value to assign to the #access_duration property

  • :ticket_number (String) —

    The value to assign to the #ticket_number property



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
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 80

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.lockbox_id = attributes[:'lockboxId'] if attributes[:'lockboxId']

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

  self.lockbox_id = attributes[:'lockbox_id'] if attributes[:'lockbox_id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.description = attributes[:'description'] if attributes[:'description']

  self.context = attributes[:'context'] if attributes[:'context']

  self.access_duration = attributes[:'accessDuration'] if attributes[:'accessDuration']

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

  self.access_duration = attributes[:'access_duration'] if attributes[:'access_duration']

  self.ticket_number = attributes[:'ticketNumber'] if attributes[:'ticketNumber']

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

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

Instance Attribute Details

#access_duration ⇒ String

[Required] The maximum amount of time operator has access to associated resources.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 32

def access_duration
  @access_duration
end

#context ⇒ Hash<String, String>

The context object containing the access request specific details.

Returns:

  • (Hash<String, String>) 


28
29
30
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 28

def context
  @context
end

#description ⇒ String

[Required] The rationale for requesting the access request.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 24

def description
  @description
end

#display_name ⇒ String

The name of the access request.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 20

def display_name
  @display_name
end

#lockbox_id ⇒ String

[Required] The unique identifier (OCID) of the lockbox box that the access request is associated with which is immutable.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 16

def lockbox_id
  @lockbox_id
end

#ticket_number ⇒ String

The ticket number raised by external customers Example: 3-37509643121

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 38

def ticket_number
  @ticket_number
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 41

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'lockbox_id': :'lockboxId',
    'display_name': :'displayName',
    'description': :'description',
    'context': :'context',
    'access_duration': :'accessDuration',
    'ticket_number': :'ticketNumber'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 55

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'lockbox_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'context': :'Hash<String, String>',
    'access_duration': :'String',
    'ticket_number': :'String'
    # 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



122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 122

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    lockbox_id == other.lockbox_id &&
    display_name == other.display_name &&
    description == other.description &&
    context == other.context &&
    access_duration == other.access_duration &&
    ticket_number == other.ticket_number
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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 157

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


137
138
139
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 146

def hash
  [lockbox_id, display_name, description, context, access_duration, ticket_number].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 190

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



184
185
186
 
# File 'lib/oci/lockbox/models/create_access_request_details.rb', line 184

def to_s
  to_hash.to_s
end