Class: Aws::MediaPackageV2::Types::ListHarvestJobsRequest

Inherits:

Struct

• Object
• Struct
• Aws::MediaPackageV2::Types::ListHarvestJobsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-mediapackagev2/types.rb

Overview

The request object for listing harvest jobs.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_group_name ⇒ String

  The name of the channel group to filter the harvest jobs by.

• #channel_name ⇒ String

  The name of the channel to filter the harvest jobs by.

• #max_results ⇒ Integer

  The maximum number of harvest jobs to return in a single request.

• #next_token ⇒ String

  A token used for pagination.

• #origin_endpoint_name ⇒ String

  The name of the origin endpoint to filter the harvest jobs by.

• #status ⇒ String

  The status to filter the harvest jobs by.

Instance Attribute Details

#channel_group_name ⇒ String

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:

• (String)

# File 'lib/aws-sdk-mediapackagev2/types.rb', line 2537

class ListHarvestJobsRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#channel_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-mediapackagev2/types.rb', line 2537

class ListHarvestJobsRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-mediapackagev2/types.rb', line 2537

class ListHarvestJobsRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-mediapackagev2/types.rb', line 2537

class ListHarvestJobsRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#origin_endpoint_name ⇒ String

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:

• (String)

# File 'lib/aws-sdk-mediapackagev2/types.rb', line 2537

class ListHarvestJobsRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-mediapackagev2/types.rb', line 2537

class ListHarvestJobsRequest < Struct.new(
  :channel_group_name,
  :channel_name,
  :origin_endpoint_name,
  :status,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end