GenerativeAiPrivateEndpoint¶

class oci.generative_ai.models.GenerativeAiPrivateEndpoint(**kwargs)¶

Bases: object

Generative AI private endpoint.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a GenerativeAiPrivateEndpoint.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a GenerativeAiPrivateEndpoint.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a GenerativeAiPrivateEndpoint.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a GenerativeAiPrivateEndpoint.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a GenerativeAiPrivateEndpoint.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a GenerativeAiPrivateEndpoint.
`RESOURCE_TYPE_APPLICATION`	A constant which can be used with the resource_type property of a GenerativeAiPrivateEndpoint.
`RESOURCE_TYPE_ENDPOINT`	A constant which can be used with the resource_type property of a GenerativeAiPrivateEndpoint.
`compartment_id`	[Required] Gets the compartment_id of this GenerativeAiPrivateEndpoint.
`defined_tags`	Gets the defined_tags of this GenerativeAiPrivateEndpoint.
`description`	Gets the description of this GenerativeAiPrivateEndpoint.
`display_name`	Gets the display_name of this GenerativeAiPrivateEndpoint.
`fqdn`	[Required] Gets the fqdn of this GenerativeAiPrivateEndpoint.
`freeform_tags`	Gets the freeform_tags of this GenerativeAiPrivateEndpoint.
`id`	[Required] Gets the id of this GenerativeAiPrivateEndpoint.
`is_allow_on_demand`	Gets the is_allow_on_demand of this GenerativeAiPrivateEndpoint.
`lifecycle_details`	Gets the lifecycle_details of this GenerativeAiPrivateEndpoint.
`lifecycle_state`	[Required] Gets the lifecycle_state of this GenerativeAiPrivateEndpoint.
`nsg_ids`	Gets the nsg_ids of this GenerativeAiPrivateEndpoint.
`previous_state`	Gets the previous_state of this GenerativeAiPrivateEndpoint.
`private_endpoint_ip`	Gets the private_endpoint_ip of this GenerativeAiPrivateEndpoint.
`resource_type`	Gets the resource_type of this GenerativeAiPrivateEndpoint.
`security_attributes`	Gets the security_attributes of this GenerativeAiPrivateEndpoint.
`subnet_id`	[Required] Gets the subnet_id of this GenerativeAiPrivateEndpoint.
`system_tags`	Gets the system_tags of this GenerativeAiPrivateEndpoint.
`time_created`	[Required] Gets the time_created of this GenerativeAiPrivateEndpoint.
`time_updated`	[Required] Gets the time_updated of this GenerativeAiPrivateEndpoint.

Methods:

__init__(**kwargs)

Initializes a new GenerativeAiPrivateEndpoint object with values from keyword arguments.

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

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

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

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

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

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

RESOURCE_TYPE_APPLICATION = 'APPLICATION'¶: A constant which can be used with the resource_type property of a GenerativeAiPrivateEndpoint. This constant has a value of “APPLICATION”

RESOURCE_TYPE_ENDPOINT = 'ENDPOINT'¶: A constant which can be used with the resource_type property of a GenerativeAiPrivateEndpoint. This constant has a value of “ENDPOINT”

__init__(**kwargs)¶

