Interface JobData.Builder

    • Method Detail

      • actionTypeId

        JobData.Builder actionTypeId​(ActionTypeId actionTypeId)

        Represents information about an action type.

        Parameters:
        actionTypeId - Represents information about an action type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • actionConfiguration

        JobData.Builder actionConfiguration​(ActionConfiguration actionConfiguration)

        Represents information about an action configuration.

        Parameters:
        actionConfiguration - Represents information about an action configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • pipelineContext

        JobData.Builder pipelineContext​(PipelineContext pipelineContext)

        Represents information about a pipeline to a job worker.

        Includes pipelineArn and pipelineExecutionId for custom jobs.

        Parameters:
        pipelineContext - Represents information about a pipeline to a job worker.

        Includes pipelineArn and pipelineExecutionId for custom jobs.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • inputArtifacts

        JobData.Builder inputArtifacts​(Collection<Artifact> inputArtifacts)

        The artifact supplied to the job.

        Parameters:
        inputArtifacts - The artifact supplied to the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • inputArtifacts

        JobData.Builder inputArtifacts​(Artifact... inputArtifacts)

        The artifact supplied to the job.

        Parameters:
        inputArtifacts - The artifact supplied to the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • inputArtifacts

        JobData.Builder inputArtifacts​(Consumer<Artifact.Builder>... inputArtifacts)

        The artifact supplied to the job.

        This is a convenience method that creates an instance of the Artifact.Builder avoiding the need to create one manually via Artifact.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #inputArtifacts(List).

        Parameters:
        inputArtifacts - a consumer that will call methods on Artifact.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #inputArtifacts(java.util.Collection)
      • outputArtifacts

        JobData.Builder outputArtifacts​(Collection<Artifact> outputArtifacts)

        The output of the job.

        Parameters:
        outputArtifacts - The output of the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • outputArtifacts

        JobData.Builder outputArtifacts​(Artifact... outputArtifacts)

        The output of the job.

        Parameters:
        outputArtifacts - The output of the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • outputArtifacts

        JobData.Builder outputArtifacts​(Consumer<Artifact.Builder>... outputArtifacts)

        The output of the job.

        This is a convenience method that creates an instance of the Artifact.Builder avoiding the need to create one manually via Artifact.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #outputArtifacts(List).

        Parameters:
        outputArtifacts - a consumer that will call methods on Artifact.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #outputArtifacts(java.util.Collection)
      • artifactCredentials

        JobData.Builder artifactCredentials​(AWSSessionCredentials artifactCredentials)

        Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in CodePipeline.

        Parameters:
        artifactCredentials - Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in CodePipeline.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • continuationToken

        JobData.Builder continuationToken​(String continuationToken)

        A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.

        Parameters:
        continuationToken - A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • encryptionKey

        JobData.Builder encryptionKey​(EncryptionKey encryptionKey)

        Represents information about the key used to encrypt data in the artifact store, such as an KMS key.

        Parameters:
        encryptionKey - Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.