CreateGenerativeAiPrivateEndpointDetails¶

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

Bases: object

The details required to create a Generative AI private endpoint.

Methods:

__init__(**kwargs)

Initializes a new CreateGenerativeAiPrivateEndpointDetails object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this CreateGenerativeAiPrivateEndpointDetails.
`defined_tags`	Gets the defined_tags of this CreateGenerativeAiPrivateEndpointDetails.
`description`	Gets the description of this CreateGenerativeAiPrivateEndpointDetails.
`display_name`	Gets the display_name of this CreateGenerativeAiPrivateEndpointDetails.
`dns_prefix`	[Required] Gets the dns_prefix of this CreateGenerativeAiPrivateEndpointDetails.
`freeform_tags`	Gets the freeform_tags of this CreateGenerativeAiPrivateEndpointDetails.
`is_allow_on_demand`	Gets the is_allow_on_demand of this CreateGenerativeAiPrivateEndpointDetails.
`nsg_ids`	Gets the nsg_ids of this CreateGenerativeAiPrivateEndpointDetails.
`resource_type`	Gets the resource_type of this CreateGenerativeAiPrivateEndpointDetails.
`security_attributes`	Gets the security_attributes of this CreateGenerativeAiPrivateEndpointDetails.
`subnet_id`	[Required] Gets the subnet_id of this CreateGenerativeAiPrivateEndpointDetails.

__init__(**kwargs)¶

Initializes a new CreateGenerativeAiPrivateEndpointDetails 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 CreateGenerativeAiPrivateEndpointDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateGenerativeAiPrivateEndpointDetails.
description (str) – The value to assign to the description property of this CreateGenerativeAiPrivateEndpointDetails.
display_name (str) – The value to assign to the display_name property of this CreateGenerativeAiPrivateEndpointDetails.
dns_prefix (str) – The value to assign to the dns_prefix property of this CreateGenerativeAiPrivateEndpointDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateGenerativeAiPrivateEndpointDetails.
is_allow_on_demand (bool) – The value to assign to the is_allow_on_demand property of this CreateGenerativeAiPrivateEndpointDetails.
resource_type (str) – The value to assign to the resource_type property of this CreateGenerativeAiPrivateEndpointDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateGenerativeAiPrivateEndpointDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateGenerativeAiPrivateEndpointDetails.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this CreateGenerativeAiPrivateEndpointDetails.

property compartment_id¶

[Required] Gets the compartment_id of this CreateGenerativeAiPrivateEndpointDetails. The OCID of the compartment where the private endpoint is created.

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

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

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

property dns_prefix¶

[Required] Gets the dns_prefix of this CreateGenerativeAiPrivateEndpointDetails. dnsPrefix of the private endpoint FQDN.

Returns: The dns_prefix of this CreateGenerativeAiPrivateEndpointDetails.
Return type: str

property freeform_tags¶

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

property is_allow_on_demand¶

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

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

property nsg_ids¶

Gets the nsg_ids of this CreateGenerativeAiPrivateEndpointDetails. A list of the OCIDs of the network security groups (NSGs) to add the private endpoint’s VNIC to.

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

property resource_type¶

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

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

property security_attributes¶

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

property subnet_id¶

[Required] Gets the subnet_id of this CreateGenerativeAiPrivateEndpointDetails. The OCID of the customer’s subnet where the private endpoint VNIC will reside.

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