Class AnalysisLogExport

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

An export of the redacted Apache Spark logs for a protected query.

See Also:

  • Method Details

    • analysisLogExportId

      public final String analysisLogExportId()

      The unique identifier of the analysis log export.

      Returns:
      The unique identifier of the analysis log export.

    • analysisId

      public final String analysisId()

      The unique identifier of the protected query that the analysis logs were exported for.

      Returns:
      The unique identifier of the protected query that the analysis logs were exported for.

    • analysisType

      public final LogExportAnalysisType analysisType()

      The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported.

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

      Returns:
      The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported.
      See Also:

    • analysisTypeAsString

      public final String analysisTypeAsString()

      The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported.

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

      Returns:
      The type of analysis that the logs were exported for. Currently, only PROTECTED_QUERY is supported.
      See Also:

    • membershipId

      public final String membershipId()

      The unique identifier of the membership that the analysis log export belongs to.

      Returns:
      The unique identifier of the membership that the analysis log export belongs to.

    • status

      public final AnalysisLogExportStatus status()

      The status of the analysis log export. Possible values are:

      • IN_PROGRESS – The export is currently running.

      • SUCCESS – The export completed successfully.

      • FAILED – The export failed. See the error field for details.

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

      Returns:
      The status of the analysis log export. Possible values are:

      • IN_PROGRESS – The export is currently running.

      • SUCCESS – The export completed successfully.

      • FAILED – The export failed. See the error field for details.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the analysis log export. Possible values are:

      • IN_PROGRESS – The export is currently running.

      • SUCCESS – The export completed successfully.

      • FAILED – The export failed. See the error field for details.

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

      Returns:
      The status of the analysis log export. Possible values are:

      • IN_PROGRESS – The export is currently running.

      • SUCCESS – The export completed successfully.

      • FAILED – The export failed. See the error field for details.

      See Also:

    • resultConfiguration

      public final AnalysisLogExportResultConfiguration resultConfiguration()

      Contains the details needed to write the exported analysis logs.

      Returns:
      Contains the details needed to write the exported analysis logs.

    • createTime

      public final Instant createTime()

      The time the analysis log export was created.

      Returns:
      The time the analysis log export was created.

    • updateTime

      public final Instant updateTime()

      The time the analysis log export was last updated.

      Returns:
      The time the analysis log export was last updated.

    • error

      public final AnalysisLogExportError error()

      The analysis log export error. This is present only when the export status is FAILED.

      Returns:
      The analysis log export error. This is present only when the export status is FAILED.

    • toBuilder

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

    • builder

      public static AnalysisLogExport.Builder builder()

    • serializableBuilderClass

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