go.temporal.io/server@v1.23.0/common/persistence/queue_v2.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package persistence
    26  
    27  import (
    28  	"fmt"
    29  
    30  	"go.temporal.io/api/serviceerror"
    31  )
    32  
    33  const (
    34  	QueueTypeUnspecified   QueueV2Type = 0
    35  	QueueTypeHistoryNormal QueueV2Type = 1
    36  	QueueTypeHistoryDLQ    QueueV2Type = 2
    37  
    38  	// FirstQueueMessageID is the ID of the first message written to a queue partition.
    39  	FirstQueueMessageID = 0
    40  )
    41  
    42  var (
    43  	ErrInvalidReadQueueMessagesNextPageToken = &InvalidPersistenceRequestError{
    44  		Msg: "invalid next-page token for reading queue messages",
    45  	}
    46  	ErrInvalidListQueuesNextPageToken = &InvalidPersistenceRequestError{
    47  		Msg: "invalid next-page token for listing queues",
    48  	}
    49  	ErrNonPositiveReadQueueMessagesPageSize = &InvalidPersistenceRequestError{
    50  		Msg: "non-positive page size for reading queue messages",
    51  	}
    52  	ErrInvalidQueueRangeDeleteMaxMessageID = &InvalidPersistenceRequestError{
    53  		Msg: "max message id for queue range delete is invalid",
    54  	}
    55  	ErrNonPositiveListQueuesPageSize = &InvalidPersistenceRequestError{
    56  		Msg: "non-positive page size for listing queues",
    57  	}
    58  	ErrNegativeListQueuesOffset = &InvalidPersistenceRequestError{
    59  		Msg: "negative offset for listing queues",
    60  	}
    61  )
    62  
    63  func NewQueueNotFoundError(queueType QueueV2Type, queueName string) error {
    64  	return serviceerror.NewNotFound(fmt.Sprintf(
    65  		"queue not found: type = %v and name = %v",
    66  		queueType,
    67  		queueName,
    68  	))
    69  }