OcirModelDeploymentEnvironmentConfigurationDetails¶

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

Bases: oci.data_science.models.model_deployment_environment_configuration_details.ModelDeploymentEnvironmentConfigurationDetails

The environment configuration details object for OCI Registry

Attributes

`ENVIRONMENT_CONFIGURATION_TYPE_DEFAULT`	str(object=’’) -> str
`ENVIRONMENT_CONFIGURATION_TYPE_OCIR_CONTAINER`	str(object=’’) -> str
`cmd`	Gets the cmd of this OcirModelDeploymentEnvironmentConfigurationDetails.
`entrypoint`	Gets the entrypoint of this OcirModelDeploymentEnvironmentConfigurationDetails.
`environment_configuration_type`	[Required] Gets the environment_configuration_type of this ModelDeploymentEnvironmentConfigurationDetails.
`environment_variables`	Gets the environment_variables of this OcirModelDeploymentEnvironmentConfigurationDetails.
`health_check_port`	Gets the health_check_port of this OcirModelDeploymentEnvironmentConfigurationDetails.
`image`	[Required] Gets the image of this OcirModelDeploymentEnvironmentConfigurationDetails.
`image_digest`	Gets the image_digest of this OcirModelDeploymentEnvironmentConfigurationDetails.
`server_port`	Gets the server_port of this OcirModelDeploymentEnvironmentConfigurationDetails.

Methods

`__init__`(**kwargs)	Initializes a new OcirModelDeploymentEnvironmentConfigurationDetails 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.

ENVIRONMENT_CONFIGURATION_TYPE_DEFAULT = 'DEFAULT'¶

ENVIRONMENT_CONFIGURATION_TYPE_OCIR_CONTAINER = 'OCIR_CONTAINER'¶

__init__(**kwargs)¶

Initializes a new OcirModelDeploymentEnvironmentConfigurationDetails object with values from keyword arguments. The default value of the environment_configuration_type attribute of this class is OCIR_CONTAINER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

environment_configuration_type (str) – The value to assign to the environment_configuration_type property of this OcirModelDeploymentEnvironmentConfigurationDetails. Allowed values for this property are: “DEFAULT”, “OCIR_CONTAINER”
image (str) – The value to assign to the image property of this OcirModelDeploymentEnvironmentConfigurationDetails.
image_digest (str) – The value to assign to the image_digest property of this OcirModelDeploymentEnvironmentConfigurationDetails.
cmd (list[str]) – The value to assign to the cmd property of this OcirModelDeploymentEnvironmentConfigurationDetails.
entrypoint (list[str]) – The value to assign to the entrypoint property of this OcirModelDeploymentEnvironmentConfigurationDetails.
server_port (int) – The value to assign to the server_port property of this OcirModelDeploymentEnvironmentConfigurationDetails.
health_check_port (int) – The value to assign to the health_check_port property of this OcirModelDeploymentEnvironmentConfigurationDetails.
environment_variables (dict(str, str)) – The value to assign to the environment_variables property of this OcirModelDeploymentEnvironmentConfigurationDetails.

cmd¶

Gets the cmd of this OcirModelDeploymentEnvironmentConfigurationDetails. The container image run CMD as a list of strings. Use CMD as arguments to the ENTRYPOINT or the only command to run in the absence of an ENTRYPOINT. The combined size of CMD and ENTRYPOINT must be less than 2048 bytes.

Returns:	The cmd of this OcirModelDeploymentEnvironmentConfigurationDetails.
Return type:	list[str]

entrypoint¶

Gets the entrypoint of this OcirModelDeploymentEnvironmentConfigurationDetails. The container image run ENTRYPOINT as a list of strings. Accept the CMD as extra arguments. The combined size of CMD and ENTRYPOINT must be less than 2048 bytes. More information on how CMD and ENTRYPOINT interact are here.

Returns:	The entrypoint of this OcirModelDeploymentEnvironmentConfigurationDetails.
Return type:	list[str]

environment_configuration_type¶

[Required] Gets the environment_configuration_type of this ModelDeploymentEnvironmentConfigurationDetails. The environment configuration type

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

Returns:	The environment_configuration_type of this ModelDeploymentEnvironmentConfigurationDetails.
Return type:	str

environment_variables¶

Gets the environment_variables of this OcirModelDeploymentEnvironmentConfigurationDetails. Environment variables to set for the web server container. The size of envVars must be less than 2048 bytes. Key should be under 32 characters. Key should contain only letters, digits and underscore (_) Key should start with a letter. Key should have at least 2 characters. Key should not end with underscore eg. TEST_ Key if added cannot be empty. Value can be empty. No specific size limits on individual Values. But overall environment variables is limited to 2048 bytes. Key can’t be reserved Model Deployment environment variables.

Returns:	The environment_variables of this OcirModelDeploymentEnvironmentConfigurationDetails.
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.

health_check_port¶

Gets the health_check_port of this OcirModelDeploymentEnvironmentConfigurationDetails. The port on which the container HEALTHCHECK would listen. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.

Returns:	The health_check_port of this OcirModelDeploymentEnvironmentConfigurationDetails.
Return type:	int

image¶

[Required] Gets the image of this OcirModelDeploymentEnvironmentConfigurationDetails. The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format. Acceptable format: <region>.ocir.io/<registry>/<image>:<tag> <region>.ocir.io/<registry>/<image>:<tag>@digest

Returns:	The image of this OcirModelDeploymentEnvironmentConfigurationDetails.
Return type:	str

image_digest¶

Gets the image_digest of this OcirModelDeploymentEnvironmentConfigurationDetails. The digest of the container image. For example, sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030

Returns:	The image_digest of this OcirModelDeploymentEnvironmentConfigurationDetails.
Return type:	str

server_port¶

Gets the server_port of this OcirModelDeploymentEnvironmentConfigurationDetails. The port on which the web server serving the inference is running. The port can be anything between 1024 and 65535. The following ports cannot be used 24224, 8446, 8447.

Returns:	The server_port of this OcirModelDeploymentEnvironmentConfigurationDetails.
Return type:	int