1 // Copyright 2023, Google Inc. 2 // All rights reserved. 3 // 4 // Redistribution and use in source and binary forms, with or without 5 // modification, are permitted provided that the following conditions are 6 // met: 7 // 8 // * Redistributions of source code must retain the above copyright 9 // notice, this list of conditions and the following disclaimer. 10 // * Redistributions in binary form must reproduce the above 11 // copyright notice, this list of conditions and the following disclaimer 12 // in the documentation and/or other materials provided with the 13 // distribution. 14 // * Neither the name of Google Inc. nor the names of its 15 // contributors may be used to endorse or promote products derived from 16 // this software without specific prior written permission. 17 // 18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 30 package callctx_test 31 32 import ( 33 "context" 34 "fmt" 35 36 "github.com/googleapis/gax-go/v2/callctx" 37 "google.golang.org/genproto/googleapis/api/metric" 38 "google.golang.org/protobuf/types/known/fieldmaskpb" 39 ) 40 41 func ExampleSetHeaders() { 42 ctx := context.Background() 43 ctx = callctx.SetHeaders(ctx, "key", "value") 44 45 // Send the returned context to the request you are making. Later on these 46 // values will be retrieved and set on outgoing requests. 47 48 headers := callctx.HeadersFromContext(ctx) 49 fmt.Println(headers["key"][0]) 50 // Output: value 51 } 52 53 func ExampleXGoogFieldMaskHeader() { 54 ctx := context.Background() 55 ctx = callctx.SetHeaders(ctx, callctx.XGoogFieldMaskHeader, "field_one,field.two") 56 57 // Send the returned context to the request you are making. 58 } 59 60 func ExampleXGoogFieldMaskHeader_fieldmaskpb() { 61 // Build a mask using the expected response protobuf message. 62 mask, err := fieldmaskpb.New(&metric.MetricDescriptor{}, "display_name", "metadata.launch_stage") 63 if err != nil { 64 // handle error 65 } 66 67 ctx := context.Background() 68 ctx = callctx.SetHeaders(ctx, callctx.XGoogFieldMaskHeader, mask.String()) 69 70 // Send the returned context to the request you are making. 71 } 72