Package com.oracle.bmc.containerinstances.model

Class ContainerSummary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210415")
public final class ContainerSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Summary information about a container.
    Note: Objects should always be created or deserialized using the ContainerSummary.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 ContainerSummary.Builder, which maintain a set of all explicitly set fields called ContainerSummary.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 compartment OCID.
        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 this container runs.
        Returns:
        the value

      • getFaultDomain

        public String getFaultDomain()
        The fault domain where 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

      • getTimeCreated

        public Date getTimeCreated()
        The time the 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 on which the container is running.
        Returns:
        the value

      • getImageUrl

        public String getImageUrl()
        A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest.

        If you do not provide a tag, the tag will default to latest.

        If no registry is provided, will default the registry to public docker hub docker.io/library. The registry used for container image must be reachable over the Container Instance's VNIC.

        Returns:
        the value

      • getIsResourcePrincipalDisabled

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

        This method utilizes resource principal version 2.2. For 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

      • 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