Class ListHarvestJobsRequest

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

The request object for listing harvest jobs.

  • Method Details

    • channelGroupName

      public final String channelGroupName()

      The name of the channel group to filter the harvest jobs by. If specified, only harvest jobs associated with channels in this group will be returned.

      Returns:
      The name of the channel group to filter the harvest jobs by. If specified, only harvest jobs associated with channels in this group will be returned.

    • channelName

      public final String channelName()

      The name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned.

      Returns:
      The name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned.

    • originEndpointName

      public final String originEndpointName()

      The name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned.

      Returns:
      The name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned.

    • status

      public final HarvestJobStatus status()

      The status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.

      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 status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.

      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 status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of harvest jobs to return in a single request. If not specified, a default value will be used.

      Returns:
      The maximum number of harvest jobs to return in a single request. If not specified, a default value will be used.

    • nextToken

      public final String nextToken()

      A token used for pagination. Provide this value in subsequent requests to retrieve the next set of results.

      Returns:
      A token used for pagination. Provide this value in subsequent requests to retrieve the next set of results.

    • toBuilder

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

    • builder

      public static ListHarvestJobsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.