Class SimulationAppMetadata

java.lang.Object

software.amazon.awssdk.services.simspaceweaver.model.SimulationAppMetadata

All Implemented Interfaces:

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

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

A collection of metadata about the app.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SimulationAppMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static SimulationAppMetadata.Builder	builder()
final String	domain()	The domain of the app.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	name()	The name of the app.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends SimulationAppMetadata.Builder>	serializableBuilderClass()
final String	simulation()	The name of the simulation of the app.
final SimulationAppStatus	status()	The current status of the app.
final String	statusAsString()	The current status of the app.
final SimulationAppTargetStatus	targetStatus()	The desired status of the app.
final String	targetStatusAsString()	The desired status of the app.
SimulationAppMetadata.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

domain

public final String domain()

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

Returns:

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

name

public final String name()

The name of the app.

Returns:

The name of the app.

simulation

public final String simulation()

The name of the simulation of the app.

Returns:

The name of the simulation of the app.

status

public final SimulationAppStatus status()

The current status of the app.

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

Returns:

The current status of the app.

See Also:

• SimulationAppStatus

statusAsString

public final String statusAsString()

The current status of the app.

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

Returns:

The current status of the app.

See Also:

• SimulationAppStatus

targetStatus

public final SimulationAppTargetStatus targetStatus()

The desired status of the app.

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

Returns:

The desired status of the app.

See Also:

• SimulationAppTargetStatus

targetStatusAsString

public final String targetStatusAsString()

The desired status of the app.

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

Returns:

The desired status of the app.

See Also:

• SimulationAppTargetStatus

toBuilder

public SimulationAppMetadata.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<SimulationAppMetadata.Builder,SimulationAppMetadata>

Returns:

a builder for type T

builder

public static SimulationAppMetadata.Builder builder()

serializableBuilderClass

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