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

Class StartDeploymentRequest

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.StartDeploymentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartDeploymentRequest.Builder,StartDeploymentRequest>

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

The request structure for the start a deployment request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartDeploymentRequest.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 deployment job.
static StartDeploymentRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId()	The job ID for this deployment that is generated by the CreateDeployment request.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartDeploymentRequest.Builder>	serializableBuilderClass()
String	sourceUrl()	The source URL for the deployment that is used when calling StartDeployment without CreateDeployment.
SourceUrlType	sourceUrlType()	The type of source specified by the sourceURL.
String	sourceUrlTypeAsString()	The type of source specified by the sourceURL.
StartDeploymentRequest.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 deployment job.

Returns:

The name of the branch to use for the deployment job.

jobId

public final String jobId()

The job ID for this deployment that is generated by the CreateDeployment request.

Returns:

The job ID for this deployment that is generated by the CreateDeployment request.

sourceUrl

public final String sourceUrl()

The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. 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 deployment that is used when calling StartDeployment without CreateDeployment. 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 StartDeploymentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartDeploymentRequest.Builder,StartDeploymentRequest>

Specified by:

toBuilder in class AmplifyRequest

builder

public static StartDeploymentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartDeploymentRequest.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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo