Package com.oracle.bmc.containerinstances.model

Class Container

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210415")
public final class Container
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A single container on a container instance.

    If you delete a container, the record remains visible for a short period of time before being permanently removed.
    Note: Objects should always be created or deserialized using the Container.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Container.Builder, which maintain a set of all explicitly set fields called Container.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the container.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the container.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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 value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}.

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}.

        Returns:
        the value

      • getAvailabilityDomain

        public String getAvailabilityDomain()
        The availability domain where the container instance that hosts the container runs.
        Returns:
        the value

      • getFaultDomain

        public String getFaultDomain()
        The fault domain of the container instance that hosts the container runs.
        Returns:
        the value

      • getLifecycleState

        public Container.LifecycleState getLifecycleState()
        The current state of the container.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message that describes the current state of the container in more detail.

        Can be used to provide actionable information.

        Returns:
        the value

      • getExitCode

        public Integer getExitCode()
        The exit code of the container process when it stopped running.
        Returns:
        the value

      • getTimeTerminated

        public Date getTimeTerminated()
        The time when the container last deleted (terminated), in the format defined by RFC 3339.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the container was created, in the format defined by RFC 3339.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the container was updated, in the format defined by RFC 3339.
        Returns:
        the value

      • getContainerInstanceId

        public String getContainerInstanceId()
        The OCID of the container instance that the container is running on.
        Returns:
        the value

      • getImageUrl

        public String getImageUrl()
        The container image information.

        Currently only supports public Docker registry.

        You can provide either the image name (containerImage), image name with version (containerImagev1), or complete Docker image URL docker.io/library/containerImage:latest.

        If you do not provide a registry, the registry defaults to public Docker hub docker.io/library. The registry used for the container image must be reachable over the VNIC of the container instance.

        Returns:
        the value

      • getCommand

        public List<String> getCommand()
        This command overrides ENTRYPOINT process of the container.

        If you do not specify this command, the existing ENTRYPOINT process defined in the image is the default.

        Returns:
        the value

      • getArguments

        public List<String> getArguments()
        A list of string arguments for the ENTRYPOINT process of the container.

        Many containers use an ENTRYPOINT process pointing to a shell /bin/bash. For those containers, you can use the argument list to specify the main command in the container process.

        Returns:
        the value

      • getWorkingDirectory

        public String getWorkingDirectory()
        The working directory within the container’s filesystem for the container process.

        If not specified, the default working directory from the image is used.

        Returns:
        the value

      • getEnvironmentVariables

        public Map<String,​String> getEnvironmentVariables()
        A map of additional environment variables to set in the environment of the ENTRYPOINT process of the container.

        These variables are in addition to any variables already defined in the container’s image.

        Returns:
        the value

      • getVolumeMounts

        public List<VolumeMount> getVolumeMounts()
        List of the volume mounts.
        Returns:
        the value

      • getHealthChecks

        public List<ContainerHealthCheck> getHealthChecks()
        List of container health checks
        Returns:
        the value

      • getIsResourcePrincipalDisabled

        public Boolean getIsResourcePrincipalDisabled()
        Determines if the container will have access to the container instance resource principal.

        This method utilizes resource principal version 2.2. For more information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.

        Returns:
        the value

      • getContainerRestartAttemptCount

        public Integer getContainerRestartAttemptCount()
        The number of container restart attempts.

        Depending on the restart policy, a restart might be attempted after a health check failure or a container exit.

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel