Class ThirdPartyJobData
- java.lang.Object
-
- com.amazonaws.services.codepipeline.model.ThirdPartyJobData
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class ThirdPartyJobData extends Object implements Serializable, Cloneable
Represents information about the job data for a partner action.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ThirdPartyJobData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ThirdPartyJobData
clone()
boolean
equals(Object obj)
ActionConfiguration
getActionConfiguration()
ActionTypeId
getActionTypeId()
AWSSessionCredentials
getArtifactCredentials()
String
getContinuationToken()
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order 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 AWS Key Management Service (AWS KMS) key.List<Artifact>
getInputArtifacts()
The name of the artifact that will be worked upon by the action, if any.List<Artifact>
getOutputArtifacts()
The name of the artifact that will be the result of the action, if any.PipelineContext
getPipelineContext()
int
hashCode()
void
setActionConfiguration(ActionConfiguration actionConfiguration)
void
setActionTypeId(ActionTypeId actionTypeId)
void
setArtifactCredentials(AWSSessionCredentials artifactCredentials)
void
setContinuationToken(String continuationToken)
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order 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 AWS Key Management Service (AWS KMS) key.void
setInputArtifacts(Collection<Artifact> inputArtifacts)
The name of the artifact that will be worked upon by the action, if any.void
setOutputArtifacts(Collection<Artifact> outputArtifacts)
The name of the artifact that will be the result of the action, if any.void
setPipelineContext(PipelineContext pipelineContext)
String
toString()
Returns a string representation of this object; useful for testing and debugging.ThirdPartyJobData
withActionConfiguration(ActionConfiguration actionConfiguration)
ThirdPartyJobData
withActionTypeId(ActionTypeId actionTypeId)
ThirdPartyJobData
withArtifactCredentials(AWSSessionCredentials artifactCredentials)
ThirdPartyJobData
withContinuationToken(String continuationToken)
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order 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 AWS Key Management Service (AWS KMS) key.ThirdPartyJobData
withInputArtifacts(Artifact... inputArtifacts)
The name of the artifact that will be worked upon by the action, if any.ThirdPartyJobData
withInputArtifacts(Collection<Artifact> inputArtifacts)
The name of the artifact that will be worked upon by the action, if any.ThirdPartyJobData
withOutputArtifacts(Artifact... outputArtifacts)
The name of the artifact that will be the result of the action, if any.ThirdPartyJobData
withOutputArtifacts(Collection<Artifact> outputArtifacts)
The name of the artifact that will be the result of the action, if any.ThirdPartyJobData
withPipelineContext(PipelineContext pipelineContext)
-
-
-
Method Detail
-
setActionTypeId
public void setActionTypeId(ActionTypeId actionTypeId)
- Parameters:
actionTypeId
-
-
getActionTypeId
public ActionTypeId getActionTypeId()
- Returns:
-
withActionTypeId
public ThirdPartyJobData withActionTypeId(ActionTypeId actionTypeId)
- Parameters:
actionTypeId
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setActionConfiguration
public void setActionConfiguration(ActionConfiguration actionConfiguration)
- Parameters:
actionConfiguration
-
-
getActionConfiguration
public ActionConfiguration getActionConfiguration()
- Returns:
-
withActionConfiguration
public ThirdPartyJobData withActionConfiguration(ActionConfiguration actionConfiguration)
- Parameters:
actionConfiguration
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPipelineContext
public void setPipelineContext(PipelineContext pipelineContext)
- Parameters:
pipelineContext
-
-
getPipelineContext
public PipelineContext getPipelineContext()
- Returns:
-
withPipelineContext
public ThirdPartyJobData withPipelineContext(PipelineContext pipelineContext)
- Parameters:
pipelineContext
-- 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 will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or 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 will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or 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 will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or 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 will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or 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 will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or 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)
orwithInputArtifacts(java.util.Collection)
if you want to override the existing values.- Parameters:
inputArtifacts
- The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or 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 will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or 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 will be worked upon by the action, if any. This name might be system-generated, such as "MyApp", or 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 will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.
- Returns:
- The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.
-
setOutputArtifacts
public void setOutputArtifacts(Collection<Artifact> outputArtifacts)
The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.
- Parameters:
outputArtifacts
- The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.
-
withOutputArtifacts
public ThirdPartyJobData withOutputArtifacts(Artifact... outputArtifacts)
The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or 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)
orwithOutputArtifacts(java.util.Collection)
if you want to override the existing values.- Parameters:
outputArtifacts
- The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or 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 will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or might be defined by the user when the action is created.
- Parameters:
outputArtifacts
- The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or 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)
- Parameters:
artifactCredentials
-
-
getArtifactCredentials
public AWSSessionCredentials getArtifactCredentials()
- Returns:
-
withArtifactCredentials
public ThirdPartyJobData withArtifactCredentials(AWSSessionCredentials artifactCredentials)
- Parameters:
artifactCredentials
-- 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 AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
- Parameters:
continuationToken
- A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
-
getContinuationToken
public String getContinuationToken()
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
- Returns:
- A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
-
withContinuationToken
public ThirdPartyJobData withContinuationToken(String continuationToken)
A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.
- Parameters:
continuationToken
- A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order 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 AWS Key Management Service (AWS 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 AWS Key Management Service (AWS 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 AWS Key Management Service (AWS 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 AWS Key Management Service (AWS 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 AWS Key Management Service (AWS 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 AWS Key Management Service (AWS 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; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ThirdPartyJobData clone()
-
-