Struct CreateHarvestJobInput

#[non_exhaustive]
pub struct CreateHarvestJobInput {
    pub channel_group_name: Option<String>,
    pub channel_name: Option<String>,
    pub origin_endpoint_name: Option<String>,
    pub description: Option<String>,
    pub harvested_manifests: Option<HarvestedManifests>,
    pub schedule_configuration: Option<HarvesterScheduleConfiguration>,
    pub destination: Option<Destination>,
    pub client_token: Option<String>,
    pub harvest_job_name: Option<String>,
    pub tags: Option<HashMap<String, String>>,
}

The request object for creating a new harvest job.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

channel_group_name: Option<String>

The name of the channel group containing the channel from which to harvest content.

channel_name: Option<String>

The name of the channel from which to harvest content.

origin_endpoint_name: Option<String>

The name of the origin endpoint from which to harvest content.

description: Option<String>

An optional description for the harvest job.

harvested_manifests: Option<HarvestedManifests>

A list of manifests to be harvested.

schedule_configuration: Option<HarvesterScheduleConfiguration>

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

destination: Option<Destination>

The S3 destination where the harvested content will be placed.

client_token: Option<String>

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

harvest_job_name: Option<String>

A name for the harvest job. This name must be unique within the channel.

tags: Option<HashMap<String, String>>

A collection of tags associated with the harvest job.

Implementations

impl CreateHarvestJobInput

pub fn channel_group_name(&self) -> Option<&str>

The name of the channel group containing the channel from which to harvest content.

pub fn channel_name(&self) -> Option<&str>

The name of the channel from which to harvest content.

pub fn origin_endpoint_name(&self) -> Option<&str>

The name of the origin endpoint from which to harvest content.

pub fn description(&self) -> Option<&str>

An optional description for the harvest job.

pub fn harvested_manifests(&self) -> Option<&HarvestedManifests>

A list of manifests to be harvested.

pub fn schedule_configuration(&self) -> Option<&HarvesterScheduleConfiguration>

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

pub fn destination(&self) -> Option<&Destination>

The S3 destination where the harvested content will be placed.

pub fn client_token(&self) -> Option<&str>

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

pub fn harvest_job_name(&self) -> Option<&str>

A name for the harvest job. This name must be unique within the channel.

pub fn tags(&self) -> Option<&HashMap<String, String>>

A collection of tags associated with the harvest job.

impl CreateHarvestJobInput

pub fn builder() -> CreateHarvestJobInputBuilder

Creates a new builder-style object to manufacture CreateHarvestJobInput.

Trait Implementations

impl Clone for CreateHarvestJobInput

fn clone(&self) -> CreateHarvestJobInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateHarvestJobInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateHarvestJobInput

fn eq(&self, other: &CreateHarvestJobInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateHarvestJobInput