Class UpdateStreamGroupResponse

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.UpdateStreamGroupResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateStreamGroupResponse.Builder,UpdateStreamGroupResponse>
@Generated("software.amazon.awssdk:codegen") public final class UpdateStreamGroupResponse extends GameLiftStreamsResponse implements ToCopyableBuilder<UpdateStreamGroupResponse.Builder,UpdateStreamGroupResponse>

  • Method Details

    • arn

      public final String arn()

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

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

    • hasAssociatedApplications

      public final boolean hasAssociatedApplications()
      For responses, this returns true if the service returned a value for the AssociatedApplications 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.

    • associatedApplications

      public final List<String> associatedApplications()

      A set of applications that this stream group is associated with. You can stream any of these applications with the stream group.

      This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6.

      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 hasAssociatedApplications() method.

      Returns:
      A set of applications that this stream group is associated with. You can stream any of these applications with the stream group.

      This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Format example: arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6.

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

    • defaultApplication

      public final DefaultApplication defaultApplication()

      The default Amazon GameLift Streams application that is associated with this stream group.

      Returns:
      The default Amazon GameLift Streams application that is associated with this stream group.

    • description

      public final String description()

      A descriptive label for the stream group.

      Returns:
      A descriptive label for the stream group.

    • id

      public final String id()

      A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.

      Returns:
      A unique ID value that is assigned to the resource when it's created. Format example: sg-1AB2C3De4.

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

    • hasLocationStates

      public final boolean hasLocationStates()
      For responses, this returns true if the service returned a value for the LocationStates 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.

    • locationStates

      public final List<LocationState> locationStates()

      This value is set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

      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 hasLocationStates() method.

      Returns:
      This value is set of locations, including their name, current status, and capacities.

      A location can be in one of the following states:

      • ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet.

      • ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location.

      • ERROR: Amazon GameLift Streams failed to set up this location. The StatusReason field describes the error. You can remove this location and try to add it again.

      • REMOVING: Amazon GameLift Streams is working to remove this location. It releases all provisioned capacity for this location in this stream group.

    • status

      public final StreamGroupStatus status()

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

      • ACTIVATING: The stream group is deploying and isn't ready to host streams.

      • ACTIVE: The stream group is ready to host streams.

      • ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.

      • ERROR: An error occurred when the stream group deployed. See StatusReason for more information.

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

      • UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).

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

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

      • ACTIVATING: The stream group is deploying and isn't ready to host streams.

      • ACTIVE: The stream group is ready to host streams.

      • ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.

      • ERROR: An error occurred when the stream group deployed. See StatusReason for more information.

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

      • UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).

      See Also:

    • statusAsString

      public final String statusAsString()

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

      • ACTIVATING: The stream group is deploying and isn't ready to host streams.

      • ACTIVE: The stream group is ready to host streams.

      • ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.

      • ERROR: An error occurred when the stream group deployed. See StatusReason for more information.

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

      • UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).

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

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

      • ACTIVATING: The stream group is deploying and isn't ready to host streams.

      • ACTIVE: The stream group is ready to host streams.

      • ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error.

      • ERROR: An error occurred when the stream group deployed. See StatusReason for more information.

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

      • UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).

      See Also:

    • statusReason

      public final StreamGroupStatusReason statusReason()

      A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

      • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

      • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

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

      Returns:
      A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

      • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

      • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

      See Also:

    • statusReasonAsString

      public final String statusReasonAsString()

      A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

      • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

      • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

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

      Returns:
      A short description of the reason that the stream group is in ERROR status. The possible reasons can be one of the following:

      • internalError: The request can't process right now bcause of an issue with the server. Try again later. Reach out to the Amazon GameLift Streams team for more help.

      • noAvailableInstances: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.

      See Also:

    • streamClass

      public final StreamClass streamClass()

      The target stream quality for the stream group.

      A stream class can be one of the following:

      • gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

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

      Returns:
      The target stream quality for the stream group.

      A stream class can be one of the following:

      • gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      See Also:

    • streamClassAsString

      public final String streamClassAsString()

      The target stream quality for the stream group.

      A stream class can be one of the following:

      • gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

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

      Returns:
      The target stream quality for the stream group.

      A stream class can be one of the following:

      • gen5n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen5n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen5n_ultra (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_win2022 (NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      • gen4n_high (NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM

        • Tenancy: Supports up to 2 concurrent stream sessions

      • gen4n_ultra (NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.

        • Reference resolution: 1080p

        • Reference frame rate: 60 fps

        • Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM

        • Tenancy: Supports 1 concurrent stream session

      See Also:

    • toBuilder

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

    • builder

      public static UpdateStreamGroupResponse.Builder builder()

    • serializableBuilderClass

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