Class BatchParameters

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

The custom parameters to be used when the target is an Batch job.

See Also:

  • Method Details

    • jobDefinition

      public final String jobDefinition()

      The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

      Returns:
      The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

    • jobName

      public final String jobName()

      The name to use for this execution of the job, if the target is an Batch job.

      Returns:
      The name to use for this execution of the job, if the target is an Batch job.

    • arrayProperties

      public final BatchArrayProperties arrayProperties()

      The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

      Returns:
      The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

    • retryStrategy

      public final BatchRetryStrategy retryStrategy()

      The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

      Returns:
      The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

    • toBuilder

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

    • builder

      public static BatchParameters.Builder builder()

    • serializableBuilderClass

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