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.

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

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

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