@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
ContainerInstance.Builder |
static class |
ContainerInstance.ContainerRestartPolicy
The container restart policy is applied for all containers in container instance.
|
static class |
ContainerInstance.LifecycleState
The current state of the container instance.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
ContainerInstance(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,
ContainerInstance.LifecycleState lifecycleState,
String lifecycleDetails,
List<ContainerVolume> volumes,
Integer volumeCount,
List<ContainerInstanceContainer> containers,
Integer containerCount,
Date timeCreated,
Date timeUpdated,
String shape,
ContainerInstanceShapeConfig shapeConfig,
List<ContainerVnic> vnics,
ContainerDnsConfig dnsConfig,
Long gracefulShutdownTimeoutInSeconds,
List<ImagePullSecret> imagePullSecrets,
ContainerInstance.ContainerRestartPolicy containerRestartPolicy)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static ContainerInstance.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAvailabilityDomain()
The availability domain to place the container instance.
|
String |
getCompartmentId()
The OCID of the compartment.
|
Integer |
getContainerCount()
The number of containers on the container instance.
|
ContainerInstance.ContainerRestartPolicy |
getContainerRestartPolicy()
The container restart policy is applied for all containers in container instance.
|
List<ContainerInstanceContainer> |
getContainers()
The containers on the container instance.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
ContainerDnsConfig |
getDnsConfig() |
String |
getFaultDomain()
The fault domain to place the container instance.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
Long |
getGracefulShutdownTimeoutInSeconds()
The amount of time that processes in a container have to gracefully end when the container
must be stopped.
|
String |
getId()
An OCID that cannot be changed.
|
List<ImagePullSecret> |
getImagePullSecrets()
The image pulls secrets so you can access private registry to pull container images.
|
String |
getLifecycleDetails()
A message that describes the current state of the container in more detail.
|
ContainerInstance.LifecycleState |
getLifecycleState()
The current state of the container instance.
|
String |
getShape()
The shape of the container instance.
|
ContainerInstanceShapeConfig |
getShapeConfig() |
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
Date |
getTimeCreated()
The time the container instance was created, in the format defined by RFC
3339.
|
Date |
getTimeUpdated()
The time the container instance was updated, in the format defined by RFC
3339.
|
List<ContainerVnic> |
getVnics()
The virtual networks available to the containers in the container instance.
|
Integer |
getVolumeCount()
The number of volumes that are attached to the container instance.
|
List<ContainerVolume> |
getVolumes()
A volume is a directory with data that is accessible across multiple containers in a
container instance.
|
int |
hashCode() |
ContainerInstance.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","volumes","volumeCount","containers","containerCount","timeCreated","timeUpdated","shape","shapeConfig","vnics","dnsConfig","gracefulShutdownTimeoutInSeconds","imagePullSecrets","containerRestartPolicy"}) public ContainerInstance(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, ContainerInstance.LifecycleState lifecycleState, String lifecycleDetails, List<ContainerVolume> volumes, Integer volumeCount, List<ContainerInstanceContainer> containers, Integer containerCount, Date timeCreated, Date timeUpdated, String shape, ContainerInstanceShapeConfig shapeConfig, List<ContainerVnic> vnics, ContainerDnsConfig dnsConfig, Long gracefulShutdownTimeoutInSeconds, List<ImagePullSecret> imagePullSecrets, ContainerInstance.ContainerRestartPolicy containerRestartPolicy)
public static ContainerInstance.Builder builder()
Create a new builder.
public ContainerInstance.Builder toBuilder()
public String getId()
An OCID that cannot be changed.
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.
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 to place the container instance.
public String getFaultDomain()
The fault domain to place the container instance.
public ContainerInstance.LifecycleState getLifecycleState()
The current state of the container instance.
public String getLifecycleDetails()
A message that describes the current state of the container in more detail. Can be used to provide actionable information.
public List<ContainerVolume> getVolumes()
A volume is a directory with data that is accessible across multiple containers in a container instance.
public Integer getVolumeCount()
The number of volumes that are attached to the container instance.
public List<ContainerInstanceContainer> getContainers()
The containers on the container instance.
public Integer getContainerCount()
The number of containers on the container instance.
public Date getTimeCreated()
The time the container instance was created, in the format defined by RFC 3339.
public Date getTimeUpdated()
The time the container instance was updated, in the format defined by RFC 3339.
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.
public ContainerInstanceShapeConfig getShapeConfig()
public List<ContainerVnic> getVnics()
The virtual networks available to the containers in the container instance.
public ContainerDnsConfig getDnsConfig()
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.
public List<ImagePullSecret> getImagePullSecrets()
The image pulls secrets so you can access private registry to pull container images.
public ContainerInstance.ContainerRestartPolicy getContainerRestartPolicy()
The container restart policy is applied for all containers in container instance.
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.