Class CreateHarvestJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.mediapackagev2.model.MediaPackageV2Response
software.amazon.awssdk.services.mediapackagev2.model.CreateHarvestJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateHarvestJobResponse.Builder,CreateHarvestJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateHarvestJobResponse extends MediaPackageV2Response implements ToCopyableBuilder<CreateHarvestJobResponse.Builder,CreateHarvestJobResponse>

The response object returned after creating a harvest job.

  • Method Details

    • channelGroupName

      public final String channelGroupName()

      The name of the channel group containing the channel from which content is being harvested.

      Returns:
      The name of the channel group containing the channel from which content is being harvested.

    • channelName

      public final String channelName()

      The name of the channel from which content is being harvested.

      Returns:
      The name of the channel from which content is being harvested.

    • originEndpointName

      public final String originEndpointName()

      The name of the origin endpoint from which content is being harvested.

      Returns:
      The name of the origin endpoint from which content is being harvested.

    • 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 created harvest job.

      Returns:
      The name of the created harvest job.

    • harvestedManifests

      public final HarvestedManifests harvestedManifests()

      A list of manifests that will be harvested.

      Returns:
      A list of manifests that will be harvested.

    • description

      public final String description()

      The description of the harvest job, if provided.

      Returns:
      The description of the harvest job, if provided.

    • scheduleConfiguration

      public final HarvesterScheduleConfiguration scheduleConfiguration()

      The configuration for when the harvest job will run, including start and end times.

      Returns:
      The configuration for when the harvest job will run, including start and end times.

    • arn

      public final String arn()

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

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

    • createdAt

      public final Instant createdAt()

      The date and time the harvest job was created.

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

    • modifiedAt

      public final Instant modifiedAt()

      The date and time the harvest job was last modified.

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

    • status

      public final HarvestJobStatus status()

      The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, 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., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, 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., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).
      See Also:

    • errorMessage

      public final String errorMessage()

      An error message if the harvest job creation failed.

      Returns:
      An error message if the harvest job creation failed.

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      A collection of tags associated with the harvest job.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A collection of tags associated with the harvest job.

    • toBuilder

      public CreateHarvestJobResponse.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<CreateHarvestJobResponse.Builder,CreateHarvestJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateHarvestJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateHarvestJobResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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