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

Class StartJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.amplify.model.AmplifyRequest

software.amazon.awssdk.services.amplify.model.StartJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartJobRequest.Builder,StartJobRequest>

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

The request structure for the start job request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	appId()	The unique ID for an Amplify app.
String	branchName()	The name of the branch to use for the job.
static StartJobRequest.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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId()	The unique ID for an existing job.
String	jobReason()	A descriptive reason for starting the job.
JobType	jobType()	Describes the type for the job.
String	jobTypeAsString()	Describes the type for the job.
List<SdkField<?>>	sdkFields()
static Class<? extends StartJobRequest.Builder>	serializableBuilderClass()
StartJobRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

appId

public final String appId()

The unique ID for an Amplify app.

Returns:

The unique ID for an Amplify app.

branchName

public final String branchName()

The name of the branch to use for the job.

Returns:

The name of the branch to use for the job.

jobId

public final String jobId()

The unique ID for an existing job. This is required if the value of jobType is RETRY.

Returns:

The unique ID for an existing job. This is required if the value of jobType is RETRY.

jobType

public final JobType jobType()

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.

The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

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:

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.

The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

See Also:

JobType

jobTypeAsString

public final String jobTypeAsString()

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.

The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

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:

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.

The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.

See Also:

JobType

jobReason

public final String jobReason()

A descriptive reason for starting the job.

Returns:

A descriptive reason for starting 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.

toBuilder

public StartJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartJobRequest.Builder,StartJobRequest>

Specified by:

toBuilder in class AmplifyRequest

builder

public static StartJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo