sigs.k8s.io/prow@v0.0.0-20240503223140-c5e374dc7eb1/pkg/flagutil/gerrit.go (about)

     1  /*
     2  Copyright 2023 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package flagutil
    18  
    19  import "flag"
    20  
    21  type GerritOptions struct {
    22  	GerritFields
    23  	defaults GerritFields
    24  }
    25  
    26  type GerritFields struct {
    27  	MaxQPS, MaxBurst int // No throttling when unset.
    28  }
    29  
    30  func (o *GerritOptions) SetDefaultThrottle(MaxQPS, MaxBurst int) {
    31  	o.defaults.MaxQPS = MaxQPS
    32  	o.defaults.MaxBurst = MaxBurst
    33  }
    34  
    35  func (o *GerritOptions) AddFlags(fs *flag.FlagSet) {
    36  	fs.IntVar(&o.MaxQPS, "gerrit-max-qps", o.defaults.MaxQPS, "The maximum allowed queries per second to the Gerrit API from this component.")
    37  	fs.IntVar(&o.MaxBurst, "gerrit-max-burst", o.defaults.MaxBurst, "The maximum allowed burst size of queries to the Gerrit API from this component.")
    38  }
    39  
    40  func (o *GerritOptions) Validate(dryrun bool) error {
    41  	return nil
    42  }