Class: OCI::IdentityDomains::Models::CloudGateServer

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/cloud_gate_server.rb

Overview

Resource representing a Cloud Gate server block

Constant Summary collapse

IDCS_PREVENTED_OPERATIONS_ENUM =
[
  IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'.freeze,
  IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'.freeze,
  IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'.freeze,
  IDCS_PREVENTED_OPERATIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CloudGateServer

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 358

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

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

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

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

  self.idcs_created_by = attributes[:'idcsCreatedBy'] if attributes[:'idcsCreatedBy']

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

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

  self.idcs_last_modified_by = attributes[:'idcsLastModifiedBy'] if attributes[:'idcsLastModifiedBy']

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

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

  self.idcs_prevented_operations = attributes[:'idcsPreventedOperations'] if attributes[:'idcsPreventedOperations']

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

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

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

  self.delete_in_progress = attributes[:'deleteInProgress'] unless attributes[:'deleteInProgress'].nil?

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

  self.delete_in_progress = attributes[:'delete_in_progress'] unless attributes[:'delete_in_progress'].nil?

  self.idcs_last_upgraded_in_release = attributes[:'idcsLastUpgradedInRelease'] if attributes[:'idcsLastUpgradedInRelease']

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

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

  self.domain_ocid = attributes[:'domainOcid'] if attributes[:'domainOcid']

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

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

  self.compartment_ocid = attributes[:'compartmentOcid'] if attributes[:'compartmentOcid']

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

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

  self.tenancy_ocid = attributes[:'tenancyOcid'] if attributes[:'tenancyOcid']

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

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

  self.is_opc_service = attributes[:'isOPCService'] unless attributes[:'isOPCService'].nil?

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

  self.is_opc_service = attributes[:'is_opc_service'] unless attributes[:'is_opc_service'].nil?

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

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

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

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

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

  self.ssl = attributes[:'ssl'] unless attributes[:'ssl'].nil?

  self.nginx_settings = attributes[:'nginxSettings'] if attributes[:'nginxSettings']

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

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

  self.cloud_gate = attributes[:'cloudGate'] if attributes[:'cloudGate']

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

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

Instance Attribute Details

#cloud_gateOCI::IdentityDomains::Models::CloudGateServerCloudGate

This attribute is required.



271
272
273
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 271

def cloud_gate
  @cloud_gate
end

#compartment_ocidString

OCI Compartment Id (ocid) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String)


151
152
153
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 151

def compartment_ocid
  @compartment_ocid
end

#delete_in_progressBOOLEAN

A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN)


109
110
111
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 109

def delete_in_progress
  @delete_in_progress
end

#descriptionString

Brief description for this Cloud Gate server block

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String)


195
196
197
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 195

def description
  @description
end

#display_nameString

[Required] Display name for the Server block

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: always - type: string - uniqueness: server

Returns:

  • (String)


209
210
211
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 209

def display_name
  @display_name
end

#domain_ocidString

OCI Domain Id (ocid) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String)


137
138
139
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 137

def domain_ocid
  @domain_ocid
end

#host_nameString

[Required] Hostname for the Server block

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: always - type: string - uniqueness: none

Returns:

  • (String)


223
224
225
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 223

def host_name
  @host_name
end

#idString

Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global

Returns:

  • (String)


31
32
33
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 31

def id
  @id
end

#idcs_created_byOCI::IdentityDomains::Models::IdcsCreatedBy



65
66
67
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 65

def idcs_created_by
  @idcs_created_by
end

#idcs_last_modified_byOCI::IdentityDomains::Models::IdcsLastModifiedBy



68
69
70
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 68

def idcs_last_modified_by
  @idcs_last_modified_by
end

#idcs_last_upgraded_in_releaseString

The release number when the resource was upgraded.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String)


123
124
125
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 123

def idcs_last_upgraded_in_release
  @idcs_last_upgraded_in_release
end

#idcs_prevented_operationsArray<String>

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

SCIM++ Properties: - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (Array<String>)


81
82
83
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 81

def idcs_prevented_operations
  @idcs_prevented_operations
end

#is_opc_serviceBOOLEAN

Indicates whether this resource was created by OPC

Added In: 19.3.3

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN)


181
182
183
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 181

def is_opc_service
  @is_opc_service
end

#metaOCI::IdentityDomains::Models::Meta



62
63
64
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 62

def meta
  @meta
end

#nginx_settingsString

More nginx Settings. JSON encoded text block

SCIM++ Properties: - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String)


267
268
269
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 267

def nginx_settings
  @nginx_settings
end

#ocidString

