github.com/m3db/m3@v1.5.0/src/ctl/service/r2/store/update_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 store
    22  
    23  // UpdateOptions is a set of ruleset or namespace update options.
    24  type UpdateOptions interface {
    25  	// SetAuthor sets the author for an update.
    26  	SetAuthor(value string) UpdateOptions
    27  
    28  	// Author returns the author for an update.
    29  	Author() string
    30  }
    31  
    32  type updateOptions struct {
    33  	author string
    34  }
    35  
    36  // NewUpdateOptions creates a new set of update options.
    37  func NewUpdateOptions() UpdateOptions {
    38  	return &updateOptions{}
    39  }
    40  
    41  func (o *updateOptions) SetAuthor(value string) UpdateOptions {
    42  	opts := *o
    43  	opts.author = value
    44  	return &opts
    45  }
    46  
    47  func (o *updateOptions) Author() string {
    48  	return o.author
    49  }