Package com.oracle.bmc.containerinstances.model

Class ContainerInstance

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210415")
public final class ContainerInstance
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A container instance to host containers.

    If you delete a container instance, the record remains visible for a short period of time before being permanently removed.
    Note: Objects should always be created or deserialized using the ContainerInstance.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 ContainerInstance.Builder, which maintain a set of all explicitly set fields called ContainerInstance.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()
        An OCID that cannot be changed.
        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.
        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 to place the container instance.
        Returns:
        the value

      • getFaultDomain

        public String getFaultDomain()
        The fault domain to place the container instance.
        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

      • getVolumes

        public List<ContainerVolume> getVolumes()
        A volume is a directory with data that is accessible across multiple containers in a container instance.
        Returns:
        the value

      • getVolumeCount

        public Integer getVolumeCount()
        The number of volumes that are attached to the container instance.
        Returns:
        the value

      • getContainerCount

        public Integer getContainerCount()
        The number of containers on the container instance.
        Returns:
        the value

      • getTimeCreated

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

      • getTimeUpdated

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

      • getShape

        public String getShape()
        The shape of the container instance.

        The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.

        Returns:
        the value

      • getVnics

        public List<ContainerVnic> getVnics()
        The virtual networks available to the containers in the container instance.
        Returns:
        the value

      • getGracefulShutdownTimeoutInSeconds

        public Long getGracefulShutdownTimeoutInSeconds()
        The amount of time that processes in a container have to gracefully end when the container must be stopped.

        For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.

        Returns:
        the value

      • getImagePullSecrets

        public List<ImagePullSecret> getImagePullSecrets()
        The image pulls secrets so you can access private registry to pull container images.
        Returns:
        the value

      • getContainerRestartPolicy

        public ContainerInstance.ContainerRestartPolicy getContainerRestartPolicy()
        The container restart policy is applied for all containers in container instance.
        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