ThirdPartyJobData (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.codepipeline.model

Class ThirdPartyJobData

java.lang.Object
- com.amazonaws.services.codepipeline.model.ThirdPartyJobData

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ThirdPartyJobData
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Represents information about the job data for a partner action.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ThirdPartyJobData ()

Constructors
Constructor and Description
`ThirdPartyJobData ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`ThirdPartyJobData`	`clone ()`
`boolean`	`equals (Object obj)`
`ActionConfiguration`	`getActionConfiguration ()` Represents information about an action configuration.
`ActionTypeId`	`getActionTypeId ()` Represents information about an action type.
`AWSSessionCredentials`	`getArtifactCredentials ()` Represents an Amazon Web Services session credentials object.
`String`	`getContinuationToken ()` A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
`EncryptionKey`	`getEncryptionKey ()` 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.
`List<Artifact>`	`getInputArtifacts ()` The name of the artifact that is worked on by the action, if any.
`List<Artifact>`	`getOutputArtifacts ()` The name of the artifact that is the result of the action, if any.
`PipelineContext`	`getPipelineContext ()` Represents information about a pipeline to a job worker.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActionConfiguration (ActionConfiguration actionConfiguration)` Represents information about an action configuration.
`void`	`setActionTypeId (ActionTypeId actionTypeId)` Represents information about an action type.
`void`	`setArtifactCredentials (AWSSessionCredentials artifactCredentials)` Represents an Amazon Web Services session credentials object.
`void`	`setContinuationToken (String continuationToken)` A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
`void`	`setEncryptionKey (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.
`void`	`setInputArtifacts (Collection<Artifact> inputArtifacts)` The name of the artifact that is worked on by the action, if any.
`void`	`setOutputArtifacts (Collection<Artifact> outputArtifacts)` The name of the artifact that is the result of the action, if any.
`void`	`setPipelineContext (PipelineContext pipelineContext)` Represents information about a pipeline to a job worker.
`String`	`toString ()` Returns a string representation of this object.
`ThirdPartyJobData`	`withActionConfiguration (ActionConfiguration actionConfiguration)` Represents information about an action configuration.
`ThirdPartyJobData`	`withActionTypeId (ActionTypeId actionTypeId)` Represents information about an action type.
`ThirdPartyJobData`	`withArtifactCredentials (AWSSessionCredentials artifactCredentials)` Represents an Amazon Web Services session credentials object.
`ThirdPartyJobData`	`withContinuationToken (String continuationToken)` A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
`ThirdPartyJobData`	`withEncryptionKey (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.
`ThirdPartyJobData`	`withInputArtifacts (Artifact... inputArtifacts)` The name of the artifact that is worked on by the action, if any.
`ThirdPartyJobData`	`withInputArtifacts (Collection<Artifact> inputArtifacts)` The name of the artifact that is worked on by the action, if any.
`ThirdPartyJobData`	`withOutputArtifacts (Artifact... outputArtifacts)` The name of the artifact that is the result of the action, if any.
`ThirdPartyJobData`	`withOutputArtifacts (Collection<Artifact> outputArtifacts)` The name of the artifact that is the result of the action, if any.
`ThirdPartyJobData`	`withPipelineContext (PipelineContext pipelineContext)` Represents information about a pipeline to a job worker.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ThirdPartyJobData
```
public ThirdPartyJobData()
```
- Method Detail
  - setActionTypeId
```
public void setActionTypeId(ActionTypeId actionTypeId)
```
    Represents information about an action type.
    
    Parameters:
    
    actionTypeId - Represents information about an action type.
  - getActionTypeId
```
public ActionTypeId getActionTypeId()
```
    Represents information about an action type.
    
    Returns:
    
    Represents information about an action type.
  - withActionTypeId
```
public ThirdPartyJobData withActionTypeId(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.
  - setActionConfiguration
```
public void setActionConfiguration(ActionConfiguration actionConfiguration)
```
    Represents information about an action configuration.
    
    Parameters:
    
    actionConfiguration - Represents information about an action configuration.
  - getActionConfiguration
```
public ActionConfiguration getActionConfiguration()
```
    Represents information about an action configuration.
    
    Returns:
    
    Represents information about an action configuration.
  - withActionConfiguration
```
public ThirdPartyJobData withActionConfiguration(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.
  - setPipelineContext
```
public void setPipelineContext(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.
  - getPipelineContext
```
public PipelineContext getPipelineContext()
```
    Represents information about a pipeline to a job worker.
    
    Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
    
    Returns:
    
    Represents information about a pipeline to a job worker.
    
    Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
  - withPipelineContext
```
public ThirdPartyJobData withPipelineContext(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.
  - getInputArtifacts
```
public List<Artifact> getInputArtifacts()
```
    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:
    
    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.
  - setInputArtifacts
```
public void setInputArtifacts(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.
  - withInputArtifacts
```
public ThirdPartyJobData withInputArtifacts(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setInputArtifacts(java.util.Collection) or withInputArtifacts(java.util.Collection) if you want to override the existing values.
    
    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.
  - withInputArtifacts
```
public ThirdPartyJobData withInputArtifacts(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.
  - getOutputArtifacts
```
public List<Artifact> getOutputArtifacts()
```
    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:
    
    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.
  - setOutputArtifacts
```
public void setOutputArtifacts(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.
  - withOutputArtifacts
```
public ThirdPartyJobData withOutputArtifacts(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setOutputArtifacts(java.util.Collection) or withOutputArtifacts(java.util.Collection) if you want to override the existing values.
    
    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.
  - withOutputArtifacts
```
public ThirdPartyJobData withOutputArtifacts(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.
  - setArtifactCredentials
```
public void setArtifactCredentials(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.
  - getArtifactCredentials
```
public AWSSessionCredentials getArtifactCredentials()
```
    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:
    
    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.
  - withArtifactCredentials
```
public ThirdPartyJobData withArtifactCredentials(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.
  - setContinuationToken
```
public void setContinuationToken(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.
  - getContinuationToken
```
public String getContinuationToken()
```
    A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
    
    Returns:
    
    A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
  - withContinuationToken
```
public ThirdPartyJobData withContinuationToken(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.
  - setEncryptionKey
```
public void setEncryptionKey(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.
  - getEncryptionKey
```
public EncryptionKey getEncryptionKey()
```
    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:
    
    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.
  - withEncryptionKey
```
public ThirdPartyJobData withEncryptionKey(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ThirdPartyJobData clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class ThirdPartyJobData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThirdPartyJobData

Method Detail

setActionTypeId

getActionTypeId

withActionTypeId

setActionConfiguration

getActionConfiguration

withActionConfiguration

setPipelineContext

getPipelineContext

withPipelineContext

getInputArtifacts

setInputArtifacts

withInputArtifacts

withInputArtifacts

getOutputArtifacts

setOutputArtifacts

withOutputArtifacts

withOutputArtifacts

setArtifactCredentials

getArtifactCredentials

withArtifactCredentials

setContinuationToken

getContinuationToken

withContinuationToken

setEncryptionKey

getEncryptionKey

withEncryptionKey

toString

equals

hashCode

clone

marshall