software.amazon.awssdk.services.simspaceweaver.model

Class Domain

java.lang.Object

software.amazon.awssdk.services.simspaceweaver.model.Domain

All Implemented Interfaces:

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

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

A collection of app instances that run the same executable app code and have the same launch options and commands.

For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Domain.Builder

Method Summary

Modifier and Type	Method and Description
static Domain.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LifecycleManagementStrategy	lifecycle() The type of lifecycle management for apps in the domain.
String	lifecycleAsString() The type of lifecycle management for apps in the domain.
String	name() The name of the domain.
List<SdkField<?>>	sdkFields()
static Class<? extends Domain.Builder>	serializableBuilderClass()
Domain.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

lifecycle

public final LifecycleManagementStrategy lifecycle()

The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).

Lifecycle types

• PerWorker – Managed: SimSpace Weaver starts one app on each worker.

• BySpatialSubdivision – Managed: SimSpace Weaver starts one app for each spatial partition.

• ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.

If the service returns an enum value that is not available in the current SDK version, lifecycle will return LifecycleManagementStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().

Returns:

The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).

Lifecycle types

• PerWorker – Managed: SimSpace Weaver starts one app on each worker.

• BySpatialSubdivision – Managed: SimSpace Weaver starts one app for each spatial partition.

• ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.

See Also:

LifecycleManagementStrategy

lifecycleAsString

public final String lifecycleAsString()

The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).

Lifecycle types

• PerWorker – Managed: SimSpace Weaver starts one app on each worker.

• BySpatialSubdivision – Managed: SimSpace Weaver starts one app for each spatial partition.

• ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.

If the service returns an enum value that is not available in the current SDK version, lifecycle will return LifecycleManagementStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleAsString().

Returns:

The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are managed (SimSpace Weaver starts and stops the apps) or unmanaged (you must start and stop the apps).

Lifecycle types

• PerWorker – Managed: SimSpace Weaver starts one app on each worker.

• BySpatialSubdivision – Managed: SimSpace Weaver starts one app for each spatial partition.

• ByRequest – Unmanaged: You use the StartApp API to start the apps and use the StopApp API to stop the apps.

See Also:

LifecycleManagementStrategy

name

public final String name()

The name of the domain.

Returns:

The name of the domain.

toBuilder

public Domain.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Domain.Builder,Domain>

builder

public static Domain.Builder builder()

serializableBuilderClass

public static Class<? extends Domain.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