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(value="software.amazon.awssdk:codegen")
public final class StartJobRequest
extends AmplifyRequest
implements ToCopyableBuilder<StartJobRequest.Builder,StartJobRequest>

Request structure for Start job request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	appId() Unique Id for an Amplify App.
String	branchName() Name for the branch, for the Job.
static StartJobRequest.Builder	builder()
String	commitId() Commit Id from 3rd party repository provider for the Job.
String	commitMessage() Commit message from 3rd party repository provider for the Job.
Instant	commitTime() Commit date / 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() Unique Id for an existing job.
String	jobReason() Descriptive reason for starting this job.
JobType	jobType() Type for the Job.
String	jobTypeAsString() 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 String appId()

Unique Id for an Amplify App.

Returns:

Unique Id for an Amplify App.

branchName

public String branchName()

Name for the branch, for the Job.

Returns:

Name for the branch, for the Job.

jobId

public String jobId()

Unique Id for an existing job. Required for "RETRY" JobType.

Returns:

Unique Id for an existing job. Required for "RETRY" JobType.

jobType

public JobType jobType()

Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

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:

Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

See Also:

JobType

jobTypeAsString

public String jobTypeAsString()

Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

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:

Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.

See Also:

JobType

jobReason

public String jobReason()

Descriptive reason for starting this job.

Returns:

Descriptive reason for starting this job.

commitId

public String commitId()

Commit Id from 3rd party repository provider for the Job.

Returns:

Commit Id from 3rd party repository provider for the Job.

commitMessage

public String commitMessage()

Commit message from 3rd party repository provider for the Job.

Returns:

Commit message from 3rd party repository provider for the Job.

commitTime

public Instant commitTime()

Commit date / time for the Job.

Returns:

Commit date / 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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo