Class ApplicationSummary

java.lang.Object
software.amazon.awssdk.services.gameliftstreams.model.ApplicationSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ApplicationSummary.Builder,ApplicationSummary>
@Generated("software.amazon.awssdk:codegen") public final class ApplicationSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ApplicationSummary.Builder,ApplicationSummary>

Describes an application resource that represents a collection of content for streaming with Amazon GameLift Streams. To retrieve additional application details, call GetApplication.

See Also:

  • Method Details

    • arn

      public final String arn()

      An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies the application across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID].

      Returns:
      An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies the application across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID].

    • id

      public final String id()

      An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6.

      Returns:
      An ID that uniquely identifies the application resource. Example ID: a-9ZY8X7Wv6.

    • description

      public final String description()

      A human-readable label for the application. You can edit this value.

      Returns:
      A human-readable label for the application. You can edit this value.

    • status

      public final ApplicationStatus status()

      The current status of the application resource. Possible statuses include the following:

      • INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.

      • PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.

      • READY: The application is ready to deploy in a stream group.

      • ERROR: An error occurred when setting up the application. For more information about the error, call GetApplication and refer to StatusReason.

      • DELETING: Amazon GameLift Streams is in the process of deleting the application.

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

      Returns:
      The current status of the application resource. Possible statuses include the following:

      • INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.

      • PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.

      • READY: The application is ready to deploy in a stream group.

      • ERROR: An error occurred when setting up the application. For more information about the error, call GetApplication and refer to StatusReason.

      • DELETING: Amazon GameLift Streams is in the process of deleting the application.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the application resource. Possible statuses include the following:

      • INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.

      • PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.

      • READY: The application is ready to deploy in a stream group.

      • ERROR: An error occurred when setting up the application. For more information about the error, call GetApplication and refer to StatusReason.

      • DELETING: Amazon GameLift Streams is in the process of deleting the application.

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

      Returns:
      The current status of the application resource. Possible statuses include the following:

      • INITIALIZED: Amazon GameLift Streams has received the request and is initiating the work flow to create an application.

      • PROCESSING: The create application work flow is in process. Amazon GameLift Streams is copying the content and caching for future deployment in a stream group.

      • READY: The application is ready to deploy in a stream group.

      • ERROR: An error occurred when setting up the application. For more information about the error, call GetApplication and refer to StatusReason.

      • DELETING: Amazon GameLift Streams is in the process of deleting the application.

      See Also:

    • createdAt

      public final Instant createdAt()

      A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

      Returns:
      A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

      Returns:
      A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

    • runtimeEnvironment

      public final RuntimeEnvironment runtimeEnvironment()

      Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

      A runtime environment can be one of the following:

      • For Linux applications

        • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

      • For Windows applications

        • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

        • Proton 9.0-2 (Type=PROTON, Version=20250516)

        • Proton 8.0-5 (Type=PROTON, Version=20241007)

        • Proton 8.0-2c (Type=PROTON, Version=20230704)

      Returns:
      Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

      A runtime environment can be one of the following:

      • For Linux applications

        • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

      • For Windows applications

        • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

        • Proton 9.0-2 (Type=PROTON, Version=20250516)

        • Proton 8.0-5 (Type=PROTON, Version=20241007)

        • Proton 8.0-2c (Type=PROTON, Version=20230704)

    • toBuilder

      public ApplicationSummary.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<ApplicationSummary.Builder,ApplicationSummary>
      Returns:
      a builder for type T

    • builder

      public static ApplicationSummary.Builder builder()

    • serializableBuilderClass

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