@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Container.Builder |
static class |
Container.LifecycleState
The current state of the container.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Container(String id,
String displayName,
String compartmentId,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags,
String availabilityDomain,
String faultDomain,
Container.LifecycleState lifecycleState,
String lifecycleDetails,
Integer exitCode,
Date timeTerminated,
Date timeCreated,
Date timeUpdated,
String containerInstanceId,
String imageUrl,
List<String> command,
List<String> arguments,
String workingDirectory,
Map<String,String> environmentVariables,
List<VolumeMount> volumeMounts,
List<ContainerHealthCheck> healthChecks,
Boolean isResourcePrincipalDisabled,
ContainerResourceConfig resourceConfig,
Integer containerRestartAttemptCount,
SecurityContext securityContext)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Container.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
List<String> |
getArguments()
A list of string arguments for the ENTRYPOINT process of the container.
|
String |
getAvailabilityDomain()
The availability domain where the container instance that hosts the container runs.
|
List<String> |
getCommand()
This command overrides ENTRYPOINT process of the container.
|
String |
getCompartmentId()
The OCID of the compartment that contains the container.
|
String |
getContainerInstanceId()
The OCID of
the container instance that the container is running on.
|
Integer |
getContainerRestartAttemptCount()
The number of container restart attempts.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getEnvironmentVariables()
A map of additional environment variables to set in the environment of the ENTRYPOINT process
of the container.
|
Integer |
getExitCode()
The exit code of the container process when it stopped running.
|
String |
getFaultDomain()
The fault domain of the container instance that hosts the container runs.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
List<ContainerHealthCheck> |
getHealthChecks()
List of container health checks
|
String |
getId()
The OCID of
the container.
|
String |
getImageUrl()
The container image information.
|
Boolean |
getIsResourcePrincipalDisabled()
Determines if the container will have access to the container instance resource principal.
|
String |
getLifecycleDetails()
A message that describes the current state of the container in more detail.
|
Container.LifecycleState |
getLifecycleState()
The current state of the container.
|
ContainerResourceConfig |
getResourceConfig() |
SecurityContext |
getSecurityContext() |
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
Date |
getTimeCreated()
The time the container was created, in the format defined by RFC
3339.
|
Date |
getTimeTerminated()
The time when the container last deleted (terminated), in the format defined by RFC
3339.
|
Date |
getTimeUpdated()
The time the container was updated, in the format defined by RFC
3339.
|
List<VolumeMount> |
getVolumeMounts()
List of the volume mounts.
|
String |
getWorkingDirectory()
The working directory within the container’s filesystem for the container process.
|
int |
hashCode() |
Container.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","freeformTags","definedTags","systemTags","availabilityDomain","faultDomain","lifecycleState","lifecycleDetails","exitCode","timeTerminated","timeCreated","timeUpdated","containerInstanceId","imageUrl","command","arguments","workingDirectory","environmentVariables","volumeMounts","healthChecks","isResourcePrincipalDisabled","resourceConfig","containerRestartAttemptCount","securityContext"}) public Container(String id, String displayName, String compartmentId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, String availabilityDomain, String faultDomain, Container.LifecycleState lifecycleState, String lifecycleDetails, Integer exitCode, Date timeTerminated, Date timeCreated, Date timeUpdated, String containerInstanceId, String imageUrl, List<String> command, List<String> arguments, String workingDirectory, Map<String,String> environmentVariables, List<VolumeMount> volumeMounts, List<ContainerHealthCheck> healthChecks, Boolean isResourcePrincipalDisabled, ContainerResourceConfig resourceConfig, Integer containerRestartAttemptCount, SecurityContext securityContext)
public static Container.Builder builder()
Create a new builder.
public Container.Builder toBuilder()
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getCompartmentId()
The OCID of the compartment that contains the container.
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"}
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"}}.
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"}}.
public String getAvailabilityDomain()
The availability domain where the container instance that hosts the container runs.
public String getFaultDomain()
The fault domain of the container instance that hosts the container runs.
public Container.LifecycleState getLifecycleState()
The current state of the container.
public String getLifecycleDetails()
A message that describes the current state of the container in more detail. Can be used to provide actionable information.
public Integer getExitCode()
The exit code of the container process when it stopped running.
public Date getTimeTerminated()
The time when the container last deleted (terminated), in the format defined by RFC 3339.
public Date getTimeCreated()
The time the container was created, in the format defined by RFC 3339.
public Date getTimeUpdated()
The time the container was updated, in the format defined by RFC 3339.
public String getContainerInstanceId()
The OCID of the container instance that the container is running on.
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.
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.
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.
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.
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.
public List<VolumeMount> getVolumeMounts()
List of the volume mounts.
public List<ContainerHealthCheck> getHealthChecks()
List of container health checks
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.
public ContainerResourceConfig getResourceConfig()
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.
public SecurityContext getSecurityContext()
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.