Class HarvestJob

java.lang.Object
software.amazon.awssdk.services.mediapackage.model.HarvestJob
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HarvestJob.Builder,HarvestJob>
@Generated("software.amazon.awssdk:codegen") public final class HarvestJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HarvestJob.Builder,HarvestJob>
A HarvestJob resource configuration
See Also:

  • Method Details

    • arn

      public final String arn()
      The Amazon Resource Name (ARN) assigned to the HarvestJob.
      Returns:
      The Amazon Resource Name (ARN) assigned to the HarvestJob.

    • channelId

      public final String channelId()
      The ID of the Channel that the HarvestJob will harvest from.
      Returns:
      The ID of the Channel that the HarvestJob will harvest from.

    • createdAt

      public final String createdAt()
      The date and time the HarvestJob was submitted.
      Returns:
      The date and time the HarvestJob was submitted.

    • endTime

      public final String endTime()
      The end of the time-window which will be harvested.
      Returns:
      The end of the time-window which will be harvested.

    • id

      public final String id()
      The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
      Returns:
      The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.

    • originEndpointId

      public final String originEndpointId()
      The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
      Returns:
      The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.

    • s3Destination

      public final S3Destination s3Destination()
      Returns the value of the S3Destination property for this object.
      Returns:
      The value of the S3Destination property for this object.

    • startTime

      public final String startTime()
      The start of the time-window which will be harvested.
      Returns:
      The start of the time-window which will be harvested.

    • status

      public final Status status()
      The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

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

      Returns:
      The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.
      See Also:

    • statusAsString

      public final String statusAsString()
      The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

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

      Returns:
      The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.
      See Also:

    • toBuilder

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

    • builder

      public static HarvestJob.Builder builder()

    • serializableBuilderClass

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