Package software.amazon.awssdk.services.mediapackage.model

Class DescribeHarvestJobResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.mediapackage.model.MediaPackageResponse

software.amazon.awssdk.services.mediapackage.model.DescribeHarvestJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeHarvestJobResponse.Builder,DescribeHarvestJobResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeHarvestJobResponse
extends MediaPackageResponse
implements ToCopyableBuilder<DescribeHarvestJobResponse.Builder,DescribeHarvestJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeHarvestJobResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) assigned to the HarvestJob.
static DescribeHarvestJobResponse.Builder	builder()
String	channelId()	The ID of the Channel that the HarvestJob will harvest from.
String	createdAt()	The date and time the HarvestJob was submitted.
String	endTime()	The end of the time-window which will be harvested.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID of the HarvestJob.
String	originEndpointId()	The ID of the OriginEndpoint that the HarvestJob will harvest from.
S3Destination	s3Destination()	Returns the value of the S3Destination property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeHarvestJobResponse.Builder>	serializableBuilderClass()
String	startTime()	The start of the time-window which will be harvested.
Status	status()	The current status of the HarvestJob.
String	statusAsString()	The current status of the HarvestJob.
DescribeHarvestJobResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.mediapackage.model.MediaPackageResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

The Amazon Resource Name (ARN) assigned to the HarvestJob.

Returns:

The Amazon Resource Name (ARN) assigned to the HarvestJob.

channelId

public final String channelId()

The ID of the Channel that the HarvestJob will harvest from.

Returns:

The ID of the Channel that the HarvestJob will harvest from.

createdAt

public final String createdAt()

The date and time the HarvestJob was submitted.

Returns:

The date and time the HarvestJob was submitted.

endTime

public final String endTime()

The end of the time-window which will be harvested.

Returns:

The end of the time-window which will be harvested.

id

public final String id()

The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.

Returns:

The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.

originEndpointId

public final String originEndpointId()

The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.

Returns:

The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.

s3Destination

public final S3Destination s3Destination()

Returns the value of the S3Destination property for this object.

Returns:

The value of the S3Destination property for this object.

startTime

public final String startTime()

The start of the time-window which will be harvested.

Returns:

The start of the time-window which will be harvested.

status

public final Status status()

The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

See Also:

Status

statusAsString

public final String statusAsString()

The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

See Also:

Status

toBuilder

public DescribeHarvestJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeHarvestJobResponse.Builder,DescribeHarvestJobResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeHarvestJobResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo