Package com.azure.resourcemanager.storage.models

Class TriggerParameters

java.lang.Object
com.azure.resourcemanager.storage.models.TriggerParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<TriggerParameters>
public final class TriggerParameters extends Object implements com.azure.json.JsonSerializable<TriggerParameters>
The trigger parameters update for the storage task assignment execution.

  • Constructor Details

    • TriggerParameters

      public TriggerParameters()
      Creates an instance of TriggerParameters class.

  • Method Details

    • startFrom

      public OffsetDateTime startFrom()
      Get the startFrom property: When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce'.
      Returns:
      the startFrom value.

    • withStartFrom

      public TriggerParameters withStartFrom(OffsetDateTime startFrom)
      Set the startFrom property: When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce'.
      Parameters:
      startFrom - the startFrom value to set.
      Returns:
      the TriggerParameters object itself.

    • interval

      public Integer interval()
      Get the interval property: Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce'.
      Returns:
      the interval value.

    • withInterval

      public TriggerParameters withInterval(Integer interval)
      Set the interval property: Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce'.
      Parameters:
      interval - the interval value to set.
      Returns:
      the TriggerParameters object itself.

    • intervalUnit

      public IntervalUnit intervalUnit()
      Get the intervalUnit property: Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce'.
      Returns:
      the intervalUnit value.

    • withIntervalUnit

      public TriggerParameters withIntervalUnit(IntervalUnit intervalUnit)
      Set the intervalUnit property: Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce'.
      Parameters:
      intervalUnit - the intervalUnit value to set.
      Returns:
      the TriggerParameters object itself.

    • endBy

      public OffsetDateTime endBy()
      Get the endBy property: When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce'.
      Returns:
      the endBy value.

    • withEndBy

      public TriggerParameters withEndBy(OffsetDateTime endBy)
      Set the endBy property: When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce'.
      Parameters:
      endBy - the endBy value to set.
      Returns:
      the TriggerParameters object itself.

    • startOn

      public OffsetDateTime startOn()
      Get the startOn property: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule'.
      Returns:
      the startOn value.

    • withStartOn

      public TriggerParameters withStartOn(OffsetDateTime startOn)
      Set the startOn property: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule'.
      Parameters:
      startOn - the startOn value to set.
      Returns:
      the TriggerParameters object itself.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<TriggerParameters>
      Throws:
      IOException

    • fromJson

      public static TriggerParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of TriggerParameters from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of TriggerParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the TriggerParameters.