Class: OCI::Lockbox::Models::CreateLockboxDetails

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

Overview

The information about new Lockbox.

Constant Summary collapse

LOCKBOX_PARTNER_ENUM = 
[
  LOCKBOX_PARTNER_FAAAS = 'FAAAS'.freeze,
  LOCKBOX_PARTNER_CANARY = 'CANARY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateLockboxDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 119

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

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

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

  self.lockbox_partner = attributes[:'lockboxPartner'] if attributes[:'lockboxPartner']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.partner_id = attributes[:'partnerId'] if attributes[:'partnerId']

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

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

  self.partner_compartment_id = attributes[:'partnerCompartmentId'] if attributes[:'partnerCompartmentId']

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

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

  self.approval_template_id = attributes[:'approvalTemplateId'] if attributes[:'approvalTemplateId']

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

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

  self.max_access_duration = attributes[:'maxAccessDuration'] if attributes[:'maxAccessDuration']

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

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

  self.access_context_attributes = attributes[:'accessContextAttributes'] if attributes[:'accessContextAttributes']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#access_context_attributes ⇒ OCI::Lockbox::Models::AccessContextAttributeCollection

This attribute is required.

Returns:



50
51
52
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 50

def access_context_attributes
  @access_context_attributes
end

#approval_template_id ⇒ String

Approval template ID

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 42

def approval_template_id
  @approval_template_id
end

#compartment_id ⇒ String

[Required] The unique identifier (OCID) of the compartment where the resource is located.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 30

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


62
63
64
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 62

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Lockbox Identifier

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 18

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


56
57
58
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 56

def freeform_tags
  @freeform_tags
end

#lockbox_partner ⇒ String

The partner using this lockbox to lock a resource.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 26

def lockbox_partner
  @lockbox_partner
end

#max_access_duration ⇒ String

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

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 46

def max_access_duration
  @max_access_duration
end

#partner_compartment_id ⇒ String

Compartment Identifier

Returns:

  • (String) 


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

def partner_compartment_id
  @partner_compartment_id
end

#partner_id ⇒ String

The unique identifier (OCID) of partner resource using this lockbox to lock a resource

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 34

def partner_id
  @partner_id
end

#resource_id ⇒ String

[Required] The unique identifier (OCID) of the customer's resource.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 22

def resource_id
  @resource_id
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 65

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'resource_id': :'resourceId',
    'lockbox_partner': :'lockboxPartner',
    'compartment_id': :'compartmentId',
    'partner_id': :'partnerId',
    'partner_compartment_id': :'partnerCompartmentId',
    'approval_template_id': :'approvalTemplateId',
    'max_access_duration': :'maxAccessDuration',
    'access_context_attributes': :'accessContextAttributes',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 84

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'resource_id': :'String',
    'lockbox_partner': :'String',
    'compartment_id': :'String',
    'partner_id': :'String',
    'partner_compartment_id': :'String',
    'approval_template_id': :'String',
    'max_access_duration': :'String',
    'access_context_attributes': :'OCI::Lockbox::Models::AccessContextAttributeCollection',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 207

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

  self.class == other.class &&
    display_name == other.display_name &&
    resource_id == other.resource_id &&
    lockbox_partner == other.lockbox_partner &&
    compartment_id == other.compartment_id &&
    partner_id == other.partner_id &&
    partner_compartment_id == other.partner_compartment_id &&
    approval_template_id == other.approval_template_id &&
    max_access_duration == other.max_access_duration &&
    access_context_attributes == other.access_context_attributes &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 247

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


227
228
229
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 227

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



236
237
238
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 236

def hash
  [display_name, resource_id, lockbox_partner, compartment_id, partner_id, partner_compartment_id, approval_template_id, max_access_duration, access_context_attributes, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 280

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



274
275
276
 
# File 'lib/oci/lockbox/models/create_lockbox_details.rb', line 274

def to_s
  to_hash.to_s
end