Container (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lightsail.model.Container

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Container
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Container()

Constructors
Constructor and Description
`Container()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Container`	`addEnvironmentEntry(String key, String value)` Add a single Environment entry
`Container`	`addPortsEntry(String key, String value)` Add a single Ports entry
`Container`	`clearEnvironmentEntries()` Removes all the entries added into Environment.
`Container`	`clearPortsEntries()` Removes all the entries added into Ports.
`Container`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getCommand()` The launch command for the container.
`Map<String,String>`	`getEnvironment()` The environment variables of the container.
`String`	`getImage()` The name of the image used for the container.
`Map<String,String>`	`getPorts()` The open firewall ports of the container.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCommand(Collection<String> command)` The launch command for the container.
`void`	`setEnvironment(Map<String,String> environment)` The environment variables of the container.
`void`	`setImage(String image)` The name of the image used for the container.
`void`	`setPorts(Map<String,String> ports)` The open firewall ports of the container.
`String`	`toString()` Returns a string representation of this object.
`Container`	`withCommand(Collection<String> command)` The launch command for the container.
`Container`	`withCommand(String... command)` The launch command for the container.
`Container`	`withEnvironment(Map<String,String> environment)` The environment variables of the container.
`Container`	`withImage(String image)` The name of the image used for the container.
`Container`	`withPorts(Map<String,String> ports)` The open firewall ports of the container.

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

- Constructor Detail
  - Container
```
public Container()
```
- Method Detail
  - setImage
```
public void setImage(String image)
```
    The name of the image used for the container.
    
    Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third (3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.
    
    Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx.
    
    Parameters:
    
    image - The name of the image used for the container.
    
    Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third (3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.
    
    Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx.
  - getImage
```
public String getImage()
```
    The name of the image used for the container.
    
    Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third (3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.
    
    Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx.
    
    Returns:
    
    The name of the image used for the container.
    
    Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third (3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.
    
    Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx.
  - withImage
```
public Container withImage(String image)
```
    The name of the image used for the container.
    
    Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third (3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.
    
    Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx.
    
    Parameters:
    
    image - The name of the image used for the container.
    
    Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, if your container service name is container-service-1, the container image label is mystaticsite, and you want to use the third (3) version of the registered container image, then you should specify :container-service-1.mystaticsite.3. To use the latest version of a container image, specify latest instead of a version number (for example, :container-service-1.mystaticsite.latest). Lightsail will automatically use the highest numbered version of the registered container image.
    
    Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCommand
```
public List<String> getCommand()
```
    The launch command for the container.
    
    Returns:
    
    The launch command for the container.
  - setCommand
```
public void setCommand(Collection<String> command)
```
    The launch command for the container.
    
    Parameters:
    
    command - The launch command for the container.
  - withCommand
```
public Container withCommand(String... command)
```
    The launch command for the container.
    
    NOTE: This method appends the values to the existing list (if any). Use setCommand(java.util.Collection) or withCommand(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    command - The launch command for the container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCommand
```
public Container withCommand(Collection<String> command)
```
    The launch command for the container.
    
    Parameters:
    
    command - The launch command for the container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnvironment
```
public Map<String,String> getEnvironment()
```
    The environment variables of the container.
    
    Returns:
    
    The environment variables of the container.
  - setEnvironment
```
public void setEnvironment(Map<String,String> environment)
```
    The environment variables of the container.
    
    Parameters:
    
    environment - The environment variables of the container.
  - withEnvironment
```
public Container withEnvironment(Map<String,String> environment)
```
    The environment variables of the container.
    
    Parameters:
    
    environment - The environment variables of the container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addEnvironmentEntry
```
public Container addEnvironmentEntry(String key,
                                     String value)
```
    Add a single Environment entry
    
    See Also:
    
    withEnvironment(java.util.Map<java.lang.String, java.lang.String>)
  - clearEnvironmentEntries
```
public Container clearEnvironmentEntries()
```
    Removes all the entries added into Environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPorts
```
public Map<String,String> getPorts()
```
    The open firewall ports of the container.
    
    Returns:
    
    The open firewall ports of the container.
  - setPorts
```
public void setPorts(Map<String,String> ports)
```
    The open firewall ports of the container.
    
    Parameters:
    
    ports - The open firewall ports of the container.
  - withPorts
```
public Container withPorts(Map<String,String> ports)
```
    The open firewall ports of the container.
    
    Parameters:
    
    ports - The open firewall ports of the container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addPortsEntry
```
public Container addPortsEntry(String key,
                               String value)
```
    Add a single Ports entry
    
    See Also:
    
    withPorts(java.util.Map<java.lang.String, java.lang.String>)
  - clearPortsEntries
```
public Container clearPortsEntries()
```
    Removes all the entries added into Ports.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Container clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Container

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Container

Method Detail

setImage

getImage

withImage

getCommand

setCommand

withCommand

withCommand

getEnvironment

setEnvironment

withEnvironment

addEnvironmentEntry

clearEnvironmentEntries

getPorts

setPorts

withPorts

addPortsEntry

clearPortsEntries

toString

equals

hashCode

clone

marshall