Class: OCI::Psa::Models::PrivateServiceAccess

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/psa/models/private_service_access.rb

Overview

Private Service Access (PSA) is a new way to create private accesss for a service.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PrivateServiceAccess

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

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

    The value to assign to the #freeform_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :security_attributes (Hash<String, Hash<String, Object>>) —

    The value to assign to the #security_attributes property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :id (String) —

    The value to assign to the #id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :vcn_id (String) —

    The value to assign to the #vcn_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :vnic_id (String) —

    The value to assign to the #vnic_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :service_id (String) —

    The value to assign to the #service_id property

  • :fqdns (Array<String>) —

    The value to assign to the #fqdns property

  • :ipv4_ip (String) —

    The value to assign to the #ipv4_ip property



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/psa/models/private_service_access.rb', line 214

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

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

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

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

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.vcn_id = attributes[:'vcnId'] if attributes[:'vcnId']

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.vnic_id = attributes[:'vnicId'] if attributes[:'vnicId']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

  self.service_id = attributes[:'serviceId'] if attributes[:'serviceId']

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

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

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

  self.ipv4_ip = attributes[:'ipv4Ip'] if attributes[:'ipv4Ip']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the private service access.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/psa/models/private_service_access.rb', line 27

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. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


35
36
37
 
# File 'lib/oci/psa/models/private_service_access.rb', line 35

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of this private service access.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/psa/models/private_service_access.rb', line 70

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/psa/models/private_service_access.rb', line 65

def display_name
  @display_name
end

#fqdns ⇒ Array<String>

[Required] The private service access FQDNs, which are going to be used to access the service.

Example: xyz.oraclecloud.com

Returns:

  • (Array<String>) 


130
131
132
 
# File 'lib/oci/psa/models/private_service_access.rb', line 130

def fqdns
  @fqdns
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


43
44
45
 
# File 'lib/oci/psa/models/private_service_access.rb', line 43

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the private service access.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/psa/models/private_service_access.rb', line 75

def id
  @id
end

#ipv4_ip ⇒ String

The private IPv4 address (in the consumer's VCN) that represents the access point for the associated service.

Returns:

  • (String) 


136
137
138
 
# File 'lib/oci/psa/models/private_service_access.rb', line 136

def ipv4_ip
  @ipv4_ip
end

#lifecycle_state ⇒ String

[Required] The private service access's current lifecycle state.

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/psa/models/private_service_access.rb', line 111

def lifecycle_state
  @lifecycle_state
end

#nsg_ids ⇒ Array<String>

A list of the OCIDs of the network security groups that the private service access's VNIC belongs to. For more information about NSGs, see NetworkSecurityGroup.

Returns:

  • (Array<String>) 


118
119
120
 
# File 'lib/oci/psa/models/private_service_access.rb', line 118

def nsg_ids
  @nsg_ids
end

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

Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources.

Example: {\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}

Returns:

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


59
60
61
 
# File 'lib/oci/psa/models/private_service_access.rb', line 59

def security_attributes
  @security_attributes
end

#service_id ⇒ String

[Required] A unique service identifier for which the private service access was created.

Returns:

  • (String) 


123
124
125
 
# File 'lib/oci/psa/models/private_service_access.rb', line 123

def service_id
  @service_id
end

#subnet_id ⇒ String

[Required] The OCID of the subnet that the private service access belongs to.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/psa/models/private_service_access.rb', line 101

def subnet_id
  @subnet_id
end

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

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


50
51
52
 
# File 'lib/oci/psa/models/private_service_access.rb', line 50

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the private service access was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/psa/models/private_service_access.rb', line 82

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the PrivateServiceAccess was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


89
90
91
 
# File 'lib/oci/psa/models/private_service_access.rb', line 89

def time_updated
  @time_updated
end

#vcn_id ⇒ String

[Required] The OCID of the VCN that the private service access belongs to.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/psa/models/private_service_access.rb', line 95

def vcn_id
  @vcn_id
end

#vnic_id ⇒ String

[Required] An OCID of the private service access's VNIC, which resides in the private service access's VCN .

Returns:

  • (String) 


107
108
109
 
# File 'lib/oci/psa/models/private_service_access.rb', line 107

def vnic_id
  @vnic_id
end

Class Method Details

.attribute_map ⇒ Object

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/psa/models/private_service_access.rb', line 139

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'security_attributes': :'securityAttributes',
    'display_name': :'displayName',
    'description': :'description',
    'id': :'id',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'vnic_id': :'vnicId',
    'lifecycle_state': :'lifecycleState',
    'nsg_ids': :'nsgIds',
    'service_id': :'serviceId',
    'fqdns': :'fqdns',
    'ipv4_ip': :'ipv4Ip'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/psa/models/private_service_access.rb', line 165

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'description': :'String',
    'id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'vnic_id': :'String',
    'lifecycle_state': :'String',
    'nsg_ids': :'Array<String>',
    'service_id': :'String',
    'fqdns': :'Array<String>',
    'ipv4_ip': :'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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/oci/psa/models/private_service_access.rb', line 337

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    system_tags == other.system_tags &&
    security_attributes == other.security_attributes &&
    display_name == other.display_name &&
    description == other.description &&
    id == other.id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    vnic_id == other.vnic_id &&
    lifecycle_state == other.lifecycle_state &&
    nsg_ids == other.nsg_ids &&
    service_id == other.service_id &&
    fqdns == other.fqdns &&
    ipv4_ip == other.ipv4_ip
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



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/oci/psa/models/private_service_access.rb', line 384

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


364
365
366
 
# File 'lib/oci/psa/models/private_service_access.rb', line 364

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



373
374
375
 
# File 'lib/oci/psa/models/private_service_access.rb', line 373

def hash
  [compartment_id, defined_tags, freeform_tags, system_tags, security_attributes, display_name, description, id, time_created, time_updated, vcn_id, subnet_id, vnic_id, lifecycle_state, nsg_ids, service_id, fqdns, ipv4_ip].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



417
418
419
420
421
422
423
424
425
426
 
# File 'lib/oci/psa/models/private_service_access.rb', line 417

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



411
412
413
 
# File 'lib/oci/psa/models/private_service_access.rb', line 411

def to_s
  to_hash.to_s
end