Initializes a new GenerativeAiPrivateEndpoint 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 GenerativeAiPrivateEndpoint.
display_name (str) – The value to assign to the display_name property of this GenerativeAiPrivateEndpoint.
description (str) – The value to assign to the description property of this GenerativeAiPrivateEndpoint.
compartment_id (str) – The value to assign to the compartment_id property of this GenerativeAiPrivateEndpoint.
subnet_id (str) – The value to assign to the subnet_id property of this GenerativeAiPrivateEndpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this GenerativeAiPrivateEndpoint. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this GenerativeAiPrivateEndpoint.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this GenerativeAiPrivateEndpoint.
fqdn (str) – The value to assign to the fqdn property of this GenerativeAiPrivateEndpoint.
is_allow_on_demand (bool) – The value to assign to the is_allow_on_demand property of this GenerativeAiPrivateEndpoint.
private_endpoint_ip (str) – The value to assign to the private_endpoint_ip property of this GenerativeAiPrivateEndpoint.
time_created (datetime) – The value to assign to the time_created property of this GenerativeAiPrivateEndpoint.
time_updated (datetime) – The value to assign to the time_updated property of this GenerativeAiPrivateEndpoint.
previous_state (oci.generative_ai.models.GenerativeAiPrivateEndpoint) – The value to assign to the previous_state property of this GenerativeAiPrivateEndpoint.
resource_type (str) – The value to assign to the resource_type property of this GenerativeAiPrivateEndpoint. Allowed values for this property are: “APPLICATION”, “ENDPOINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this GenerativeAiPrivateEndpoint.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this GenerativeAiPrivateEndpoint.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this GenerativeAiPrivateEndpoint.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this GenerativeAiPrivateEndpoint.

property compartment_id¶

[Required] Gets the compartment_id of this GenerativeAiPrivateEndpoint. The OCID of the compartment that contains the private endpoint.

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

property defined_tags¶

Gets the defined_tags of this GenerativeAiPrivateEndpoint. 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: The defined_tags of this GenerativeAiPrivateEndpoint.
Return type: dict(str, dict(str, object))

property description¶

Gets the description of this GenerativeAiPrivateEndpoint. A description of this private endpoint.

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

property display_name¶

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

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

property fqdn¶

[Required] Gets the fqdn of this GenerativeAiPrivateEndpoint. Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)

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

property freeform_tags¶

Gets the freeform_tags of this GenerativeAiPrivateEndpoint. 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: The freeform_tags of this GenerativeAiPrivateEndpoint.
Return type: dict(str, str)

property id¶

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

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

property is_allow_on_demand¶

Gets the is_allow_on_demand of this GenerativeAiPrivateEndpoint. Flag that allows access to on-demand models using this private endpoint.

Returns: The is_allow_on_demand of this GenerativeAiPrivateEndpoint.
Return type: bool

property lifecycle_details¶

Gets the lifecycle_details of this GenerativeAiPrivateEndpoint. The detailed messages about the lifecycle state

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this GenerativeAiPrivateEndpoint. The current state of the Generative AI Private Endpoint.

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

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

property nsg_ids¶

Gets the nsg_ids of this GenerativeAiPrivateEndpoint. A list of the OCIDs of the network security groups that the private endpoint’s VNIC belongs to.

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

property previous_state¶

Gets the previous_state of this GenerativeAiPrivateEndpoint.

Returns: The previous_state of this GenerativeAiPrivateEndpoint.
Return type: oci.generative_ai.models.GenerativeAiPrivateEndpoint

property private_endpoint_ip¶

Gets the private_endpoint_ip of this GenerativeAiPrivateEndpoint. The private IP address (in the customer’s VCN) that represents the access point for the associated endpoint service.

Returns: The private_endpoint_ip of this GenerativeAiPrivateEndpoint.
Return type: str

property resource_type¶

Gets the resource_type of this GenerativeAiPrivateEndpoint. The resource type that Generative AI private endpoint can be used for.

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

Returns: The resource_type of this GenerativeAiPrivateEndpoint.
Return type: str

property security_attributes¶

Gets the security_attributes of this GenerativeAiPrivateEndpoint. Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}

Returns: The security_attributes of this GenerativeAiPrivateEndpoint.
Return type: dict(str, dict(str, object))

property subnet_id¶

[Required] Gets the subnet_id of this GenerativeAiPrivateEndpoint. The OCID of the subnet that the private endpoint belongs to.

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

property system_tags¶

Gets the system_tags of this GenerativeAiPrivateEndpoint. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

property time_created¶

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

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

property time_updated¶

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

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