Class QueueSummary

    • Method Detail

      • blockedReasonAsString

        public final String blockedReasonAsString()

        The reason the queue is blocked, if applicable.

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

        Returns:
        The reason the queue is blocked, if applicable.
        See Also:
        QueueBlockedReason
      • createdAt

        public final Instant createdAt()

        The date and time the resource was created.

        Returns:
        The date and time the resource was created.
      • createdBy

        public final String createdBy()

        The user or system that created this resource.

        Returns:
        The user or system that created this resource.
      • defaultBudgetActionAsString

        public final String defaultBudgetActionAsString()

        The default action taken on a queue summary if a budget wasn't configured.

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

        Returns:
        The default action taken on a queue summary if a budget wasn't configured.
        See Also:
        DefaultQueueBudgetAction
      • displayName

        public final String displayName()

        The display name of the queue summary to update.

        Returns:
        The display name of the queue summary to update.
      • farmId

        public final String farmId()

        The farm ID.

        Returns:
        The farm ID.
      • queueId

        public final String queueId()

        The queue ID.

        Returns:
        The queue ID.
      • statusAsString

        public final String statusAsString()

        That status of the queue.

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

        Returns:
        That status of the queue.
        See Also:
        QueueStatus
      • updatedAt

        public final Instant updatedAt()

        The date and time the resource was updated.

        Returns:
        The date and time the resource was updated.
      • updatedBy

        public final String updatedBy()

        The user or system that updated this resource.

        Returns:
        The user or system that updated this resource.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)