@Generated(value="OracleSDKGenerator",
comments="API Version: 20210415")
public final class CreateContainerDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Information to create a new container within a container instance.
The container created by this call contains both the tags specified in this object and any tags specified in the parent container instance.
The container is created in the same compartment, availability domain, and fault domain as its
container instance.
Note: Objects should always be created or deserialized using the CreateContainerDetails.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 CreateContainerDetails.Builder, which maintain a
set of all explicitly set fields called CreateContainerDetails.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 |
CreateContainerDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
CreateContainerDetails(String displayName,
String imageUrl,
List<String> command,
List<String> arguments,
String workingDirectory,
Map<String,String> environmentVariables,
List<CreateVolumeMountDetails> volumeMounts,
Boolean isResourcePrincipalDisabled,
CreateContainerResourceConfigDetails resourceConfig,
List<CreateContainerHealthCheckDetails> healthChecks,
CreateSecurityContextDetails securityContext,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateContainerDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
List<String> |
getArguments()
A list of string arguments for a container’s ENTRYPOINT process.
|
List<String> |
getCommand()
An optional command that overrides the ENTRYPOINT process.
|
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 container’s
ENTRYPOINT process.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
List<CreateContainerHealthCheckDetails> |
getHealthChecks()
list of container health checks to check container status and take appropriate action if
container status is failed.
|
String |
getImageUrl()
A URL identifying the image that the container runs in, such as
docker.io/library/busybox:latest.
|
Boolean |
getIsResourcePrincipalDisabled()
Determines if the container will have access to the container instance resource principal.
|
CreateContainerResourceConfigDetails |
getResourceConfig() |
CreateSecurityContextDetails |
getSecurityContext() |
List<CreateVolumeMountDetails> |
getVolumeMounts()
List of the volume mounts.
|
String |
getWorkingDirectory()
The working directory within the container’s filesystem for the container process.
|
int |
hashCode() |
CreateContainerDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"displayName","imageUrl","command","arguments","workingDirectory","environmentVariables","volumeMounts","isResourcePrincipalDisabled","resourceConfig","healthChecks","securityContext","freeformTags","definedTags"}) public CreateContainerDetails(String displayName, String imageUrl, List<String> command, List<String> arguments, String workingDirectory, Map<String,String> environmentVariables, List<CreateVolumeMountDetails> volumeMounts, Boolean isResourcePrincipalDisabled, CreateContainerResourceConfigDetails resourceConfig, List<CreateContainerHealthCheckDetails> healthChecks, CreateSecurityContextDetails securityContext, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static CreateContainerDetails.Builder builder()
Create a new builder.
public CreateContainerDetails.Builder toBuilder()
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information. If you don’t provide a name, a name is generated automatically.
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.
public List<String> getCommand()
An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.
public List<String> getArguments()
A list of string arguments for a container’s ENTRYPOINT process.
Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.
The total size of all arguments combined must be 64 KB or smaller.
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 container’s ENTRYPOINT process. These variables are in addition to any variables already defined in the container’s image.
The total size of all environment variables combined, name and values, must be 64 KB or smaller.
public List<CreateVolumeMountDetails> getVolumeMounts()
List of the volume mounts.
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 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 CreateContainerResourceConfigDetails getResourceConfig()
public List<CreateContainerHealthCheckDetails> getHealthChecks()
list of container health checks to check container status and take appropriate action if container status is failed. There are three types of health checks that we currently support HTTP, TCP, and Command.
public CreateSecurityContextDetails getSecurityContext()
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 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.