Unique OCI identifier for the SCIM Resource.

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: global

Returns:

  • (String)


45
46
47
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 45

def ocid
  @ocid
end

#portInteger

[Required] Port for the Server Block

SCIM++ Properties: - caseExact: true - idcsMaxValue: 65535 - idcsMinValue: 1 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none

Returns:

  • (Integer)


239
240
241
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 239

def port
  @port
end

#schemasArray<String>

[Required] REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (Array<String>)


59
60
61
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 59

def schemas
  @schemas
end

#sslBOOLEAN

[Required] SSL flag for the Server Block

SCIM++ Properties: - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN)


253
254
255
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 253

def ssl
  @ssl
end

#tagsArray<OCI::IdentityDomains::Models::Tags>

A list of tags on this resource.

SCIM++ Properties: - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none



95
96
97
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 95

def tags
  @tags
end

#tenancy_ocidString

OCI Tenant Id (ocid) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String)


165
166
167
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 165

def tenancy_ocid
  @tenancy_ocid
end

Class Method Details

.attribute_mapObject

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



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
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 274

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'ocid': :'ocid',
    'schemas': :'schemas',
    'meta': :'meta',
    'idcs_created_by': :'idcsCreatedBy',
    'idcs_last_modified_by': :'idcsLastModifiedBy',
    'idcs_prevented_operations': :'idcsPreventedOperations',
    'tags': :'tags',
    'delete_in_progress': :'deleteInProgress',
    'idcs_last_upgraded_in_release': :'idcsLastUpgradedInRelease',
    'domain_ocid': :'domainOcid',
    'compartment_ocid': :'compartmentOcid',
    'tenancy_ocid': :'tenancyOcid',
    'is_opc_service': :'isOPCService',
    'description': :'description',
    'display_name': :'displayName',
    'host_name': :'hostName',
    'port': :'port',
    'ssl': :'ssl',
    'nginx_settings': :'nginxSettings',
    'cloud_gate': :'cloudGate'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 303

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'ocid': :'String',
    'schemas': :'Array<String>',
    'meta': :'OCI::IdentityDomains::Models::Meta',
    'idcs_created_by': :'OCI::IdentityDomains::Models::IdcsCreatedBy',
    'idcs_last_modified_by': :'OCI::IdentityDomains::Models::IdcsLastModifiedBy',
    'idcs_prevented_operations': :'Array<String>',
    'tags': :'Array<OCI::IdentityDomains::Models::Tags>',
    'delete_in_progress': :'BOOLEAN',
    'idcs_last_upgraded_in_release': :'String',
    'domain_ocid': :'String',
    'compartment_ocid': :'String',
    'tenancy_ocid': :'String',
    'is_opc_service': :'BOOLEAN',
    'description': :'String',
    'display_name': :'String',
    'host_name': :'String',
    'port': :'Integer',
    'ssl': :'BOOLEAN',
    'nginx_settings': :'String',
    'cloud_gate': :'OCI::IdentityDomains::Models::CloudGateServerCloudGate'
    # 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



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 486

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

  self.class == other.class &&
    id == other.id &&
    ocid == other.ocid &&
    schemas == other.schemas &&
    meta == other.meta &&
    idcs_created_by == other.idcs_created_by &&
    idcs_last_modified_by == other.idcs_last_modified_by &&
    idcs_prevented_operations == other.idcs_prevented_operations &&
    tags == other.tags &&
    delete_in_progress == other.delete_in_progress &&
    idcs_last_upgraded_in_release == other.idcs_last_upgraded_in_release &&
    domain_ocid == other.domain_ocid &&
    compartment_ocid == other.compartment_ocid &&
    tenancy_ocid == other.tenancy_ocid &&
    is_opc_service == other.is_opc_service &&
    description == other.description &&
    display_name == other.display_name &&
    host_name == other.host_name &&
    port == other.port &&
    ssl == other.ssl &&
    nginx_settings == other.nginx_settings &&
    cloud_gate == other.cloud_gate
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



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 536

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


516
517
518
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 516

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



525
526
527
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 525

def hash
  [id, ocid, schemas, meta, idcs_created_by, idcs_last_modified_by, idcs_prevented_operations, tags, delete_in_progress, idcs_last_upgraded_in_release, domain_ocid, compartment_ocid, tenancy_ocid, is_opc_service, description, display_name, host_name, port, ssl, nginx_settings, cloud_gate].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



569
570
571
572
573
574
575
576
577
578
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 569

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



563
564
565
# File 'lib/oci/identity_domains/models/cloud_gate_server.rb', line 563

def to_s
  to_hash.to_s
end