Class ExportFilesMetadata

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

Provides details about the stream session's exported files.

See Also:

  • Method Details

    • outputUri

      public final String outputUri()

      The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a .zip file extension.

      Example 1: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.

      Example 2: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.

      Returns:
      The S3 bucket URI where Amazon GameLift Streams uploaded the set of compressed exported files for a stream session. Amazon GameLift Streams generates a ZIP file name based on the stream session metadata. Alternatively, you can provide a custom file name with a .zip file extension.

      Example 1: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGame_Session1.zip, then Amazon GameLift Streams will save the files at that location.

      Example 2: If you provide an S3 URI called s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/, then Amazon GameLift Streams will save the files at s3://amzn-s3-demo-destination-bucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip or another similar name.

    • status

      public final ExportFilesStatus status()

      The result of the ExportStreamSessionFiles operation.

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

      Returns:
      The result of the ExportStreamSessionFiles operation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The result of the ExportStreamSessionFiles operation.

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

      Returns:
      The result of the ExportStreamSessionFiles operation.
      See Also:

    • statusReason

      public final String statusReason()

      A short description of the reason the export is in FAILED status.

      Returns:
      A short description of the reason the export is in FAILED status.

    • toBuilder

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

    • builder

      public static ExportFilesMetadata.Builder builder()

    • serializableBuilderClass

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