Class Queue

    • Method Detail

      • arn

        public final String arn()
        An identifier for this resource that is unique within all of AWS.
        Returns:
        An identifier for this resource that is unique within all of AWS.
      • createdAt

        public final Instant createdAt()
        The timestamp in epoch seconds for when you created the queue.
        Returns:
        The timestamp in epoch seconds for when you created the queue.
      • description

        public final String description()
        An optional description that you create for each queue.
        Returns:
        An optional description that you create for each queue.
      • lastUpdated

        public final Instant lastUpdated()
        The timestamp in epoch seconds for when you most recently updated the queue.
        Returns:
        The timestamp in epoch seconds for when you most recently updated the queue.
      • name

        public final String name()
        A name that you create for each queue. Each name must be unique within your account.
        Returns:
        A name that you create for each queue. Each name must be unique within your account.
      • pricingPlan

        public final PricingPlan pricingPlan()
        Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.

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

        Returns:
        Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.
        See Also:
        PricingPlan
      • pricingPlanAsString

        public final String pricingPlanAsString()
        Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.

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

        Returns:
        Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.
        See Also:
        PricingPlan
      • progressingJobsCount

        public final Integer progressingJobsCount()
        The estimated number of jobs with a PROGRESSING status.
        Returns:
        The estimated number of jobs with a PROGRESSING status.
      • reservationPlan

        public final ReservationPlan reservationPlan()
        Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
        Returns:
        Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.
      • status

        public final QueueStatus status()
        Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

        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:
        Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.
        See Also:
        QueueStatus
      • statusAsString

        public final String statusAsString()
        Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.

        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:
        Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.
        See Also:
        QueueStatus
      • submittedJobsCount

        public final Integer submittedJobsCount()
        The estimated number of jobs with a SUBMITTED status.
        Returns:
        The estimated number of jobs with a SUBMITTED status.
      • type

        public final Type type()
        Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.

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

        Returns:
        Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.
        See Also:
        Type
      • typeAsString

        public final String typeAsString()
        Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.

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

        Returns:
        Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.
        See Also:
        Type
      • serializableBuilderClass

        public static Class<? extends Queue.Builder> serializableBuilderClass()
      • 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)