CloudGate¶

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

Bases: object

Resource representing a Cloud Gate

Attributes

`IDCS_PREVENTED_OPERATIONS_DELETE`	A constant which can be used with the idcs_prevented_operations property of a CloudGate.
`IDCS_PREVENTED_OPERATIONS_REPLACE`	A constant which can be used with the idcs_prevented_operations property of a CloudGate.
`IDCS_PREVENTED_OPERATIONS_UPDATE`	A constant which can be used with the idcs_prevented_operations property of a CloudGate.
`TYPE_GATEWAY`	A constant which can be used with the type property of a CloudGate.
`TYPE_LBAAS`	A constant which can be used with the type property of a CloudGate.
`active`	Gets the active of this CloudGate.
`compartment_ocid`	Gets the compartment_ocid of this CloudGate.
`delete_in_progress`	Gets the delete_in_progress of this CloudGate.
`description`	Gets the description of this CloudGate.
`display_name`	[Required] Gets the display_name of this CloudGate.
`domain_ocid`	Gets the domain_ocid of this CloudGate.
`id`	Gets the id of this CloudGate.
`idcs_created_by`	Gets the idcs_created_by of this CloudGate.
`idcs_last_modified_by`	Gets the idcs_last_modified_by of this CloudGate.
`idcs_last_upgraded_in_release`	Gets the idcs_last_upgraded_in_release of this CloudGate.
`idcs_prevented_operations`	Gets the idcs_prevented_operations of this CloudGate.
`is_opc_service`	Gets the is_opc_service of this CloudGate.
`last_modified_time`	Gets the last_modified_time of this CloudGate.
`mappings`	Gets the mappings of this CloudGate.
`meta`	Gets the meta of this CloudGate.
`oauth_client`	Gets the oauth_client of this CloudGate.
`ocid`	Gets the ocid of this CloudGate.
`schemas`	[Required] Gets the schemas of this CloudGate.
`servers`	Gets the servers of this CloudGate.
`tags`	Gets the tags of this CloudGate.
`tenancy_ocid`	Gets the tenancy_ocid of this CloudGate.
`type`	Gets the type of this CloudGate.
`upstream_server_groups`	Gets the upstream_server_groups of this CloudGate.
`upstream_servers`	Gets the upstream_servers of this CloudGate.

Methods

__init__(**kwargs) Initializes a new CloudGate 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 CloudGate. 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 CloudGate. 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 CloudGate. This constant has a value of “update”

TYPE_GATEWAY = 'gateway'¶: A constant which can be used with the type property of a CloudGate. This constant has a value of “gateway”

TYPE_LBAAS = 'lbaas'¶: A constant which can be used with the type property of a CloudGate. This constant has a value of “lbaas”

__init__(**kwargs)¶

Initializes a new CloudGate 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 CloudGate.
ocid (str) – The value to assign to the ocid property of this CloudGate.
schemas (list[str]) – The value to assign to the schemas property of this CloudGate.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this CloudGate.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this CloudGate.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this CloudGate.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this CloudGate. 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 CloudGate.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this CloudGate.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this CloudGate.
domain_ocid (str) – The value to assign to the domain_ocid property of this CloudGate.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this CloudGate.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this CloudGate.
is_opc_service (bool) – The value to assign to the is_opc_service property of this CloudGate.
last_modified_time (str) – The value to assign to the last_modified_time property of this CloudGate.
display_name (str) – The value to assign to the display_name property of this CloudGate.
description (str) – The value to assign to the description property of this CloudGate.
active (bool) – The value to assign to the active property of this CloudGate.
type (str) – The value to assign to the type property of this CloudGate. Allowed values for this property are: “lbaas”, “gateway”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
upstream_server_groups (list[oci.identity_domains.models.CloudGateExtUpstreamServerGroups]) – The value to assign to the upstream_server_groups property of this CloudGate.
upstream_servers (list[oci.identity_domains.models.CloudGateExtUpstreamServers]) – The value to assign to the upstream_servers property of this CloudGate.
oauth_client (oci.identity_domains.models.CloudGateOauthClient) – The value to assign to the oauth_client property of this CloudGate.
servers (list[oci.identity_domains.models.CloudGateExtServers]) – The value to assign to the servers property of this CloudGate.
mappings (list[oci.identity_domains.models.CloudGateExtMappings]) – The value to assign to the mappings property of this CloudGate.

