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.

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public StartDeploymentRequest.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<StartDeploymentRequest.Builder,StartDeploymentRequest>
      Specified by:
      toBuilder in class AmplifyRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.