/AWS1/CL_MD2CREHARVESTJOBRSP¶
The response object returned after creating a harvest job.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_CHANNELGROUPNAME TYPE /AWS1/MD2RESOURCENAME /AWS1/MD2RESOURCENAME¶
The name of the channel group containing the channel from which content is being harvested.
IV_CHANNELNAME TYPE /AWS1/MD2RESOURCENAME /AWS1/MD2RESOURCENAME¶
The name of the channel from which content is being harvested.
IV_ORIGINENDPOINTNAME TYPE /AWS1/MD2RESOURCENAME /AWS1/MD2RESOURCENAME¶
The name of the origin endpoint from which content is being harvested.
IO_DESTINATION TYPE REF TO /AWS1/CL_MD2DESTINATION /AWS1/CL_MD2DESTINATION¶
The S3 destination where the harvested content will be placed.
IV_HARVESTJOBNAME TYPE /AWS1/MD2RESOURCENAME /AWS1/MD2RESOURCENAME¶
The name of the created harvest job.
IO_HARVESTEDMANIFESTS TYPE REF TO /AWS1/CL_MD2HARVESTEDMANIFESTS /AWS1/CL_MD2HARVESTEDMANIFESTS¶
A list of manifests that will be harvested.
IO_SCHEDULECONFIGURATION TYPE REF TO /AWS1/CL_MD2HARVESTERSCHDCONF /AWS1/CL_MD2HARVESTERSCHDCONF¶
The configuration for when the harvest job will run, including start and end times.
IV_ARN TYPE /AWS1/MD2STRING /AWS1/MD2STRING¶
The Amazon Resource Name (ARN) of the created harvest job.
IV_CREATEDAT TYPE /AWS1/MD2TIMESTAMP /AWS1/MD2TIMESTAMP¶
The date and time the harvest job was created.
IV_MODIFIEDAT TYPE /AWS1/MD2TIMESTAMP /AWS1/MD2TIMESTAMP¶
The date and time the harvest job was last modified.
IV_STATUS TYPE /AWS1/MD2HARVESTJOBSTATUS /AWS1/MD2HARVESTJOBSTATUS¶
The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).
Optional arguments:¶
IV_DESCRIPTION TYPE /AWS1/MD2RESOURCEDESCRIPTION /AWS1/MD2RESOURCEDESCRIPTION¶
The description of the harvest job, if provided.
IV_ERRORMESSAGE TYPE /AWS1/MD2STRING /AWS1/MD2STRING¶
An error message if the harvest job creation failed.
IV_ETAG TYPE /AWS1/MD2ENTITYTAG /AWS1/MD2ENTITYTAG¶
The current version of the harvest job. Used for concurrency control.
IT_TAGS TYPE /AWS1/CL_MD2TAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
A collection of tags associated with the harvest job.
Queryable Attributes¶
ChannelGroupName¶
The name of the channel group containing the channel from which content is being harvested.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANNELGROUPNAME() |
Getter for CHANNELGROUPNAME, with configurable default |
ASK_CHANNELGROUPNAME() |
Getter for CHANNELGROUPNAME w/ exceptions if field has no va |
HAS_CHANNELGROUPNAME() |
Determine if CHANNELGROUPNAME has a value |
ChannelName¶
The name of the channel from which content is being harvested.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANNELNAME() |
Getter for CHANNELNAME, with configurable default |
ASK_CHANNELNAME() |
Getter for CHANNELNAME w/ exceptions if field has no value |
HAS_CHANNELNAME() |
Determine if CHANNELNAME has a value |
OriginEndpointName¶
The name of the origin endpoint from which content is being harvested.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ORIGINENDPOINTNAME() |
Getter for ORIGINENDPOINTNAME, with configurable default |
ASK_ORIGINENDPOINTNAME() |
Getter for ORIGINENDPOINTNAME w/ exceptions if field has no |
HAS_ORIGINENDPOINTNAME() |
Determine if ORIGINENDPOINTNAME has a value |
Destination¶
The S3 destination where the harvested content will be placed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESTINATION() |
Getter for DESTINATION |
HarvestJobName¶
The name of the created harvest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HARVESTJOBNAME() |
Getter for HARVESTJOBNAME, with configurable default |
ASK_HARVESTJOBNAME() |
Getter for HARVESTJOBNAME w/ exceptions if field has no valu |
HAS_HARVESTJOBNAME() |
Determine if HARVESTJOBNAME has a value |
HarvestedManifests¶
A list of manifests that will be harvested.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HARVESTEDMANIFESTS() |
Getter for HARVESTEDMANIFESTS |
Description¶
The description of the harvest job, if provided.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
ScheduleConfiguration¶
The configuration for when the harvest job will run, including start and end times.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULECONFIGURATION() |
Getter for SCHEDULECONFIGURATION |
Arn¶
The Amazon Resource Name (ARN) of the created harvest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
CreatedAt¶
The date and time the harvest job was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
ModifiedAt¶
The date and time the harvest job was last modified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MODIFIEDAT() |
Getter for MODIFIEDAT, with configurable default |
ASK_MODIFIEDAT() |
Getter for MODIFIEDAT w/ exceptions if field has no value |
HAS_MODIFIEDAT() |
Determine if MODIFIEDAT has a value |
Status¶
The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
ErrorMessage¶
An error message if the harvest job creation failed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ERRORMESSAGE() |
Getter for ERRORMESSAGE, with configurable default |
ASK_ERRORMESSAGE() |
Getter for ERRORMESSAGE w/ exceptions if field has no value |
HAS_ERRORMESSAGE() |
Determine if ERRORMESSAGE has a value |
ETag¶
The current version of the harvest job. Used for concurrency control.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ETAG() |
Getter for ETAG, with configurable default |
ASK_ETAG() |
Getter for ETAG w/ exceptions if field has no value |
HAS_ETAG() |
Determine if ETAG has a value |
Tags¶
A collection of tags associated with the harvest job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |