Class ProtectedJob

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

The parameters for an Clean Rooms protected job.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier for a protected job instance.

      Returns:
      The identifier for a protected job instance.

    • membershipId

      public final String membershipId()

      he identifier for the membership.

      Returns:
      he identifier for the membership.

    • membershipArn

      public final String membershipArn()

      The ARN of the membership.

      Returns:
      The ARN of the membership.

    • createTime

      public final Instant createTime()

      The creation time of the protected job.

      Returns:
      The creation time of the protected job.

    • jobParameters

      public final ProtectedJobParameters jobParameters()

      The job parameters for the protected job.

      Returns:
      The job parameters for the protected job.

    • status

      public final ProtectedJobStatus status()

      The status of the protected job.

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

      Returns:
      The status of the protected job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the protected job.

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

      Returns:
      The status of the protected job.
      See Also:

    • resultConfiguration

      public final ProtectedJobResultConfigurationOutput resultConfiguration()

      Contains any details needed to write the job results.

      Returns:
      Contains any details needed to write the job results.

    • statistics

      public final ProtectedJobStatistics statistics()

      The statistics of the protected job.

      Returns:
      The statistics of the protected job.

    • result

      public final ProtectedJobResult result()

      The result of the protected job.

      Returns:
      The result of the protected job.

    • error

      public final ProtectedJobError error()

      The error from the protected job.

      Returns:
      The error from the protected job.

    • toBuilder

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

    • builder

      public static ProtectedJob.Builder builder()

    • serializableBuilderClass

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