ContainerConfiguration (Eclipse Kura 5.4.0)

java.lang.Object
- org.eclipse.kura.container.orchestration.ContainerConfiguration

```
@ProviderType
public class ContainerConfiguration
extends java.lang.Object
```
Object which represents a container configuration used to request the generation of a new container instance.

Since:

2.3

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ContainerConfiguration.ContainerConfigurationBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ContainerConfiguration.ContainerConfigurationBuilder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ContainerConfiguration.ContainerConfigurationBuilder`	`builder()` Creates a builder for creating a new `ContainerConfiguration` instance.
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<java.lang.String>`	`getContainerDevices()` Returns the list of devices that will be mapped to the container
`java.util.List<java.lang.String>`	`getContainerEnvVars()` Returns the list of environment properties that will be passed to the container
`java.lang.String`	`getContainerImage()` Returns the base image for the associated container.
`java.lang.String`	`getContainerImageTag()` Returns the image tag for the associated container.
`java.lang.String`	`getContainerLoggingType()` Returns a string identifying which logger driver to use.
`java.lang.String`	`getContainerName()` Returns the container name
`ContainerNetworkConfiguration`	`getContainerNetworkConfiguration()` return the container's network configuration as a `ContainerNetworkConfiguration`.
`java.util.List<ContainerPort>`	`getContainerPorts()` Returns a list of `ContainerPort` mapped to the container.
`java.util.List<java.lang.Integer>`	`getContainerPortsExternal()` Deprecated. since 2.5. Please use `getContainerPorts` as it includes the network protocol with the port mapping.
`java.util.List<java.lang.Integer>`	`getContainerPortsInternal()` Deprecated. since 2.5. Please use `getContainerPorts` as it includes the network protocol with the port mapping.
`java.util.Map<java.lang.String,java.lang.String>`	`getContainerVolumes()` Returns a map that identifies the volumes and the internal container mapping
`java.util.Optional<java.lang.Float>`	`getCpus()` Return the cpus resources to be assigned to the container.
`java.util.List<java.lang.String>`	`getEntryPoint()` Returns a List of container entry points.
`java.util.Optional<java.lang.String>`	`getGpus()` Return the gpus to be assigned to the container.
`ImageConfiguration`	`getImageConfiguration()` Returns the `ImageConfiguration` object
`int`	`getImageDownloadTimeoutSeconds()` Returns the image download timeout (in seconds).
`java.util.Map<java.lang.String,java.lang.String>`	`getLoggerParameters()` Returns a Map that identifies configured logger parameters.
`java.util.Optional<java.lang.Long>`	`getMemory()` Return the memory to be assigned to the container.
`java.util.Optional<RegistryCredentials>`	`getRegistryCredentials()` Returns the Registry credentials.
`boolean`	`getRestartOnFailure()` Returns boolean which determines if container will restart on failure
`int`	`hashCode()`
`boolean`	`isContainerPrivileged()` Returns a boolean representing if the container runs or will run in privileged mode.
`boolean`	`isFrameworkManaged()` The method will provide information if the container is or not managed by the framework

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isFrameworkManaged
```
public boolean isFrameworkManaged()
```
    The method will provide information if the container is or not managed by the framework
    
    Returns:
    
    true if the framework manages the container. false otherwise
  - getContainerName
```
public java.lang.String getContainerName()
```
    Returns the container name
    
    Returns:
  - getContainerPorts
```
public java.util.List<ContainerPort> getContainerPorts()
```
    Returns a list of ContainerPort mapped to the container.
    
    Returns:
    
    Since:
    
    2.5
  - getContainerPortsExternal
```
@Deprecated
public java.util.List<java.lang.Integer> getContainerPortsExternal()
```
    Deprecated. since 2.5. Please use getContainerPorts as it includes the network protocol with the port mapping.
    
    Returns the list of external ports that will be mapped to the given container.
    
    Returns:
  - getContainerPortsInternal
```
@Deprecated
public java.util.List<java.lang.Integer> getContainerPortsInternal()
```
    Deprecated. since 2.5. Please use getContainerPorts as it includes the network protocol with the port mapping.
    
    Returns the list of internal ports that will be mapped to the given container
    
    Returns:
  - getContainerEnvVars
