Class UpdateApplicationResponse

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

  • Method Details

    • applicationLogOutputUri

      public final String applicationLogOutputUri()

      An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths.

      Returns:
      An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths.

    • hasApplicationLogPaths

      public final boolean hasApplicationLogPaths()
      For responses, this returns true if the service returned a value for the ApplicationLogPaths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • applicationLogPaths

      public final List<String> applicationLogPaths()

      Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasApplicationLogPaths() method.

      Returns:
      Locations of log files that your content generates during a stream session. Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri.

    • applicationSourceUri

      public final String applicationSourceUri()

      The original Amazon S3 location of uploaded stream content for the application.

      Returns:
      The original Amazon S3 location of uploaded stream content for the application.

    • arn

      public final String arn()

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

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

    • hasAssociatedStreamGroups

      public final boolean hasAssociatedStreamGroups()
      For responses, this returns true if the service returned a value for the AssociatedStreamGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • associatedStreamGroups

      public final List<String> associatedStreamGroups()

      A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application.

      This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssociatedStreamGroups() method.

      Returns:
      A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application.

      This value is a set of Amazon Resource Names (ARNs) that uniquely identify stream group resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.

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

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

    • executablePath

      public final String executablePath()

      The path and file name of the executable file that launches the content for streaming.

      Returns:
      The path and file name of the executable file that launches the content for streaming.

    • id

      public final String id()

      A unique ID value that is assigned to the resource when it's created. Format example: a-9ZY8X7Wv6.

      Returns:
      A unique ID value that is assigned to the resource when it's created. Format example: a-9ZY8X7Wv6.

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

    • hasReplicationStatuses

      public final boolean hasReplicationStatuses()
      For responses, this returns true if the service returned a value for the ReplicationStatuses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • replicationStatuses

      public final List<ReplicationStatus> replicationStatuses()

      A set of replication statuses for each location.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReplicationStatuses() method.

      Returns:
      A set of replication statuses for each location.

    • 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 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 8.0-5 (Type=PROTON, Version=20241007)

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

    • 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. See StatusReason for more information.

      • 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. See StatusReason for more information.

      • 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. See StatusReason for more information.

      • 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. See StatusReason for more information.

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

      See Also:

    • statusReason

      public final ApplicationStatusReason statusReason()

      A short description of the status reason when the application is in ERROR status.

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

      Returns:
      A short description of the status reason when the application is in ERROR status.
      See Also:

    • statusReasonAsString

      public final String statusReasonAsString()

      A short description of the status reason when the application is in ERROR status.

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

      Returns:
      A short description of the status reason when the application is in ERROR status.
      See Also:

    • toBuilder

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

    • builder

      public static UpdateApplicationResponse.Builder builder()

    • serializableBuilderClass

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