go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/gae/service/taskqueue/types.go (about)

     1  // Copyright 2015 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // This file contains types which are mirrors/duplicates of the upstream SDK
    16  // types. This exists so that users can depend solely on this wrapper library
    17  // without necessarially needing an SDK implementation present.
    18  //
    19  // This was done (instead of type-aliasing from the github version of the SDK)
    20  // because some of the types need to be tweaked (like Task.RetryOptions) to
    21  // interact well with the wrapper, and the inconsistency of having some types
    22  // defined by the gae package and others defined by the SDK was pretty awkward.
    23  
    24  package taskqueue
    25  
    26  import (
    27  	"time"
    28  )
    29  
    30  // Statistics represents statistics about a single task queue.
    31  type Statistics struct {
    32  	Tasks     int       // may be an approximation
    33  	OldestETA time.Time // zero if there are no pending tasks
    34  
    35  	Executed1Minute int     // tasks executed in the last minute
    36  	InFlight        int     // tasks executing now
    37  	EnforcedRate    float64 // requests per second
    38  }