CloudGateServer¶

class oci.identity_domains.models.CloudGateServer(**kwargs)¶

Bases: object

Resource representing a Cloud Gate server block

Attributes

`IDCS_PREVENTED_OPERATIONS_DELETE`	A constant which can be used with the idcs_prevented_operations property of a CloudGateServer.
`IDCS_PREVENTED_OPERATIONS_REPLACE`	A constant which can be used with the idcs_prevented_operations property of a CloudGateServer.
`IDCS_PREVENTED_OPERATIONS_UPDATE`	A constant which can be used with the idcs_prevented_operations property of a CloudGateServer.
`cloud_gate`	[Required] Gets the cloud_gate of this CloudGateServer.
`compartment_ocid`	Gets the compartment_ocid of this CloudGateServer.
`delete_in_progress`	Gets the delete_in_progress of this CloudGateServer.
`description`	Gets the description of this CloudGateServer.
`display_name`	[Required] Gets the display_name of this CloudGateServer.
`domain_ocid`	Gets the domain_ocid of this CloudGateServer.
`host_name`	[Required] Gets the host_name of this CloudGateServer.
`id`	Gets the id of this CloudGateServer.
`idcs_created_by`	Gets the idcs_created_by of this CloudGateServer.
`idcs_last_modified_by`	Gets the idcs_last_modified_by of this CloudGateServer.
`idcs_last_upgraded_in_release`	Gets the idcs_last_upgraded_in_release of this CloudGateServer.
`idcs_prevented_operations`	Gets the idcs_prevented_operations of this CloudGateServer.
`is_opc_service`	Gets the is_opc_service of this CloudGateServer.
`meta`	Gets the meta of this CloudGateServer.
`nginx_settings`	Gets the nginx_settings of this CloudGateServer.
`ocid`	Gets the ocid of this CloudGateServer.
`port`	[Required] Gets the port of this CloudGateServer.
`schemas`	[Required] Gets the schemas of this CloudGateServer.
`ssl`	[Required] Gets the ssl of this CloudGateServer.
`tags`	Gets the tags of this CloudGateServer.
`tenancy_ocid`	Gets the tenancy_ocid of this CloudGateServer.

Methods

__init__(**kwargs) Initializes a new CloudGateServer object with values from keyword arguments.

IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'¶: A constant which can be used with the idcs_prevented_operations property of a CloudGateServer. This constant has a value of “delete”

IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'¶: A constant which can be used with the idcs_prevented_operations property of a CloudGateServer. This constant has a value of “replace”

IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'¶: A constant which can be used with the idcs_prevented_operations property of a CloudGateServer. This constant has a value of “update”

__init__(**kwargs)¶

Initializes a new CloudGateServer object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this CloudGateServer.
ocid (str) – The value to assign to the ocid property of this CloudGateServer.
schemas (list[str]) – The value to assign to the schemas property of this CloudGateServer.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this CloudGateServer.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this CloudGateServer.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this CloudGateServer.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this CloudGateServer. Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
tags (list[oci.identity_domains.models.Tags]) – The value to assign to the tags property of this CloudGateServer.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this CloudGateServer.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this CloudGateServer.
domain_ocid (str) – The value to assign to the domain_ocid property of this CloudGateServer.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this CloudGateServer.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this CloudGateServer.
is_opc_service (bool) – The value to assign to the is_opc_service property of this CloudGateServer.
description (str) – The value to assign to the description property of this CloudGateServer.
display_name (str) – The value to assign to the display_name property of this CloudGateServer.
host_name (str) – The value to assign to the host_name property of this CloudGateServer.
port (int) – The value to assign to the port property of this CloudGateServer.
ssl (bool) – The value to assign to the ssl property of this CloudGateServer.
nginx_settings (str) – The value to assign to the nginx_settings property of this CloudGateServer.
cloud_gate (oci.identity_domains.models.CloudGateServerCloudGate) – The value to assign to the cloud_gate property of this CloudGateServer.

cloud_gate¶

[Required] Gets the cloud_gate of this CloudGateServer.

Returns:	The cloud_gate of this CloudGateServer.
Return type:	oci.identity_domains.models.CloudGateServerCloudGate

compartment_ocid¶

Gets the compartment_ocid of this CloudGateServer. 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:	The compartment_ocid of this CloudGateServer.
Return type:	str

delete_in_progress¶

Gets the delete_in_progress of this CloudGateServer. 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:	The delete_in_progress of this CloudGateServer.
Return type:	bool

description¶

Gets the description of this CloudGateServer. 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:	The description of this CloudGateServer.
Return type:	str

display_name¶

[Required] Gets the display_name of this CloudGateServer. 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:	The display_name of this CloudGateServer.
Return type:	str

domain_ocid¶

Gets the domain_ocid of this CloudGateServer. 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:	The domain_ocid of this CloudGateServer.
Return type:	str

host_name¶

[Required] Gets the host_name of this CloudGateServer. Hostname for the Server block

SCIM++ Properties:

caseExact: true
idcsSearchable: true
multiValued: false
mutability: readWrite
required: true
returned: always
type: string
uniqueness: none

Returns:	The host_name of this CloudGateServer.
Return type:	str

id¶

Gets the id of this CloudGateServer. 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:	The id of this CloudGateServer.
Return type:	str

idcs_created_by¶

Gets the idcs_created_by of this CloudGateServer.

Returns:	The idcs_created_by of this CloudGateServer.
Return type:	oci.identity_domains.models.IdcsCreatedBy

idcs_last_modified_by¶

Gets the idcs_last_modified_by of this CloudGateServer.

Returns:	The idcs_last_modified_by of this CloudGateServer.
Return type:	oci.identity_domains.models.IdcsLastModifiedBy

idcs_last_upgraded_in_release¶

Gets the idcs_last_upgraded_in_release of this CloudGateServer. 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:	The idcs_last_upgraded_in_release of this CloudGateServer.
Return type:	str

idcs_prevented_operations¶

Gets the idcs_prevented_operations of this CloudGateServer. 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

Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The idcs_prevented_operations of this CloudGateServer.
Return type:	list[str]

is_opc_service¶

Gets the is_opc_service of this CloudGateServer. 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:	The is_opc_service of this CloudGateServer.
Return type:	bool

meta¶

Gets the meta of this CloudGateServer.

Returns:	The meta of this CloudGateServer.
Return type:	oci.identity_domains.models.Meta

nginx_settings¶

Gets the nginx_settings of this CloudGateServer. 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:	The nginx_settings of this CloudGateServer.
Return type:	str

ocid¶

Gets the ocid of this CloudGateServer. 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:	The ocid of this CloudGateServer.
Return type:	str

port¶

[Required] Gets the port of this CloudGateServer. 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:	The port of this CloudGateServer.
Return type:	int

schemas¶

[Required] Gets the schemas of this CloudGateServer. 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:	The schemas of this CloudGateServer.
Return type:	list[str]

ssl¶

[Required] Gets the ssl of this CloudGateServer. 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:	The ssl of this CloudGateServer.
Return type:	bool

tags¶

Gets the tags of this CloudGateServer. 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

Returns:	The tags of this CloudGateServer.
Return type:	list[oci.identity_domains.models.Tags]

tenancy_ocid¶

Gets the tenancy_ocid of this CloudGateServer. 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:	The tenancy_ocid of this CloudGateServer.
Return type:	str