Class StreamGroupSummary

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

Describes a Amazon GameLift Streams stream group resource for hosting content streams. To retrieve additional stream group details, call GetStreamGroup.

See Also:

  • Method Details

    • arn

      public final String arn()

      An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.

      Returns:
      An Amazon Resource Name (ARN) that uniquely identifies the stream group resource. 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).

    • defaultApplication

      public final DefaultApplication defaultApplication()

      Object that identifies the Amazon GameLift Streams application to stream with this stream group.

      Returns:
      Object that identifies the Amazon GameLift Streams application to stream 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()

      An ID that uniquely identifies the stream group resource. Example ID: sg-1AB2C3De4.

      Returns:
      An ID that uniquely identifies the stream group resource. Example ID: 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).

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

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

    • builder

      public static StreamGroupSummary.Builder builder()

    • serializableBuilderClass

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