co.elastic.clients.transport.WithUriParameter Maven / Gradle / Ivy

Go to download
/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package co.elastic.clients.transport;

/**
 * Base interface for request builders that can load properties found in URI paths segments and query parameters.
 */
public interface WithUriParameter {

    /**
     * Set a URI path segment or query parameter property on this object.
     *
     * @param name the property name
     * @param value the property value
     * @return {@code true} if the property was found, {@code false} if the property is unknown
     * @throws RuntimeException if the value cannot be parsed to a valid property value
     */
    boolean withUriParameter(String name, String value);
}