1 /* 2 * Copyright 2017 Google LLC 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 LLC 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 com.google.api.gax.rpc; 31 32 import com.google.api.core.InternalApi; 33 import java.util.Map; 34 35 /** 36 * A request params extractor takes a {@code request} message, extracts specific field values from 37 * it, converts them in strings and returns them as key-value pairs, where a key is a request field 38 * name and a value is a string representation of a field value. Nested fields should also be 39 * extractable, in such case the "dot notation" can be used to represent a nested field name, for 40 * example {@code "field_name.nested_field_name"}. 41 * 42 * <p>Implementations of this interface are expected to be autogenerated. 43 * 44 * @param <RequestT> request message type 45 */ 46 @InternalApi("For use by transport-specific implementations") 47 public interface RequestParamsExtractor<RequestT> { 48 /** 49 * Extracts specific fields from the {@code request} and returns them in a form of key-value 50 * pairs, where a key is a field name and a value is a field's string representation. To represent 51 * nested field names the "dot notation" can be used. 52 * 53 * @param request request message 54 */ extract(RequestT request)55 Map<String, String> extract(RequestT request); 56 } 57