Class BatchJobIdentifier

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

Identifies a specific batch job.

See Also:

  • Method Details

    • fileBatchJobIdentifier

      public final FileBatchJobIdentifier fileBatchJobIdentifier()

      Specifies a file associated with a specific batch job.

      Returns:
      Specifies a file associated with a specific batch job.

    • restartBatchJobIdentifier

      public final RestartBatchJobIdentifier restartBatchJobIdentifier()

      Specifies the required information for restart, including executionId and JobStepRestartMarker.

      Returns:
      Specifies the required information for restart, including executionId and JobStepRestartMarker.

    • s3BatchJobIdentifier

      public final S3BatchJobIdentifier s3BatchJobIdentifier()

      Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.

      Returns:
      Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.

    • scriptBatchJobIdentifier

      public final ScriptBatchJobIdentifier scriptBatchJobIdentifier()

      A batch job identifier in which the batch job to run is identified by the script name.

      Returns:
      A batch job identifier in which the batch job to run is identified by the script name.

    • toBuilder

      public BatchJobIdentifier.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<BatchJobIdentifier.Builder,BatchJobIdentifier>
      Returns:
      a builder for type T

    • builder

      public static BatchJobIdentifier.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BatchJobIdentifier.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)

    • fromFileBatchJobIdentifier

      public static BatchJobIdentifier fromFileBatchJobIdentifier(FileBatchJobIdentifier fileBatchJobIdentifier)
      Create an instance of this class with fileBatchJobIdentifier() initialized to the given value.

      Specifies a file associated with a specific batch job.

      Parameters:
      fileBatchJobIdentifier - Specifies a file associated with a specific batch job.

    • fromFileBatchJobIdentifier

      public static BatchJobIdentifier fromFileBatchJobIdentifier(Consumer<FileBatchJobIdentifier.Builder> fileBatchJobIdentifier)
      Create an instance of this class with fileBatchJobIdentifier() initialized to the given value.

      Specifies a file associated with a specific batch job.

      Parameters:
      fileBatchJobIdentifier - Specifies a file associated with a specific batch job.

    • fromRestartBatchJobIdentifier

      public static BatchJobIdentifier fromRestartBatchJobIdentifier(RestartBatchJobIdentifier restartBatchJobIdentifier)
      Create an instance of this class with restartBatchJobIdentifier() initialized to the given value.

      Specifies the required information for restart, including executionId and JobStepRestartMarker.

      Parameters:
      restartBatchJobIdentifier - Specifies the required information for restart, including executionId and JobStepRestartMarker.

    • fromRestartBatchJobIdentifier

      public static BatchJobIdentifier fromRestartBatchJobIdentifier(Consumer<RestartBatchJobIdentifier.Builder> restartBatchJobIdentifier)
      Create an instance of this class with restartBatchJobIdentifier() initialized to the given value.

      Specifies the required information for restart, including executionId and JobStepRestartMarker.

      Parameters:
      restartBatchJobIdentifier - Specifies the required information for restart, including executionId and JobStepRestartMarker.

    • fromS3BatchJobIdentifier

      public static BatchJobIdentifier fromS3BatchJobIdentifier(S3BatchJobIdentifier s3BatchJobIdentifier)
      Create an instance of this class with s3BatchJobIdentifier() initialized to the given value.

      Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.

      Parameters:
      s3BatchJobIdentifier - Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.

    • fromS3BatchJobIdentifier

      public static BatchJobIdentifier fromS3BatchJobIdentifier(Consumer<S3BatchJobIdentifier.Builder> s3BatchJobIdentifier)
      Create an instance of this class with s3BatchJobIdentifier() initialized to the given value.

      Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.

      Parameters:
      s3BatchJobIdentifier - Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.

    • fromScriptBatchJobIdentifier

      public static BatchJobIdentifier fromScriptBatchJobIdentifier(ScriptBatchJobIdentifier scriptBatchJobIdentifier)
      Create an instance of this class with scriptBatchJobIdentifier() initialized to the given value.

      A batch job identifier in which the batch job to run is identified by the script name.

      Parameters:
      scriptBatchJobIdentifier - A batch job identifier in which the batch job to run is identified by the script name.

    • fromScriptBatchJobIdentifier

      public static BatchJobIdentifier fromScriptBatchJobIdentifier(Consumer<ScriptBatchJobIdentifier.Builder> scriptBatchJobIdentifier)
      Create an instance of this class with scriptBatchJobIdentifier() initialized to the given value.

      A batch job identifier in which the batch job to run is identified by the script name.

      Parameters:
      scriptBatchJobIdentifier - A batch job identifier in which the batch job to run is identified by the script name.

    • type

      public BatchJobIdentifier.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be BatchJobIdentifier.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be BatchJobIdentifier.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.