Class CustomEventsTrigger


public final class CustomEventsTrigger extends MultiplePipelineTrigger
Trigger that runs every time a custom event is received.
  • Constructor Details

    • CustomEventsTrigger

      public CustomEventsTrigger()
      Creates an instance of CustomEventsTrigger class.
  • Method Details

    • withPipelines

      public CustomEventsTrigger withPipelines(List<TriggerPipelineReference> pipelines)
      Set the pipelines property: Pipelines that need to be started.
      Overrides:
      withPipelines in class MultiplePipelineTrigger
      Parameters:
      pipelines - the pipelines value to set.
      Returns:
      the MultiplePipelineTrigger object itself.
    • withDescription

      public CustomEventsTrigger withDescription(String description)
      Set the description property: Trigger description.
      Overrides:
      withDescription in class MultiplePipelineTrigger
      Parameters:
      description - the description value to set.
      Returns:
      the Trigger object itself.
    • withAnnotations

      public CustomEventsTrigger withAnnotations(List<Object> annotations)
      Set the annotations property: List of tags that can be used for describing the trigger.
      Overrides:
      withAnnotations in class MultiplePipelineTrigger
      Parameters:
      annotations - the annotations value to set.
      Returns:
      the Trigger object itself.
    • subjectBeginsWith

      public String subjectBeginsWith()
      Get the subjectBeginsWith property: The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.
      Returns:
      the subjectBeginsWith value.
    • withSubjectBeginsWith

      public CustomEventsTrigger withSubjectBeginsWith(String subjectBeginsWith)
      Set the subjectBeginsWith property: The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.
      Parameters:
      subjectBeginsWith - the subjectBeginsWith value to set.
      Returns:
      the CustomEventsTrigger object itself.
    • subjectEndsWith

      public String subjectEndsWith()
      Get the subjectEndsWith property: The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.
      Returns:
      the subjectEndsWith value.
    • withSubjectEndsWith

      public CustomEventsTrigger withSubjectEndsWith(String subjectEndsWith)
      Set the subjectEndsWith property: The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith.
      Parameters:
      subjectEndsWith - the subjectEndsWith value to set.
      Returns:
      the CustomEventsTrigger object itself.
    • events

      public List<Object> events()
      Get the events property: The list of event types that cause this trigger to fire.
      Returns:
      the events value.
    • withEvents

      public CustomEventsTrigger withEvents(List<Object> events)
      Set the events property: The list of event types that cause this trigger to fire.
      Parameters:
      events - the events value to set.
      Returns:
      the CustomEventsTrigger object itself.
    • scope

      public String scope()
      Get the scope property: The ARM resource ID of the Azure Event Grid Topic.
      Returns:
      the scope value.
    • withScope

      public CustomEventsTrigger withScope(String scope)
      Set the scope property: The ARM resource ID of the Azure Event Grid Topic.
      Parameters:
      scope - the scope value to set.
      Returns:
      the CustomEventsTrigger object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class MultiplePipelineTrigger
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.