software.amazon.awssdk.services.lightsail.model

Class Container

java.lang.Object

software.amazon.awssdk.services.lightsail.model.Container

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Container.Builder,Container>

@Generated(value="software.amazon.awssdk:codegen")
public final class Container
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Container.Builder,Container>

Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Container.Builder

Method Summary

Modifier and Type	Method and Description
static Container.Builder	builder()
List<String>	command() The launch command for the container.
Map<String,String>	environment() The environment variables of the container.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCommand() For responses, this returns true if the service returned a value for the Command property.
boolean	hasEnvironment() For responses, this returns true if the service returned a value for the Environment property.
int	hashCode()
boolean	hasPorts() For responses, this returns true if the service returned a value for the Ports property.
String	image() The name of the image used for the container.
Map<String,ContainerServiceProtocol>	ports() The open firewall ports of the container.
Map<String,String>	portsAsStrings() The open firewall ports of the container.
List<SdkField<?>>	sdkFields()
static Class<? extends Container.Builder>	serializableBuilderClass()
Container.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

image

public final 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.

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.

hasCommand

public final boolean hasCommand()

For responses, this returns true if the service returned a value for the Command property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

command

public final List<String> command()

The launch command for the container.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCommand() method.

Returns:

The launch command for the container.

hasEnvironment

public final boolean hasEnvironment()

For responses, this returns true if the service returned a value for the Environment property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

environment

public final Map<String,String> environment()

The environment variables of the container.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironment() method.

Returns:

The environment variables of the container.

ports

public final Map<String,ContainerServiceProtocol> ports()

The open firewall ports of the container.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPorts() method.

Returns:

The open firewall ports of the container.

hasPorts

public final boolean hasPorts()

For responses, this returns true if the service returned a value for the Ports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

portsAsStrings

public final Map<String,String> portsAsStrings()

The open firewall ports of the container.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPorts() method.

Returns:

The open firewall ports of the container.

toBuilder

public Container.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Container.Builder,Container>

builder

public static Container.Builder builder()

serializableBuilderClass

public static Class<? extends Container.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo