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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	jobId() Unique Id for the Job.
String	jobReason() Reason for the 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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

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 the Job.

Returns:

Unique Id for the Job.

jobType

public JobType jobType()

Type for the 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.

See Also:

JobType

jobTypeAsString

public String jobTypeAsString()

Type for the 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.

See Also:

JobType

jobReason

public String jobReason()

Reason for the Job.

Returns:

Reason for the 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StartJobRequest.Builder,StartJobRequest>

Specified by:

toBuilder in class AmplifyRequest

Returns:

a builder for type T

builder

public static StartJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.