Class Domain

java.lang.Object
software.amazon.awssdk.services.simspaceweaver.model.Domain
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Domain.Builder,Domain>
@Generated("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:

  • Method Details

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

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

    • name

      public final String name()

      The name of the domain.

      Returns:
      The name of the domain.

    • toBuilder

      public Domain.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Domain.Builder,Domain>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.