active¶

Gets the active of this CloudGate. Activation status for this Cloud Gate

Added In: 19.2.1

SCIM++ Properties:

caseExact: true
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: boolean
uniqueness: none

Returns:	The active of this CloudGate.
Return type:	bool

compartment_ocid¶

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

delete_in_progress¶

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

description¶

Gets the description of this CloudGate. Brief description for this Cloud Gate

Added In: 19.2.1

SCIM++ Properties:

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

Returns:	The description of this CloudGate.
Return type:	str

display_name¶

[Required] Gets the display_name of this CloudGate. Display name/Host identifier for this Cloud Gate

Added In: 19.2.1

SCIM++ Properties:

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

Returns:	The display_name of this CloudGate.
Return type:	str

domain_ocid¶

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

id¶

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

idcs_created_by¶

Gets the idcs_created_by of this CloudGate.

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

idcs_last_modified_by¶

Gets the idcs_last_modified_by of this CloudGate.

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

idcs_last_upgraded_in_release¶

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

idcs_prevented_operations¶

Gets the idcs_prevented_operations of this CloudGate. 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 CloudGate.
Return type:	list[str]

is_opc_service¶

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

last_modified_time¶

Gets the last_modified_time of this CloudGate. Last updated timestamp for this CloudGate’s servers and mappings.

Added In: 19.2.1

SCIM++ Properties:

caseExact: false
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: dateTime
uniqueness: none

Returns:	The last_modified_time of this CloudGate.
Return type:	str

mappings¶

Gets the mappings of this CloudGate. A list of Cloud Gate Mappings that map Apps to this Cloud Gate

SCIM++ Properties:

caseExact: true
idcsCompositeKey: [serverId, resourcePrefix]
idcsSearchable: true
multiValued: true
mutability: readOnly
required: false
returned: request
type: complex
uniqueness: none

Returns:	The mappings of this CloudGate.
Return type:	list[oci.identity_domains.models.CloudGateExtMappings]

meta¶

Gets the meta of this CloudGate.

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

oauth_client¶

Gets the oauth_client of this CloudGate.

Returns:	The oauth_client of this CloudGate.
Return type:	oci.identity_domains.models.CloudGateOauthClient

ocid¶

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

schemas¶

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

servers¶

Gets the servers of this CloudGate. A list of Server Blocks on this Cloud Gate

SCIM++ Properties:

caseExact: true
idcsCompositeKey: [hostName]
idcsSearchable: true
multiValued: true
mutability: readOnly
required: false
returned: request
type: complex
uniqueness: none

Returns:	The servers of this CloudGate.
Return type:	list[oci.identity_domains.models.CloudGateExtServers]

tags¶

Gets the tags of this CloudGate. 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 CloudGate.
Return type:	list[oci.identity_domains.models.Tags]

tenancy_ocid¶

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

type¶

Gets the type of this CloudGate. Type of Cloud Gate

SCIM++ Properties:

caseExact: false
idcsSearchable: false
multiValued: false
mutability: immutable
required: false
returned: default
type: string
uniqueness: none

Allowed values for this property are: “lbaas”, “gateway”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this CloudGate.
Return type:	str

upstream_server_groups¶

Gets the upstream_server_groups of this CloudGate. A list of upstream server groups

Added In: 20.1.3

SCIM++ Properties:

caseExact: false
idcsCompositeKey: [value]
idcsSearchable: true
multiValued: true
mutability: readOnly
required: false
returned: request
type: complex
uniqueness: none

Returns:	The upstream_server_groups of this CloudGate.
Return type:	list[oci.identity_domains.models.CloudGateExtUpstreamServerGroups]

upstream_servers¶

Gets the upstream_servers of this CloudGate. A list of upstream servers

Added In: 20.1.3

SCIM++ Properties:

caseExact: false
idcsCompositeKey: [value]
idcsSearchable: true
multiValued: true
mutability: readOnly
required: false
returned: request
type: complex
uniqueness: none

Returns:	The upstream_servers of this CloudGate.
Return type:	list[oci.identity_domains.models.CloudGateExtUpstreamServers]