Interface ThirdPartyJobData.Builder

    • Method Detail

      • actionTypeId

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

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

        ThirdPartyJobData.Builder pipelineContext​(PipelineContext pipelineContext)

        Represents information about a pipeline to a job worker.

        Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

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

        Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

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

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

        The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

        Parameters:
        inputArtifacts - The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • inputArtifacts

        ThirdPartyJobData.Builder inputArtifacts​(Artifact... inputArtifacts)

        The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

        Parameters:
        inputArtifacts - The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • inputArtifacts

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

        The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

        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

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

        The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.

        Parameters:
        outputArtifacts - The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • outputArtifacts

        ThirdPartyJobData.Builder outputArtifacts​(Artifact... outputArtifacts)

        The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.

        Parameters:
        outputArtifacts - The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • outputArtifacts

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

        The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.

        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

        ThirdPartyJobData.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 artifact 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 artifact for the pipeline in CodePipeline.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • continuationToken

        ThirdPartyJobData.Builder continuationToken​(String continuationToken)

        A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.

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

        ThirdPartyJobData.Builder encryptionKey​(EncryptionKey encryptionKey)

        The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present.

        Parameters:
        encryptionKey - The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present.
        Returns:
        Returns a reference to this object so that method calls can be chained together.