Class ShaderCacheSummary

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

Describes a shader cache associated with an Amazon GameLift Streams application.

See Also:

  • Method Details

    • identifier

      public final String identifier()

      A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is 1271e693c50b940e228582f1ccdd4e27.

      Returns:
      A unique identifier for the shader cache, formatted as a 32-character hexadecimal string. Format is 1271e693c50b940e228582f1ccdd4e27.

    • applicationArn

      public final String applicationArn()

      An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

      Returns:
      An Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

    • status

      public final ShaderCacheStatus status()

      The current status of the shader cache. Possible statuses include the following:

      • INITIALIZED: Amazon GameLift Streams received the request and is preparing the shader cache.

      • PROCESSING: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups.

      • READY: The shader cache is replicated and available for use in stream sessions.

      • DELETING: Amazon GameLift Streams is deleting the shader cache.

      • ERROR: An error occurred during shader cache processing. Create a new shader cache to try again.

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

      Returns:
      The current status of the shader cache. Possible statuses include the following:

      • INITIALIZED: Amazon GameLift Streams received the request and is preparing the shader cache.

      • PROCESSING: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups.

      • READY: The shader cache is replicated and available for use in stream sessions.

      • DELETING: Amazon GameLift Streams is deleting the shader cache.

      • ERROR: An error occurred during shader cache processing. Create a new shader cache to try again.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the shader cache. Possible statuses include the following:

      • INITIALIZED: Amazon GameLift Streams received the request and is preparing the shader cache.

      • PROCESSING: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups.

      • READY: The shader cache is replicated and available for use in stream sessions.

      • DELETING: Amazon GameLift Streams is deleting the shader cache.

      • ERROR: An error occurred during shader cache processing. Create a new shader cache to try again.

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

      Returns:
      The current status of the shader cache. Possible statuses include the following:

      • INITIALIZED: Amazon GameLift Streams received the request and is preparing the shader cache.

      • PROCESSING: Amazon GameLift Streams is replicating the shader cache to the streaming locations in the associated stream groups.

      • READY: The shader cache is replicated and available for use in stream sessions.

      • DELETING: Amazon GameLift Streams is deleting the shader cache.

      • ERROR: An error occurred during shader cache processing. Create a new shader cache to try again.

      See Also:

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

    • storageBytes

      public final Long storageBytes()

      The total storage used by all compiled shader files in this shader cache, in bytes.

      Returns:
      The total storage used by all compiled shader files in this shader cache, in bytes.

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

      The stream groups compatible with this shader cache. Compatibility is based on GPU type and GPU driver version. For more information on shader cache compatibility, see Shader caches in the Amazon GameLift Streams Developer Guide.

      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:
      The stream groups compatible with this shader cache. Compatibility is based on GPU type and GPU driver version. For more information on shader cache compatibility, see Shader caches in the Amazon GameLift Streams Developer Guide.

      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.

    • toBuilder

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

    • builder

      public static ShaderCacheSummary.Builder builder()

    • serializableBuilderClass

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