github.com/m3db/m3@v1.5.0/src/metrics/rules/store/kv/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 kv
    22  
    23  import (
    24  	"github.com/m3db/m3/src/metrics/rules"
    25  )
    26  
    27  // StoreOptions provide a set of options for KV-backed rules store.
    28  type StoreOptions struct {
    29  	NamespacesKey string
    30  	RuleSetKeyFmt string
    31  	Validator     rules.Validator
    32  }
    33  
    34  // NewStoreOptions creates a new store options struct.
    35  func NewStoreOptions(
    36  	namespacesKey string,
    37  	rulesetKeyFmt string,
    38  	validator rules.Validator,
    39  ) StoreOptions {
    40  	return StoreOptions{
    41  		NamespacesKey: namespacesKey,
    42  		RuleSetKeyFmt: rulesetKeyFmt,
    43  		Validator:     validator,
    44  	}
    45  }