```
public java.util.List<java.lang.String> getContainerEnvVars()
```
    Returns the list of environment properties that will be passed to the container
    
    Returns:
  - getContainerDevices
```
public java.util.List<java.lang.String> getContainerDevices()
```
    Returns the list of devices that will be mapped to the container
    
    Returns:
  - getContainerVolumes
```
public java.util.Map<java.lang.String,java.lang.String> getContainerVolumes()
```
    Returns a map that identifies the volumes and the internal container mapping
    
    Returns:
  - isContainerPrivileged
```
public boolean isContainerPrivileged()
```
    Returns a boolean representing if the container runs or will run in privileged mode.
    
    Returns:
  - getLoggerParameters
```
public java.util.Map<java.lang.String,java.lang.String> getLoggerParameters()
```
    Returns a Map that identifies configured logger parameters.
    
    Returns:
  - getContainerLoggingType
```
public java.lang.String getContainerLoggingType()
```
    Returns a string identifying which logger driver to use.
    
    Returns:
  - getImageConfiguration
```
public ImageConfiguration getImageConfiguration()
```
    Returns the ImageConfiguration object
    
    Returns:
    
    Since:
    
    2.4
  - getContainerImage
```
public java.lang.String getContainerImage()
```
    Returns the base image for the associated container. Detailed image information can be found in the ImageConfig class, provided by the getImageConfiguration() method.
    
    Returns:
  - getContainerImageTag
```
public java.lang.String getContainerImageTag()
```
    Returns the image tag for the associated container. Detailed image information can be found in the ImageConfig class, provided by the getImageConfiguration() method.
    
    Returns:
  - getRegistryCredentials
```
public java.util.Optional<RegistryCredentials> getRegistryCredentials()
```
    Returns the Registry credentials. Detailed image information can be found in the ImageConfig class, provided by the getImageConfiguration() method.
    
    Returns:
  - getImageDownloadTimeoutSeconds
```
public int getImageDownloadTimeoutSeconds()
```
    Returns the image download timeout (in seconds). Detailed image information can be found in the ImageConfig class, provided by the getImageConfiguration() method.
    
    Returns:
  - getContainerNetworkConfiguration
```
public ContainerNetworkConfiguration getContainerNetworkConfiguration()
```
    return the container's network configuration as a ContainerNetworkConfiguration.
    
    Returns:
    
    Since:
    
    2.4
  - getEntryPoint
```
public java.util.List<java.lang.String> getEntryPoint()
```
    Returns a List of container entry points. An empty list can be returned if no entrypoints are specified.
    
    Returns:
    
    Since:
    
    2.4
  - getRestartOnFailure
```
public boolean getRestartOnFailure()
```
    Returns boolean which determines if container will restart on failure
    
    Returns:
    
    Since:
    
    2.4
  - getMemory
```
public java.util.Optional<java.lang.Long> getMemory()
```
    Return the memory to be assigned to the container.
    
    Returns:
    
    Since:
    
    2.4
  - getCpus
```
public java.util.Optional<java.lang.Float> getCpus()
```
    Return the cpus resources to be assigned to the container.
    
    Returns:
    
    Since:
    
    2.4
  - getGpus
```
public java.util.Optional<java.lang.String> getGpus()
```
    Return the gpus to be assigned to the container.
    
    Returns:
    
    Since:
    
    2.4
  - builder
```
public static ContainerConfiguration.ContainerConfigurationBuilder builder()
```
    Creates a builder for creating a new ContainerConfiguration instance.
    
    Returns:
    
    the builder.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class ContainerConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isFrameworkManaged

getContainerName

getContainerPorts

getContainerPortsExternal

getContainerPortsInternal

getContainerEnvVars

getContainerDevices

getContainerVolumes

isContainerPrivileged

getLoggerParameters

getContainerLoggingType

getImageConfiguration

getContainerImage

getContainerImageTag

getRegistryCredentials

getImageDownloadTimeoutSeconds

getContainerNetworkConfiguration

getEntryPoint

getRestartOnFailure

getMemory

getCpus

getGpus

builder

hashCode

equals