Class Action

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

Defines an action to be initiated by a trigger.

See Also:

  • Method Details

    • jobName

      public final String jobName()

      The name of a job to be run.

      Returns:
      The name of a job to be run.

    • hasArguments

      public final boolean hasArguments()
      For responses, this returns true if the service returned a value for the Arguments 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.

    • arguments

      public final Map<String,String> arguments()

      The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

      You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.

      For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

      For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

      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 hasArguments() method.

      Returns:
      The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

      You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.

      For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

      For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

    • timeout

      public final Integer timeout()

      The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This overrides the timeout value set in the parent job.

      Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.

      When the value is left blank, the timeout is defaulted to 2880 minutes.

      Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.

      For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.

      Returns:
      The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. This overrides the timeout value set in the parent job.

      Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.

      When the value is left blank, the timeout is defaulted to 2880 minutes.

      Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.

      For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.

    • securityConfiguration

      public final String securityConfiguration()

      The name of the SecurityConfiguration structure to be used with this action.

      Returns:
      The name of the SecurityConfiguration structure to be used with this action.

    • notificationProperty

      public final NotificationProperty notificationProperty()

      Specifies configuration properties of a job run notification.

      Returns:
      Specifies configuration properties of a job run notification.

    • crawlerName

      public final String crawlerName()

      The name of the crawler to be used with this action.

      Returns:
      The name of the crawler to be used with this action.

    • toBuilder

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

    • builder

      public static Action.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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