DataSciencePrivateEndpoint¶

class oci.data_science.models.DataSciencePrivateEndpoint(**kwargs)¶

Bases: object

Data Science private endpoint.

Attributes:

`DATA_SCIENCE_RESOURCE_TYPE_MODEL_DEPLOYMENT`	A constant which can be used with the data_science_resource_type property of a DataSciencePrivateEndpoint.
`DATA_SCIENCE_RESOURCE_TYPE_NOTEBOOK_SESSION`	A constant which can be used with the data_science_resource_type property of a DataSciencePrivateEndpoint.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint.
`compartment_id`	[Required] Gets the compartment_id of this DataSciencePrivateEndpoint.
`created_by`	[Required] Gets the created_by of this DataSciencePrivateEndpoint.
`data_science_resource_type`	Gets the data_science_resource_type of this DataSciencePrivateEndpoint.
`defined_tags`	[Required] Gets the defined_tags of this DataSciencePrivateEndpoint.
`description`	Gets the description of this DataSciencePrivateEndpoint.
`display_name`	[Required] Gets the display_name of this DataSciencePrivateEndpoint.
`fqdn`	Gets the fqdn of this DataSciencePrivateEndpoint.
`freeform_tags`	[Required] Gets the freeform_tags of this DataSciencePrivateEndpoint.
`id`	[Required] Gets the id of this DataSciencePrivateEndpoint.
`lifecycle_details`	Gets the lifecycle_details of this DataSciencePrivateEndpoint.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DataSciencePrivateEndpoint.
`nsg_ids`	Gets the nsg_ids of this DataSciencePrivateEndpoint.
`subnet_id`	[Required] Gets the subnet_id of this DataSciencePrivateEndpoint.
`system_tags`	Gets the system_tags of this DataSciencePrivateEndpoint.
`time_created`	[Required] Gets the time_created of this DataSciencePrivateEndpoint.
`time_updated`	[Required] Gets the time_updated of this DataSciencePrivateEndpoint.

Methods:

__init__(**kwargs)

Initializes a new DataSciencePrivateEndpoint object with values from keyword arguments.

DATA_SCIENCE_RESOURCE_TYPE_MODEL_DEPLOYMENT = 'MODEL_DEPLOYMENT'¶: A constant which can be used with the data_science_resource_type property of a DataSciencePrivateEndpoint. This constant has a value of “MODEL_DEPLOYMENT”

DATA_SCIENCE_RESOURCE_TYPE_NOTEBOOK_SESSION = 'NOTEBOOK_SESSION'¶: A constant which can be used with the data_science_resource_type property of a DataSciencePrivateEndpoint. This constant has a value of “NOTEBOOK_SESSION”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DataSciencePrivateEndpoint. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters

compartment_id (str) – The value to assign to the compartment_id property of this DataSciencePrivateEndpoint.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DataSciencePrivateEndpoint.
description (str) – The value to assign to the description property of this DataSciencePrivateEndpoint.
display_name (str) – The value to assign to the display_name property of this DataSciencePrivateEndpoint.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DataSciencePrivateEndpoint.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DataSciencePrivateEndpoint.
id (str) – The value to assign to the id property of this DataSciencePrivateEndpoint.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DataSciencePrivateEndpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DataSciencePrivateEndpoint. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this DataSciencePrivateEndpoint.
created_by (str) – The value to assign to the created_by property of this DataSciencePrivateEndpoint.
subnet_id (str) – The value to assign to the subnet_id property of this DataSciencePrivateEndpoint.
fqdn (str) – The value to assign to the fqdn property of this DataSciencePrivateEndpoint.
data_science_resource_type (str) – The value to assign to the data_science_resource_type property of this DataSciencePrivateEndpoint. Allowed values for this property are: “NOTEBOOK_SESSION”, “MODEL_DEPLOYMENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this DataSciencePrivateEndpoint.
time_updated (datetime) – The value to assign to the time_updated property of this DataSciencePrivateEndpoint.

property compartment_id¶

[Required] Gets the compartment_id of this DataSciencePrivateEndpoint. The OCID of the compartment where you want to create private endpoint.

Returns: The compartment_id of this DataSciencePrivateEndpoint.
Return type: str

property created_by¶

[Required] Gets the created_by of this DataSciencePrivateEndpoint. The OCID of the user that created the private endpoint.

Returns: The created_by of this DataSciencePrivateEndpoint.
Return type: str

property data_science_resource_type¶

Gets the data_science_resource_type of this DataSciencePrivateEndpoint. Data Science resource type.

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

Returns: The data_science_resource_type of this DataSciencePrivateEndpoint.
Return type: str

property defined_tags¶

[Required] Gets the defined_tags of this DataSciencePrivateEndpoint. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns: The defined_tags of this DataSciencePrivateEndpoint.
Return type: dict(str, dict(str, object))

property description¶

Gets the description of this DataSciencePrivateEndpoint. A user friendly description. Avoid entering confidential information.

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

property display_name¶

[Required] Gets the display_name of this DataSciencePrivateEndpoint. A user friendly name. It doesn’t have to be unique. Avoid entering confidential information.

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

property fqdn¶

Gets the fqdn of this DataSciencePrivateEndpoint. Accesing the Data Science resource using FQDN.

Returns: The fqdn of this DataSciencePrivateEndpoint.
Return type: str

property freeform_tags¶

[Required] Gets the freeform_tags of this DataSciencePrivateEndpoint. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {“Department”: “Finance”}

Returns: The freeform_tags of this DataSciencePrivateEndpoint.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this DataSciencePrivateEndpoint. The OCID of a private endpoint.

Returns: The id of this DataSciencePrivateEndpoint.
Return type: str

property lifecycle_details¶

Gets the lifecycle_details of this DataSciencePrivateEndpoint. Details of the state of Data Science private endpoint.

Returns: The lifecycle_details of this DataSciencePrivateEndpoint.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this DataSciencePrivateEndpoint. State of the Data Science private endpoint.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this DataSciencePrivateEndpoint.
Return type: str

property nsg_ids¶

Gets the nsg_ids of this DataSciencePrivateEndpoint. An array of network security group OCIDs.

Returns: The nsg_ids of this DataSciencePrivateEndpoint.
Return type: list[str]

property subnet_id¶

[Required] Gets the subnet_id of this DataSciencePrivateEndpoint. The OCID of a subnet.

Returns: The subnet_id of this DataSciencePrivateEndpoint.
Return type: str

property system_tags¶

Gets the system_tags of this DataSciencePrivateEndpoint. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns: The system_tags of this DataSciencePrivateEndpoint.
Return type: dict(str, dict(str, object))

property time_created¶

[Required] Gets the time_created of this DataSciencePrivateEndpoint. The date and time that the Data Science private endpoint was created expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns: The time_created of this DataSciencePrivateEndpoint.
Return type: datetime

property time_updated¶

[Required] Gets the time_updated of this DataSciencePrivateEndpoint. The date and time that the Data Science private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns: The time_updated of this DataSciencePrivateEndpoint.
Return type: datetime