Class CreateTriggerRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.glue.model.GlueRequest
software.amazon.awssdk.services.glue.model.CreateTriggerRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTriggerRequest.Builder,CreateTriggerRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateTriggerRequest extends GlueRequest implements ToCopyableBuilder<CreateTriggerRequest.Builder,CreateTriggerRequest>

  • Method Details

    • name

      public final String name()

      The name of the trigger.

      Returns:
      The name of the trigger.

    • workflowName

      public final String workflowName()

      The name of the workflow associated with the trigger.

      Returns:
      The name of the workflow associated with the trigger.

    • type

      public final TriggerType type()

      The type of the new trigger.

      If the service returns an enum value that is not available in the current SDK version, type will return TriggerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the new trigger.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the new trigger.

      If the service returns an enum value that is not available in the current SDK version, type will return TriggerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of the new trigger.
      See Also:

    • schedule

      public final String schedule()

      A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

      This field is required when the trigger type is SCHEDULED.

      Returns:
      A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

      This field is required when the trigger type is SCHEDULED.

    • predicate

      public final Predicate predicate()

      A predicate to specify when the new trigger should fire.

      This field is required when the trigger type is CONDITIONAL.

      Returns:
      A predicate to specify when the new trigger should fire.

      This field is required when the trigger type is CONDITIONAL.

    • hasActions

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

    • actions

      public final List<Action> actions()

      The actions initiated by this trigger when it fires.

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

      Returns:
      The actions initiated by this trigger when it fires.

    • description

      public final String description()

      A description of the new trigger.

      Returns:
      A description of the new trigger.

    • startOnCreation

      public final Boolean startOnCreation()

      Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.

      Returns:
      Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue 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 hasTags() method.

      Returns:
      The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

    • eventBatchingCondition

      public final EventBatchingCondition eventBatchingCondition()

      Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

      Returns:
      Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

    • toBuilder

      public CreateTriggerRequest.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<CreateTriggerRequest.Builder,CreateTriggerRequest>
      Specified by:
      toBuilder in class GlueRequest
      Returns:
      a builder for type T

    • builder

      public static CreateTriggerRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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