github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/aggregator/client/payload.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 client
    22  
    23  import (
    24  	"github.com/m3db/m3/src/metrics/metadata"
    25  	"github.com/m3db/m3/src/metrics/metric/aggregated"
    26  	"github.com/m3db/m3/src/metrics/metric/unaggregated"
    27  	"github.com/m3db/m3/src/metrics/policy"
    28  )
    29  
    30  type payloadType int
    31  
    32  const (
    33  	// nolint
    34  	unknownPayloadType payloadType = iota
    35  	untimedType
    36  	forwardedType
    37  	timedType
    38  	timedWithStagedMetadatasType
    39  	passthroughType
    40  )
    41  
    42  type untimedPayload struct {
    43  	metadatas metadata.StagedMetadatas
    44  	metric    unaggregated.MetricUnion
    45  }
    46  
    47  type forwardedPayload struct {
    48  	metric   aggregated.ForwardedMetric
    49  	metadata metadata.ForwardMetadata
    50  }
    51  
    52  type timedPayload struct {
    53  	metric   aggregated.Metric
    54  	metadata metadata.TimedMetadata
    55  }
    56  
    57  type timedWithStagedMetadatas struct {
    58  	metadatas metadata.StagedMetadatas
    59  	metric    aggregated.Metric
    60  }
    61  
    62  type passthroughPayload struct {
    63  	metric        aggregated.Metric
    64  	storagePolicy policy.StoragePolicy
    65  }
    66  
    67  type payloadUnion struct {
    68  	untimed                  untimedPayload
    69  	timedWithStagedMetadatas timedWithStagedMetadatas
    70  	forwarded                forwardedPayload
    71  	passthrough              passthroughPayload
    72  	timed                    timedPayload
    73  	payloadType              payloadType
    74  }