Class DescribeAppResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.simspaceweaver.model.SimSpaceWeaverResponse
software.amazon.awssdk.services.simspaceweaver.model.DescribeAppResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAppResponse.Builder,DescribeAppResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAppResponse extends SimSpaceWeaverResponse implements ToCopyableBuilder<DescribeAppResponse.Builder,DescribeAppResponse>

  • Method Details

    • description

      public final String description()

      The description of the app.

      Returns:
      The description of the app.

    • domain

      public final String domain()

      The name of the domain of the app.

      Returns:
      The name of the domain of the app.

    • endpointInfo

      public final SimulationAppEndpointInfo endpointInfo()

      Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.

      Returns:
      Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.

    • launchOverrides

      public final LaunchOverrides launchOverrides()
      Returns the value of the LaunchOverrides property for this object.
      Returns:
      The value of the LaunchOverrides property for this object.

    • 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 lifecycle state of the custom 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 lifecycle state of the custom app.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current lifecycle state of the custom 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 lifecycle state of the custom app.
      See Also:

    • targetStatus

      public final SimulationAppTargetStatus targetStatus()

      The desired lifecycle state of the custom 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 lifecycle state of the custom app.
      See Also:

    • targetStatusAsString

      public final String targetStatusAsString()

      The desired lifecycle state of the custom 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 lifecycle state of the custom app.
      See Also:

    • toBuilder

      public DescribeAppResponse.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<DescribeAppResponse.Builder,DescribeAppResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeAppResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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