Package software.amazon.awssdk.services.codepipeline.model

Class ThirdPartyJobData

java.lang.Object
software.amazon.awssdk.services.codepipeline.model.ThirdPartyJobData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ThirdPartyJobData.Builder,ThirdPartyJobData>
@Generated("software.amazon.awssdk:codegen") public final class ThirdPartyJobData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ThirdPartyJobData.Builder,ThirdPartyJobData>

Represents information about the job data for a partner action.

See Also:

  • Method Details

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

      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.

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

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

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

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

    • artifactCredentials

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

      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.

    • continuationToken

      public final String continuationToken()

      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.

    • encryptionKey

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

      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.

    • toBuilder

      public ThirdPartyJobData.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ThirdPartyJobData.Builder,ThirdPartyJobData>
      Returns:
      a builder for type T

    • builder

      public static ThirdPartyJobData.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ThirdPartyJobData.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.