github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/retention/config.go (about)

     1  // Copyright (c) 2017 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package retention
    22  
    23  import (
    24  	"time"
    25  )
    26  
    27  // Configuration is the set of knobs to configure retention options
    28  type Configuration struct {
    29  	RetentionPeriod                       time.Duration  `yaml:"retentionPeriod" validate:"nonzero"`
    30  	FutureRetentionPeriod                 time.Duration  `yaml:"futureRetentionPeriod" validate:"nonzero"`
    31  	BlockSize                             time.Duration  `yaml:"blockSize" validate:"nonzero"`
    32  	BufferFuture                          time.Duration  `yaml:"bufferFuture" validate:"nonzero"`
    33  	BufferPast                            time.Duration  `yaml:"bufferPast" validate:"nonzero"`
    34  	BlockDataExpiry                       *bool          `yaml:"blockDataExpiry"`
    35  	BlockDataExpiryAfterNotAccessedPeriod *time.Duration `yaml:"blockDataExpiryAfterNotAccessedPeriod"`
    36  }
    37  
    38  // Options returns `Options` corresponding to the provided struct values
    39  func (c *Configuration) Options() Options {
    40  	opts := NewOptions().
    41  		SetRetentionPeriod(c.RetentionPeriod).
    42  		SetFutureRetentionPeriod(c.FutureRetentionPeriod).
    43  		SetBlockSize(c.BlockSize).
    44  		SetBufferFuture(c.BufferFuture).
    45  		SetBufferPast(c.BufferPast)
    46  	if v := c.BlockDataExpiry; v != nil {
    47  		opts = opts.SetBlockDataExpiry(*v)
    48  	}
    49  	if v := c.BlockDataExpiryAfterNotAccessedPeriod; v != nil {
    50  		opts = opts.SetBlockDataExpiryAfterNotAccessedPeriod(*v)
    51  	}
    52  	return opts
    53  }