org.eclipse.kura.container.orchestration

Class ContainerInstanceDescriptor

java.lang.Object

org.eclipse.kura.container.orchestration.ContainerInstanceDescriptor

@ProviderType
public class ContainerInstanceDescriptor
extends java.lang.Object

Object which represents a instantiated container. Used to track created containers.

Since:

2.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContainerInstanceDescriptor.ContainerInstanceDescriptorBuilder

Method Summary

Modifier and Type	Method and Description
static ContainerInstanceDescriptor.ContainerInstanceDescriptorBuilder	builder() Creates a builder for creating a new ContainerInstanceDescriptor instance.
boolean	equals(java.lang.Object obj)
java.lang.String	getContainerId() Returns the containerID
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	getContainerName() Returns the container name
java.util.List<ContainerPort>	getContainerPorts() Returns a list of ContainerPort mapped to the container.
java.util.List<java.lang.Integer>	getContainerPortsExternal() Deprecated. please use getContainerPorts as it includes the network protocol with the port mapping.
java.util.List<java.lang.Integer>	getContainerPortsInternal() Deprecated. please use getContainerPorts as it includes the network protocol with the port mapping.
ContainerState	getContainerState() Returns the container status as ContainerState
int	hashCode()
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

getContainerState

public ContainerState getContainerState()

Returns the container status as ContainerState

Returns:

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:

getContainerImage

public java.lang.String getContainerImage()

Returns the base image for the associated container

Returns:

getContainerImageTag

public java.lang.String getContainerImageTag()

Returns the image tag for the associated container

Returns:

getContainerId

public java.lang.String getContainerId()

Returns the containerID

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. 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. 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:

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

builder

public static ContainerInstanceDescriptor.ContainerInstanceDescriptorBuilder builder()

Creates a builder for creating a new ContainerInstanceDescriptor instance.

Returns:

the builder.