com.amazonaws.services.elastictranscoder.model.JobOutput
|
Did this page help you?Yes No Tell us about it... |
||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
java.lang.Object
public class JobOutput
A section of the request or response body that provides information about the transcoded (target) file.
| Constructor Summary | |
|---|---|
JobOutput()
|
|
| Method Summary | |
|---|---|
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getKey()
The name to assign to the transcoded file. |
java.lang.String |
getPresetId()
The Id of the preset to use for this job. |
java.lang.String |
getRotate()
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. |
java.lang.String |
getStatus()
Status of the job. |
java.lang.String |
getStatusDetail()
Information that further explains Status. |
java.lang.String |
getThumbnailPattern()
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files. |
int |
hashCode()
|
void |
setKey(java.lang.String key)
The name to assign to the transcoded file. |
void |
setPresetId(java.lang.String presetId)
The Id of the preset to use for this job. |
void |
setRotate(java.lang.String rotate)
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. |
void |
setStatus(java.lang.String status)
Status of the job. |
void |
setStatusDetail(java.lang.String statusDetail)
Information that further explains Status. |
void |
setThumbnailPattern(java.lang.String thumbnailPattern)
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files. |
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and debugging. |
JobOutput |
withKey(java.lang.String key)
The name to assign to the transcoded file. |
JobOutput |
withPresetId(java.lang.String presetId)
The Id of the preset to use for this job. |
JobOutput |
withRotate(java.lang.String rotate)
The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. |
JobOutput |
withStatus(java.lang.String status)
Status of the job. |
JobOutput |
withStatusDetail(java.lang.String statusDetail)
Information that further explains Status. |
JobOutput |
withThumbnailPattern(java.lang.String thumbnailPattern)
Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files. |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public JobOutput()
| Method Detail |
|---|
public java.lang.String getKey()
OutputBucket object in the pipeline that is specified by
the pipeline ID. If a file with the specified name already exists in
the output bucket, the job fails.
Constraints:
Length: 1 - 255
OutputBucket object in the pipeline that is specified by
the pipeline ID. If a file with the specified name already exists in
the output bucket, the job fails.public void setKey(java.lang.String key)
OutputBucket object in the pipeline that is specified by
the pipeline ID. If a file with the specified name already exists in
the output bucket, the job fails.
Constraints:
Length: 1 - 255
key - The name to assign to the transcoded file. Elastic Transcoder saves
the file in the Amazon S3 bucket specified by the
OutputBucket object in the pipeline that is specified by
the pipeline ID. If a file with the specified name already exists in
the output bucket, the job fails.public JobOutput withKey(java.lang.String key)
OutputBucket object in the pipeline that is specified by
the pipeline ID. If a file with the specified name already exists in
the output bucket, the job fails.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
key - The name to assign to the transcoded file. Elastic Transcoder saves
the file in the Amazon S3 bucket specified by the
OutputBucket object in the pipeline that is specified by
the pipeline ID. If a file with the specified name already exists in
the output bucket, the job fails.
public java.lang.String getThumbnailPattern()
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to
create thumbnails, you must include {count} in the
ThumbnailPattern object. Wherever you specify
{count}, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution} but you omit
{count}, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution} and {count}.
{resolution} (Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput. Elastic Transcoder also appends
the applicable file name extension.
Constraints:
Pattern: (^$)|(^.*\{count\}.*$)
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to
create thumbnails, you must include {count} in the
ThumbnailPattern object. Wherever you specify
{count}, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution} but you omit
{count}, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution} and {count}.
{resolution} (Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput. Elastic Transcoder also appends
the applicable file name extension.
public void setThumbnailPattern(java.lang.String thumbnailPattern)
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to
create thumbnails, you must include {count} in the
ThumbnailPattern object. Wherever you specify
{count}, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution} but you omit
{count}, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution} and {count}.
{resolution} (Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput. Elastic Transcoder also appends
the applicable file name extension.
Constraints:
Pattern: (^$)|(^.*\{count\}.*$)
thumbnailPattern - Whether you want Elastic Transcoder to create thumbnails for your
videos and, if so, how you want Elastic Transcoder to name the files.
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to
create thumbnails, you must include {count} in the
ThumbnailPattern object. Wherever you specify
{count}, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution} but you omit
{count}, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution} and {count}.
{resolution} (Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput. Elastic Transcoder also appends
the applicable file name extension.
public JobOutput withThumbnailPattern(java.lang.String thumbnailPattern)
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to
create thumbnails, you must include {count} in the
ThumbnailPattern object. Wherever you specify
{count}, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution} but you omit
{count}, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution} and {count}.
{resolution} (Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput. Elastic Transcoder also appends
the applicable file name extension.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern: (^$)|(^.*\{count\}.*$)
thumbnailPattern - Whether you want Elastic Transcoder to create thumbnails for your
videos and, if so, how you want Elastic Transcoder to name the files.
If you don't want Elastic Transcoder to create thumbnails, specify "".
If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
{count} (Required): If you want to
create thumbnails, you must include {count} in the
ThumbnailPattern object. Wherever you specify
{count}, Elastic Transcoder adds a five-digit sequence
number (beginning with 00001) to thumbnail file names. The
number indicates where a given thumbnail appears in the sequence of
thumbnails for a transcoded file. {resolution} but you omit
{count}, Elastic Transcoder returns a validation error
and does not create the job.
Literal
values (Optional): You can specify literal values anywhere in the
ThumbnailPattern object. For example, you can include
them as a file name prefix or as a delimiter between
{resolution} and {count}.
{resolution} (Optional): If you want Elastic
Transcoder to include the resolution in the file name, include
{resolution} in the ThumbnailPattern object.
When creating thumbnails, Elastic Transcoder
automatically saves the files in the format (.jpg or .png) that
appears in the preset that you specified in the PresetID
value of CreateJobOutput. Elastic Transcoder also appends
the applicable file name extension.
public java.lang.String getRotate()
auto, 0, 90,
180, 270
The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
auto, 0, 90,
180, 270
The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
public void setRotate(java.lang.String rotate)
auto, 0, 90,
180, 270
The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
rotate - The number of degrees clockwise by which you want Elastic Transcoder
to rotate the output relative to the input. Enter one of the following
values: auto, 0, 90,
180, 270
The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
public JobOutput withRotate(java.lang.String rotate)
auto, 0, 90,
180, 270
The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
rotate - The number of degrees clockwise by which you want Elastic Transcoder
to rotate the output relative to the input. Enter one of the following
values: auto, 0, 90,
180, 270
The value auto
generally works only if the file that you're transcoding contains
rotation metadata.
public java.lang.String getPresetId()
Id of the preset to use for this job. The preset
determines the audio, video, and thumbnail settings that Elastic
Transcoder uses for transcoding.
Constraints:
Pattern: ^\d{13}-\w{6}$
Id of the preset to use for this job. The preset
determines the audio, video, and thumbnail settings that Elastic
Transcoder uses for transcoding.public void setPresetId(java.lang.String presetId)
Id of the preset to use for this job. The preset
determines the audio, video, and thumbnail settings that Elastic
Transcoder uses for transcoding.
Constraints:
Pattern: ^\d{13}-\w{6}$
presetId - The Id of the preset to use for this job. The preset
determines the audio, video, and thumbnail settings that Elastic
Transcoder uses for transcoding.public JobOutput withPresetId(java.lang.String presetId)
Id of the preset to use for this job. The preset
determines the audio, video, and thumbnail settings that Elastic
Transcoder uses for transcoding.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern: ^\d{13}-\w{6}$
presetId - The Id of the preset to use for this job. The preset
determines the audio, video, and thumbnail settings that Elastic
Transcoder uses for transcoding.
public java.lang.String getStatus()
Status is one of the
following: Submitted, Progressing,
Completed, Canceled, or Error.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
Status is one of the
following: Submitted, Progressing,
Completed, Canceled, or Error.public void setStatus(java.lang.String status)
Status is one of the
following: Submitted, Progressing,
Completed, Canceled, or Error.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
status - Status of the job. The value of Status is one of the
following: Submitted, Progressing,
Completed, Canceled, or Error.public JobOutput withStatus(java.lang.String status)
Status is one of the
following: Submitted, Progressing,
Completed, Canceled, or Error.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)
status - Status of the job. The value of Status is one of the
following: Submitted, Progressing,
Completed, Canceled, or Error.
public java.lang.String getStatusDetail()
Status.
Constraints:
Length: 0 - 255
Status.public void setStatusDetail(java.lang.String statusDetail)
Status.
Constraints:
Length: 0 - 255
statusDetail - Information that further explains Status.public JobOutput withStatusDetail(java.lang.String statusDetail)
Status.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 255
statusDetail - Information that further explains Status.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object
|
|
||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||