Class ListPreviewRotationShiftsRequest

    • Method Detail

      • rotationStartTime

        public final Instant rotationStartTime()

        The date and time a rotation would begin. The first shift is calculated from this date and time.

        Returns:
        The date and time a rotation would begin. The first shift is calculated from this date and time.
      • startTime

        public final Instant startTime()

        Used to filter the range of calculated shifts before sending the response back to the user.

        Returns:
        Used to filter the range of calculated shifts before sending the response back to the user.
      • endTime

        public final Instant endTime()

        The date and time a rotation shift would end.

        Returns:
        The date and time a rotation shift would end.
      • hasMembers

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

        public final List<String> members()

        The contacts that would be assigned to a rotation.

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

        Returns:
        The contacts that would be assigned to a rotation.
      • timeZoneId

        public final String timeZoneId()

        The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".

        Returns:
        The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".
      • recurrence

        public final RecurrenceSettings recurrence()

        Information about how long a rotation would last before restarting at the beginning of the shift order.

        Returns:
        Information about how long a rotation would last before restarting at the beginning of the shift order.
      • hasOverrides

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

        public final List<PreviewOverride> overrides()

        Information about changes that would be made in a rotation override.

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

        Returns:
        Information about changes that would be made in a rotation override.
      • nextToken

        public final String nextToken()

        A token to start the list. This token is used to get the next set of results.

        Returns:
        A token to start the list. This token is used to get the next set of results.
      • maxResults

        public final Integer maxResults()

        The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set of results.

        Returns:
        The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set of results.
      • 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