sonarqube/sonar-ws/src/main/java/org/sonarqube/ws/client/WsRequest.java

/*
 * SonarQube
 * Copyright (C) 2009-2021 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonarqube.ws.client;

import java.util.Map;
import java.util.OptionalInt;

/**
 * @since 5.3
 */
public interface WsRequest {

  Method getMethod();

  String getPath();

  String getMediaType();

  OptionalInt getTimeOutInMs();

  OptionalInt getWriteTimeOutInMs();

  /**
   *
   * In case of multi value parameters, returns the first value
   *
   * @deprecated since 6.1. Use {@link #getParameters()} instead
   */
  @Deprecated
  Map<String, String> getParams();

  Parameters getParameters();

  Headers getHeaders();

  enum Method {
    GET, POST
  }
}