JobData (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 JobData

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobData
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Represents other information about a job required for a job worker to complete the job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobData ()

Constructors
Constructor and Description
`JobData ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`JobData`	`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 deployment ID, required by a job to continue the job asynchronously.
`EncryptionKey`	`getEncryptionKey ()` Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
`List<Artifact>`	`getInputArtifacts ()` The artifact supplied to the job.
`List<Artifact>`	`getOutputArtifacts ()` The output of the job.
`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 deployment ID, required by a job to continue the job asynchronously.
`void`	`setEncryptionKey (EncryptionKey encryptionKey)` Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
`void`	`setInputArtifacts (Collection<Artifact> inputArtifacts)` The artifact supplied to the job.
`void`	`setOutputArtifacts (Collection<Artifact> outputArtifacts)` The output of the job.
`void`	`setPipelineContext (PipelineContext pipelineContext)` Represents information about a pipeline to a job worker.
`String`	`toString ()` Returns a string representation of this object.
`JobData`	`withActionConfiguration (ActionConfiguration actionConfiguration)` Represents information about an action configuration.
`JobData`	`withActionTypeId (ActionTypeId actionTypeId)` Represents information about an action type.
`JobData`	`withArtifactCredentials (AWSSessionCredentials artifactCredentials)` Represents an Amazon Web Services session credentials object.
`JobData`	`withContinuationToken (String continuationToken)` A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.
`JobData`	`withEncryptionKey (EncryptionKey encryptionKey)` Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
`JobData`	`withInputArtifacts (Artifact... inputArtifacts)` The artifact supplied to the job.
`JobData`	`withInputArtifacts (Collection<Artifact> inputArtifacts)` The artifact supplied to the job.
`JobData`	`withOutputArtifacts (Artifact... outputArtifacts)` The output of the job.
`JobData`	`withOutputArtifacts (Collection<Artifact> outputArtifacts)` The output of the job.
`JobData`	`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
  - JobData
```
public JobData()
```
- 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 JobData 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 JobData 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.
    
    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.
  - getPipelineContext
```
public PipelineContext getPipelineContext()
```
    Represents information about a pipeline to a job worker.
    
    Includes pipelineArn and pipelineExecutionId for custom jobs.
    
    Returns:
    
    Represents information about a pipeline to a job worker.
    
    Includes pipelineArn and pipelineExecutionId for custom jobs.
  - withPipelineContext
```
public JobData withPipelineContext(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.
  - getInputArtifacts
```
public List<Artifact> getInputArtifacts()
```
    The artifact supplied to the job.
    
    Returns:
    
    The artifact supplied to the job.
  - setInputArtifacts
```
public void setInputArtifacts(Collection<Artifact> inputArtifacts)
```
    The artifact supplied to the job.
    
    Parameters:
    
    inputArtifacts - The artifact supplied to the job.
  - withInputArtifacts
```
public JobData withInputArtifacts(Artifact... inputArtifacts)
```
    The artifact supplied to the job.
    
    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 artifact supplied to the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInputArtifacts
```
public JobData withInputArtifacts(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.
  - getOutputArtifacts
```
public List<Artifact> getOutputArtifacts()
```
    The output of the job.
    
    Returns:
    
    The output of the job.
  - setOutputArtifacts
```
public void setOutputArtifacts(Collection<Artifact> outputArtifacts)
```
    The output of the job.
    
    Parameters:
    
    outputArtifacts - The output of the job.
  - withOutputArtifacts
```
public JobData withOutputArtifacts(Artifact... outputArtifacts)
```
    The output of the job.
    
    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 output of the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOutputArtifacts
```
public JobData withOutputArtifacts(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.
  - 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 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.
  - 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 artifacts 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 artifacts for the pipeline in CodePipeline.
  - withArtifactCredentials
```
public JobData 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 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.
  - setContinuationToken
```
public void setContinuationToken(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.
  - getContinuationToken
```
public String getContinuationToken()
```
    A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.
    
    Returns:
    
    A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.
  - withContinuationToken
```
public JobData withContinuationToken(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.
  - setEncryptionKey
```
public void setEncryptionKey(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.
  - getEncryptionKey
```
public EncryptionKey getEncryptionKey()
```
    Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
    
    Returns:
    
    Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
  - withEncryptionKey
```
public JobData withEncryptionKey(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.
  - 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 JobData 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 JobData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobData

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