github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/storage/bootstrap/provider_options.go (about)

     1  // Copyright (c) 2018 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 (
    24  	"errors"
    25  
    26  	"github.com/m3db/m3/src/dbnode/topology"
    27  )
    28  
    29  const (
    30  	// defaultCacheSeriesMetadata declares that by default bootstrap providers should
    31  	// cache series metadata between runs.
    32  	defaultCacheSeriesMetadata = true
    33  )
    34  
    35  var (
    36  	errTopologyMapProviderShouldNotBeNil = errors.New("topology map provider should not be nil")
    37  	errOriginShouldNotBeNil              = errors.New("origin should not be nil")
    38  )
    39  
    40  type processOptions struct {
    41  	cacheSeriesMetadata bool
    42  	topoMapProvider     topology.MapProvider
    43  	origin              topology.Host
    44  }
    45  
    46  // NewProcessOptions creates new bootstrap run options
    47  func NewProcessOptions() ProcessOptions {
    48  	return &processOptions{
    49  		cacheSeriesMetadata: defaultCacheSeriesMetadata,
    50  		topoMapProvider:     nil,
    51  		origin:              nil,
    52  	}
    53  }
    54  
    55  func (o *processOptions) Validate() error {
    56  	if o.topoMapProvider == nil {
    57  		return errTopologyMapProviderShouldNotBeNil
    58  	}
    59  
    60  	if o.origin == nil {
    61  		return errOriginShouldNotBeNil
    62  	}
    63  
    64  	return nil
    65  }
    66  
    67  func (o *processOptions) SetCacheSeriesMetadata(value bool) ProcessOptions {
    68  	opts := *o
    69  	opts.cacheSeriesMetadata = value
    70  	return &opts
    71  }
    72  
    73  func (o *processOptions) CacheSeriesMetadata() bool {
    74  	return o.cacheSeriesMetadata
    75  }
    76  
    77  func (o *processOptions) SetTopologyMapProvider(value topology.MapProvider) ProcessOptions {
    78  	opts := *o
    79  	opts.topoMapProvider = value
    80  	return &opts
    81  }
    82  
    83  func (o *processOptions) TopologyMapProvider() topology.MapProvider {
    84  	return o.topoMapProvider
    85  }
    86  
    87  func (o *processOptions) SetOrigin(value topology.Host) ProcessOptions {
    88  	opts := *o
    89  	opts.origin = value
    90  	return &opts
    91  }
    92  
    93  func (o *processOptions) Origin() topology.Host {
    94  	return o.origin
    95  }