go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/tsmon/flush_type.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  package tsmon
    16  
    17  import (
    18  	"flag"
    19  
    20  	"go.chromium.org/luci/common/flag/flagenum"
    21  )
    22  
    23  const (
    24  	// FlushManual requires the user to flush manually.
    25  	FlushManual = FlushType("manual")
    26  	// FlushAuto automatically flushes at a periodic flush interval.
    27  	FlushAuto = FlushType("auto")
    28  )
    29  
    30  // FlushType is a flush type enumeration.
    31  type FlushType string
    32  
    33  func (ft *FlushType) String() string {
    34  	return flushTypeEnum.FlagString(ft)
    35  }
    36  
    37  // Set implements flag.Value.
    38  func (ft *FlushType) Set(v string) error {
    39  	return flushTypeEnum.FlagSet(ft, v)
    40  }
    41  
    42  var _ flag.Value = (*FlushType)(nil)
    43  
    44  var flushTypeEnum = flagenum.Enum{
    45  	"manual": FlushManual,
    46  	"auto":   FlushAuto,
    47  }