Class ModifyInstanceEventWindowRequest

    • Method Detail

      • dryRun

        public final Boolean dryRun()

        Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

        Returns:
        Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      • name

        public final String name()

        The name of the event window.

        Returns:
        The name of the event window.
      • instanceEventWindowId

        public final String instanceEventWindowId()

        The ID of the event window.

        Returns:
        The ID of the event window.
      • hasTimeRanges

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

        public final List<InstanceEventWindowTimeRangeRequest> timeRanges()

        The time ranges of the event window.

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

        Returns:
        The time ranges of the event window.
      • cronExpression

        public final String cronExpression()

        The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.

        Constraints:

        • Only hour and day of the week values are supported.

        • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.

        • The minute, month, and year must be specified by *.

        • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.

        • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.

        • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

        For more information about cron expressions, see cron on the Wikipedia website.

        Returns:
        The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.

        Constraints:

        • Only hour and day of the week values are supported.

        • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.

        • The minute, month, and year must be specified by *.

        • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.

        • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.

        • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

        For more information about cron expressions, see cron on the Wikipedia website.

      • 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