github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/storage/bootstrap/run_options.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 bootstrap
    22  
    23  import "github.com/m3db/m3/src/dbnode/topology"
    24  
    25  var (
    26  	// defaultPersistConfig declares the intent to by default to perform
    27  	// a bootstrap without persistence enabled.
    28  	defaultPersistConfig = PersistConfig{
    29  		Enabled: false,
    30  	}
    31  )
    32  
    33  type runOptions struct {
    34  	persistConfig        PersistConfig
    35  	cacheSeriesMetadata  bool
    36  	initialTopologyState *topology.StateSnapshot
    37  }
    38  
    39  // NewRunOptions creates new bootstrap run options
    40  func NewRunOptions() RunOptions {
    41  	return &runOptions{
    42  		persistConfig:        defaultPersistConfig,
    43  		cacheSeriesMetadata:  defaultCacheSeriesMetadata,
    44  		initialTopologyState: nil,
    45  	}
    46  }
    47  
    48  func (o *runOptions) SetPersistConfig(value PersistConfig) RunOptions {
    49  	opts := *o
    50  	opts.persistConfig = value
    51  	return &opts
    52  }
    53  
    54  func (o *runOptions) PersistConfig() PersistConfig {
    55  	return o.persistConfig
    56  }
    57  
    58  func (o *runOptions) SetCacheSeriesMetadata(value bool) RunOptions {
    59  	opts := *o
    60  	opts.cacheSeriesMetadata = value
    61  	return &opts
    62  }
    63  
    64  func (o *runOptions) CacheSeriesMetadata() bool {
    65  	return o.cacheSeriesMetadata
    66  }
    67  
    68  func (o *runOptions) SetInitialTopologyState(value *topology.StateSnapshot) RunOptions {
    69  	opts := *o
    70  	opts.initialTopologyState = value
    71  	return &opts
    72  }
    73  
    74  func (o *runOptions) InitialTopologyState() *topology.StateSnapshot {
    75  	return o.initialTopologyState
    76  }