Package software.amazon.awssdk.services.amplify.model

Class JobSummary

java.lang.Object

software.amazon.awssdk.services.amplify.model.JobSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobSummary.Builder,JobSummary>

@Generated("software.amazon.awssdk:codegen")
public final class JobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobSummary.Builder,JobSummary>

Describes the summary for an execution job for an Amplify app.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JobSummary.Builder

Method Summary

Modifier and Type	Method	Description
static JobSummary.Builder	builder()
String	commitId()	The commit ID from a third-party repository provider for the job.
String	commitMessage()	The commit message from a third-party repository provider for the job.
Instant	commitTime()	The commit date and time for the job.
Instant	endTime()	The end date and time for the job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobArn()	The Amazon Resource Name (ARN) for the job.
String	jobId()	The unique ID for the job.
JobType	jobType()	The type for the job.
String	jobTypeAsString()	The type for the job.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends JobSummary.Builder>	serializableBuilderClass()
String	sourceUrl()	The source URL for the files to deploy.
SourceUrlType	sourceUrlType()	The type of source specified by the sourceURL.
String	sourceUrlTypeAsString()	The type of source specified by the sourceURL.
Instant	startTime()	The start date and time for the job.
JobStatus	status()	The current status for the job.
String	statusAsString()	The current status for the job.
JobSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

jobArn

public final String jobArn()

The Amazon Resource Name (ARN) for the job.

Returns:

The Amazon Resource Name (ARN) for the job.

jobId

public final String jobId()

The unique ID for the job.

Returns:

The unique ID for the job.

commitId

public final String commitId()

The commit ID from a third-party repository provider for the job.

Returns:

The commit ID from a third-party repository provider for the job.

commitMessage

public final String commitMessage()

The commit message from a third-party repository provider for the job.

Returns:

The commit message from a third-party repository provider for the job.

commitTime

public final Instant commitTime()

The commit date and time for the job.

Returns:

The commit date and time for the job.

startTime

public final Instant startTime()

The start date and time for the job.

Returns:

The start date and time for the job.

status

public final JobStatus status()

The current status for the job.

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

Returns:

The current status for the job.

See Also:

JobStatus

statusAsString

public final String statusAsString()

The current status for the job.

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

Returns:

The current status for the job.

See Also:

JobStatus

endTime

public final Instant endTime()

The end date and time for the job.

Returns:

The end date and time for the job.

jobType

public final JobType jobType()

The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.

If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.

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

Returns:

The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.

If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.

See Also:

JobType

jobTypeAsString

public final String jobTypeAsString()

The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.

If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.

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

Returns:

The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.

If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.

See Also:

JobType

sourceUrl

public final String sourceUrl()

The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.

Returns:

The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.

sourceUrlType

public final SourceUrlType sourceUrlType()

The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.

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

Returns:

The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.

See Also:

SourceUrlType

sourceUrlTypeAsString

public final String sourceUrlTypeAsString()

The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.

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

Returns:

The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.

See Also:

SourceUrlType

toBuilder

public JobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobSummary.Builder,JobSummary>

builder

public static JobSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo