Class PutJobSuccessResultRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest
software.amazon.awssdk.services.codepipeline.model.PutJobSuccessResultRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutJobSuccessResultRequest.Builder,PutJobSuccessResultRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutJobSuccessResultRequest extends CodePipelineRequest implements ToCopyableBuilder<PutJobSuccessResultRequest.Builder,PutJobSuccessResultRequest>

Represents the input of a PutJobSuccessResult action.

  • Method Details

    • jobId

      public final String jobId()

      The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

      Returns:
      The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

    • currentRevision

      public final CurrentRevision currentRevision()

      The ID of the current revision of the artifact successfully worked on by the job.

      Returns:
      The ID of the current revision of the artifact successfully worked on by the job.

    • continuationToken

      public final String continuationToken()

      A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.

      Returns:
      A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.

    • executionDetails

      public final ExecutionDetails executionDetails()

      The execution details of the successful job, such as the actions taken by the job worker.

      Returns:
      The execution details of the successful job, such as the actions taken by the job worker.

    • hasOutputVariables

      public final boolean hasOutputVariables()
      For responses, this returns true if the service returned a value for the OutputVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • outputVariables

      public final Map<String,String> outputVariables()

      Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutputVariables() method.

      Returns:
      Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.

    • toBuilder

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

    • builder

      public static PutJobSuccessResultRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.