software.amazon.awssdk.services.codepipeline.model

Class JobData

java.lang.Object

software.amazon.awssdk.services.codepipeline.model.JobData

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobData.Builder,JobData>

@Generated(value="software.amazon.awssdk:codegen")
public final class JobData
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobData.Builder,JobData>

Represents other information about a job required for a job worker to complete the job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobData.Builder

Method Summary

Modifier and Type	Method and Description
ActionConfiguration	actionConfiguration() Represents information about an action configuration.
ActionTypeId	actionTypeId() Represents information about an action type.
AWSSessionCredentials	artifactCredentials() Represents an AWS session credentials object.
static JobData.Builder	builder()
String	continuationToken() A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.
EncryptionKey	encryptionKey() Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputArtifacts() For responses, this returns true if the service returned a value for the InputArtifacts property.
boolean	hasOutputArtifacts() For responses, this returns true if the service returned a value for the OutputArtifacts property.
List<Artifact>	inputArtifacts() The artifact supplied to the job.
List<Artifact>	outputArtifacts() The output of the job.
PipelineContext	pipelineContext() Represents information about a pipeline to a job worker.
List<SdkField<?>>	sdkFields()
static Class<? extends JobData.Builder>	serializableBuilderClass()
JobData.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

actionTypeId

public final ActionTypeId actionTypeId()

Represents information about an action type.

Returns:

Represents information about an action type.

actionConfiguration

public final ActionConfiguration actionConfiguration()

Represents information about an action configuration.

Returns:

Represents information about an action configuration.

pipelineContext

public final PipelineContext pipelineContext()

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.

hasInputArtifacts

public final boolean hasInputArtifacts()

For responses, this returns true if the service returned a value for the InputArtifacts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

inputArtifacts

public final List<Artifact> inputArtifacts()

The artifact supplied to the job.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInputArtifacts() method.

Returns:

The artifact supplied to the job.

hasOutputArtifacts

public final boolean hasOutputArtifacts()

For responses, this returns true if the service returned a value for the OutputArtifacts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

outputArtifacts

public final List<Artifact> outputArtifacts()

The output of the job.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutputArtifacts() method.

Returns:

The output of the job.

artifactCredentials

public final AWSSessionCredentials artifactCredentials()

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS 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 AWS CodePipeline.

Returns:

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS 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 AWS CodePipeline.

continuationToken

public final String continuationToken()

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

Returns:

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

encryptionKey

public final EncryptionKey encryptionKey()

Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

Returns:

Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

toBuilder

public JobData.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobData.Builder,JobData>

builder

public static JobData.Builder builder()

serializableBuilderClass

public static Class<? extends JobData.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo