AiModelConnection¶
- class oci.golden_gate.models.AiModelConnection(**kwargs)¶
Bases:
ConnectionRepresents the metadata of an AI Model Connection.
Attributes:
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the connection_type property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the lifecycle_state property of a Connection.
A constant which can be used with the provider_type property of a AiModelConnection.
A constant which can be used with the provider_type property of a AiModelConnection.
A constant which can be used with the provider_type property of a AiModelConnection.
A constant which can be used with the provider_type property of a AiModelConnection.
A constant which can be used with the routing_method property of a Connection.
A constant which can be used with the routing_method property of a Connection.
A constant which can be used with the routing_method property of a Connection.
A constant which can be used with the technology_type property of a AiModelConnection.
Gets the auth_details of this AiModelConnection.
Gets the cluster_placement_group_id of this Connection.
[Required] Gets the compartment_id of this Connection.
[Required] Gets the connection_type of this Connection.
Gets the defined_tags of this Connection.
Gets the description of this Connection.
[Required] Gets the display_name of this Connection.
Gets the does_use_secret_ids of this Connection.
Gets the freeform_tags of this Connection.
[Required] Gets the id of this Connection.
Gets the ingress_ips of this Connection.
Gets the key_id of this Connection.
Gets the lifecycle_details of this Connection.
[Required] Gets the lifecycle_state of this Connection.
Gets the locks of this Connection.
Gets the max_input_chars of this AiModelConnection.
[Required] Gets the model_key of this AiModelConnection.
Gets the nsg_ids of this Connection.
Gets the provider_id of this AiModelConnection.
Gets the provider_type of this AiModelConnection.
Gets the routing_method of this Connection.
Gets the security_attributes of this Connection.
Gets the subnet_id of this Connection.
Gets the subscription_id of this Connection.
Gets the system_tags of this Connection.
[Required] Gets the technology_type of this AiModelConnection.
[Required] Gets the time_created of this Connection.
[Required] Gets the time_updated of this Connection.
Gets the vault_id of this Connection.
Methods:
__init__(**kwargs)Initializes a new AiModelConnection object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- CONNECTION_TYPE_AI_MODEL = 'AI_MODEL'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “AI_MODEL”
- CONNECTION_TYPE_AI_PROVIDER = 'AI_PROVIDER'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “AI_PROVIDER”
- CONNECTION_TYPE_AMAZON_KINESIS = 'AMAZON_KINESIS'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “AMAZON_KINESIS”
- CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “AMAZON_REDSHIFT”
- CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “AMAZON_S3”
- CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “AZURE_DATA_LAKE_STORAGE”
- CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “AZURE_SYNAPSE_ANALYTICS”
- CONNECTION_TYPE_DATABRICKS = 'DATABRICKS'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “DATABRICKS”
- CONNECTION_TYPE_DATABRICKS_ENGINE = 'DATABRICKS_ENGINE'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “DATABRICKS_ENGINE”
- CONNECTION_TYPE_DB2 = 'DB2'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “DB2”
- CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “ELASTICSEARCH”
- CONNECTION_TYPE_GENERIC = 'GENERIC'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “GENERIC”
- CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “GOLDENGATE”
- CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “GOOGLE_BIGQUERY”
- CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “GOOGLE_CLOUD_STORAGE”
- CONNECTION_TYPE_GOOGLE_PUBSUB = 'GOOGLE_PUBSUB'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “GOOGLE_PUBSUB”
- CONNECTION_TYPE_HDFS = 'HDFS'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “HDFS”
- CONNECTION_TYPE_ICEBERG = 'ICEBERG'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “ICEBERG”
- CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “JAVA_MESSAGE_SERVICE”
- CONNECTION_TYPE_KAFKA = 'KAFKA'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “KAFKA”
- CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “KAFKA_SCHEMA_REGISTRY”
- CONNECTION_TYPE_MICROSOFT_FABRIC = 'MICROSOFT_FABRIC'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “MICROSOFT_FABRIC”
- CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “MICROSOFT_SQLSERVER”
- CONNECTION_TYPE_MONGODB = 'MONGODB'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “MONGODB”
- CONNECTION_TYPE_MYSQL = 'MYSQL'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “MYSQL”
- CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “OCI_OBJECT_STORAGE”
- CONNECTION_TYPE_ORACLE = 'ORACLE'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “ORACLE”
- CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM = 'ORACLE_AI_DATA_PLATFORM'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “ORACLE_AI_DATA_PLATFORM”
- CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM_ENGINE = 'ORACLE_AI_DATA_PLATFORM_ENGINE'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “ORACLE_AI_DATA_PLATFORM_ENGINE”
- CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “ORACLE_NOSQL”
- CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “POSTGRESQL”
- CONNECTION_TYPE_REDIS = 'REDIS'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “REDIS”
- CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “SNOWFLAKE”
- CONNECTION_TYPE_SPARK = 'SPARK'¶
A constant which can be used with the connection_type property of a Connection. This constant has a value of “SPARK”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Connection. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Connection. 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 Connection. 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 Connection. This constant has a value of “UPDATING”
- PROVIDER_TYPE_GEMINI = 'GEMINI'¶
A constant which can be used with the provider_type property of a AiModelConnection. This constant has a value of “GEMINI”
- PROVIDER_TYPE_OCI_GENERATIVE_AI = 'OCI_GENERATIVE_AI'¶
A constant which can be used with the provider_type property of a AiModelConnection. This constant has a value of “OCI_GENERATIVE_AI”
- PROVIDER_TYPE_OPEN_AI = 'OPEN_AI'¶
A constant which can be used with the provider_type property of a AiModelConnection. This constant has a value of “OPEN_AI”
- PROVIDER_TYPE_VOYAGE_AI = 'VOYAGE_AI'¶
A constant which can be used with the provider_type property of a AiModelConnection. This constant has a value of “VOYAGE_AI”
- ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'¶
A constant which can be used with the routing_method property of a Connection. This constant has a value of “DEDICATED_ENDPOINT”
- ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'¶
A constant which can be used with the routing_method property of a Connection. This constant has a value of “SHARED_DEPLOYMENT_ENDPOINT”
- ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'¶
A constant which can be used with the routing_method property of a Connection. This constant has a value of “SHARED_SERVICE_ENDPOINT”
- TECHNOLOGY_TYPE_AI_MODEL = 'AI_MODEL'¶
A constant which can be used with the technology_type property of a AiModelConnection. This constant has a value of “AI_MODEL”
- __init__(**kwargs)¶
Initializes a new AiModelConnection object with values from keyword arguments. The default value of the
connection_typeattribute of this class isAI_MODELand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
connection_type (str) – The value to assign to the connection_type property of this AiModelConnection. Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_AI_DATA_PLATFORM”, “ORACLE_AI_DATA_PLATFORM_ENGINE”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, “DATABRICKS”, “DATABRICKS_ENGINE”, “GOOGLE_PUBSUB”, “MICROSOFT_FABRIC”, “SPARK”, “ICEBERG”, “AI_PROVIDER”, “AI_MODEL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
id (str) – The value to assign to the id property of this AiModelConnection.
display_name (str) – The value to assign to the display_name property of this AiModelConnection.
description (str) – The value to assign to the description property of this AiModelConnection.
compartment_id (str) – The value to assign to the compartment_id property of this AiModelConnection.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AiModelConnection.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AiModelConnection.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AiModelConnection.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AiModelConnection. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘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 AiModelConnection.
time_created (datetime) – The value to assign to the time_created property of this AiModelConnection.
time_updated (datetime) – The value to assign to the time_updated property of this AiModelConnection.
locks (list[oci.golden_gate.models.ResourceLock]) – The value to assign to the locks property of this AiModelConnection.
vault_id (str) – The value to assign to the vault_id property of this AiModelConnection.
key_id (str) – The value to assign to the key_id property of this AiModelConnection.
ingress_ips (list[oci.golden_gate.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this AiModelConnection.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this AiModelConnection.
subnet_id (str) – The value to assign to the subnet_id property of this AiModelConnection.
routing_method (str) – The value to assign to the routing_method property of this AiModelConnection. Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
does_use_secret_ids (bool) – The value to assign to the does_use_secret_ids property of this AiModelConnection.
subscription_id (str) – The value to assign to the subscription_id property of this AiModelConnection.
cluster_placement_group_id (str) – The value to assign to the cluster_placement_group_id property of this AiModelConnection.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this AiModelConnection.
technology_type (str) – The value to assign to the technology_type property of this AiModelConnection. Allowed values for this property are: “AI_MODEL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
provider_type (str) – The value to assign to the provider_type property of this AiModelConnection. Allowed values for this property are: “OCI_GENERATIVE_AI”, “GEMINI”, “OPEN_AI”, “VOYAGE_AI”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
provider_id (str) – The value to assign to the provider_id property of this AiModelConnection.
model_key (str) – The value to assign to the model_key property of this AiModelConnection.
max_input_chars (int) – The value to assign to the max_input_chars property of this AiModelConnection.
auth_details (oci.golden_gate.models.AiModelAuthDetails) – The value to assign to the auth_details property of this AiModelConnection.
- property auth_details¶
Gets the auth_details of this AiModelConnection.
- Returns
The auth_details of this AiModelConnection.
- Return type
- property cluster_placement_group_id¶
Gets the cluster_placement_group_id of this Connection. The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.
- Returns
The cluster_placement_group_id of this Connection.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this Connection. The OCID of the compartment being referenced.
- Returns
The compartment_id of this Connection.
- Return type
str
- property connection_type¶
[Required] Gets the connection_type of this Connection. The connection type.
Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_AI_DATA_PLATFORM”, “ORACLE_AI_DATA_PLATFORM_ENGINE”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, “DATABRICKS”, “DATABRICKS_ENGINE”, “GOOGLE_PUBSUB”, “MICROSOFT_FABRIC”, “SPARK”, “ICEBERG”, “AI_PROVIDER”, “AI_MODEL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The connection_type of this Connection.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this Connection. Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this Connection.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this Connection. Metadata about this specific object.
- Returns
The description of this Connection.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this Connection. An object’s Display Name.
- Returns
The display_name of this Connection.
- Return type
str
- property does_use_secret_ids¶
Gets the does_use_secret_ids of this Connection. Indicates that sensitive attributes are provided via Secrets.
Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
When set to true, all sensitive information must be provided as OCI Vault secrets using the corresponding *SecretId attributes of the connection (for example, passwordSecretId). Plain-text sensitive attributes (for example, password) must not be used. This ensures that sensitive information remains stored and managed in the customer’s OCI Vault rather than by the GoldenGate service.
When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. If vaultId and keyId are not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.
If vaultId and keyId are provided, the specified customer-managed key is used.
- Returns
The does_use_secret_ids of this Connection.
- Return type
bool
- property freeform_tags¶
Gets the freeform_tags of this Connection. A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this Connection.
- Return type
dict(str, str)
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property id¶
[Required] Gets the id of this Connection. The OCID of the connection being referenced.
- Returns
The id of this Connection.
- Return type
str
- property ingress_ips¶
Gets the ingress_ips of this Connection. List of ingress IP addresses from where the GoldenGate deployment connects to this connection’s privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
- Returns
The ingress_ips of this Connection.
- Return type
- property key_id¶
Gets the key_id of this Connection. References the OCI Vault key in the OCI Vault identified by vaultId.
Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
The GoldenGate service uses this key to encrypt sensitive information (for example, password) that is provided in plain-text connection attributes through the API. This field is applicable only when doesUseSecretIds is set to false. If both vaultId and keyId are provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neither vaultId nor keyId is provided, the GoldenGate service uses Oracle-managed encryption keys.
- Returns
The key_id of this Connection.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this Connection. Describes the object’s current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
- Returns
The lifecycle_details of this Connection.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this Connection. Possible lifecycle states for connection.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 Connection.
- Return type
str
- property locks¶
Gets the locks of this Connection. Locks associated with this resource.
- Returns
The locks of this Connection.
- Return type
- property max_input_chars¶
Gets the max_input_chars of this AiModelConnection. Maximum number of input characters supported by this AI model connection.
- Returns
The max_input_chars of this AiModelConnection.
- Return type
int
- property model_key¶
[Required] Gets the model_key of this AiModelConnection. AI model identifier.
- Returns
The model_key of this AiModelConnection.
- Return type
str
- property nsg_ids¶
Gets the nsg_ids of this Connection. An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
- Returns
The nsg_ids of this Connection.
- Return type
list[str]
- property provider_id¶
Gets the provider_id of this AiModelConnection. Optional identifier of the AI Provider Connection backing this AI Model Connection. When provided, it must reference an existing Active connection of type AI_PROVIDER. When providerId is set, providerType and authDetails must not be provided on the AI Model Connection, because provider metadata is resolved from the referenced AI Provider Connection. When providerId is not set, the AI Model Connection must provide inline provider metadata using providerType and authDetails.
- Returns
The provider_id of this AiModelConnection.
- Return type
str
- property provider_type¶
Gets the provider_type of this AiModelConnection. AI Provider type used by the AI Model Connection.
Allowed values for this property are: “OCI_GENERATIVE_AI”, “GEMINI”, “OPEN_AI”, “VOYAGE_AI”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The provider_type of this AiModelConnection.
- Return type
str
- property routing_method¶
Gets the routing_method of this Connection. Controls the network traffic direction to the target: SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment’s private endpoint through the deployment’s subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The routing_method of this Connection.
- Return type
str
- property security_attributes¶
Gets the security_attributes of this Connection. 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 Connection.
- Return type
dict(str, dict(str, object))
- property subnet_id¶
Gets the subnet_id of this Connection. The OCID of the target subnet of the dedicated connection.
- Returns
The subnet_id of this Connection.
- Return type
str
- property subscription_id¶
Gets the subscription_id of this Connection. The OCID of the subscription with which resource needs to be associated with.
- Returns
The subscription_id of this Connection.
- Return type
str
- property system_tags¶
Gets the system_tags of this Connection. The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.
Example: {orcl-cloud: {free-tier-retain: true}}
- Returns
The system_tags of this Connection.
- Return type
dict(str, dict(str, object))
- property technology_type¶
[Required] Gets the technology_type of this AiModelConnection. The AI Model technology type.
Allowed values for this property are: “AI_MODEL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The technology_type of this AiModelConnection.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this Connection. The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- Returns
The time_created of this Connection.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this Connection. The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- Returns
The time_updated of this Connection.
- Return type
datetime
- property vault_id¶
Gets the vault_id of this Connection. References the OCI Vault that contains the customer-managed encryption key identified by keyId.
Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
This field is applicable only when doesUseSecretIds is set to false. If vaultId is provided, keyId must also be provided.
- Returns
The vault_id of this Connection.
- Return type
str