Class HarvestJob

java.lang.Object
software.amazon.awssdk.services.mediapackagev2.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>

Represents a harvest job resource in MediaPackage v2, which is used to export content from an origin endpoint to an S3 bucket.

See Also:

  • Method Details

    • channelGroupName

      public final String channelGroupName()

      The name of the channel group containing the channel associated with this harvest job.

      Returns:
      The name of the channel group containing the channel associated with this harvest job.

    • channelName

      public final String channelName()

      The name of the channel associated with this harvest job.

      Returns:
      The name of the channel associated with this harvest job.

    • originEndpointName

      public final String originEndpointName()

      The name of the origin endpoint associated with this harvest job.

      Returns:
      The name of the origin endpoint associated with this harvest job.

    • destination

      public final Destination destination()

      The S3 destination where the harvested content will be placed.

      Returns:
      The S3 destination where the harvested content will be placed.

    • harvestJobName

      public final String harvestJobName()

      The name of the harvest job.

      Returns:
      The name of the harvest job.

    • harvestedManifests

      public final HarvestedManifests harvestedManifests()

      A list of manifests that are being or have been harvested.

      Returns:
      A list of manifests that are being or have been harvested.

    • description

      public final String description()

      An optional description of the harvest job.

      Returns:
      An optional description of the harvest job.

    • scheduleConfiguration

      public final HarvesterScheduleConfiguration scheduleConfiguration()

      The configuration for when the harvest job is scheduled to run.

      Returns:
      The configuration for when the harvest job is scheduled to run.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the harvest job.

      Returns:
      The Amazon Resource Name (ARN) of the harvest job.

    • createdAt

      public final Instant createdAt()

      The date and time when the harvest job was created.

      Returns:
      The date and time when the harvest job was created.

    • modifiedAt

      public final Instant modifiedAt()

      The date and time when the harvest job was last modified.

      Returns:
      The date and time when the harvest job was last modified.

    • status

      public final HarvestJobStatus status()

      The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).

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

      Returns:
      The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).

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

      Returns:
      The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).
      See Also:

    • errorMessage

      public final String errorMessage()

      An error message if the harvest job encountered any issues.

      Returns:
      An error message if the harvest job encountered any issues.

    • eTag

      public final String eTag()

      The current version of the harvest job. Used for concurrency control.

      Returns:
      The current version of the harvest job. Used for concurrency control.

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