// Copyright 2026 Google LLC
//
// Licensed 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
//
//      https://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.

// Generated by the Codegen C++ plugin.
// If you make any local changes, they will be lost.
// source: google/cloud/gkerecommender/v1/gkerecommender.proto

#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_GKERECOMMENDER_V1_GKE_INFERENCE_QUICKSTART_CLIENT_H
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_GKERECOMMENDER_V1_GKE_INFERENCE_QUICKSTART_CLIENT_H

#include "google/cloud/gkerecommender/v1/gke_inference_quickstart_connection.h"
#include "google/cloud/future.h"
#include "google/cloud/options.h"
#include "google/cloud/polling_policy.h"
#include "google/cloud/status_or.h"
#include "google/cloud/version.h"
#include <memory>
#include <string>

namespace google {
namespace cloud {
namespace gkerecommender_v1 {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN

///
/// GKE Inference Quickstart (GIQ) service provides profiles with performance
/// metrics for popular models and model servers across multiple accelerators.
/// These profiles help generate optimized best practices for running inference
/// on GKE.
///
/// @par Equality
///
/// Instances of this class created via copy-construction or copy-assignment
/// always compare equal. Instances created with equal
/// `std::shared_ptr<*Connection>` objects compare equal. Objects that compare
/// equal share the same underlying resources.
///
/// @par Performance
///
/// Creating a new instance of this class is a relatively expensive operation,
/// new objects establish new connections to the service. In contrast,
/// copy-construction, move-construction, and the corresponding assignment
/// operations are relatively efficient as the copies share all underlying
/// resources.
///
/// @par Thread Safety
///
/// Concurrent access to different instances of this class, even if they compare
/// equal, is guaranteed to work. Two or more threads operating on the same
/// instance of this class is not guaranteed to work. Since copy-construction
/// and move-construction is a relatively efficient operation, consider using
/// such a copy when using this class from multiple threads.
///
class GkeInferenceQuickstartClient {
 public:
  explicit GkeInferenceQuickstartClient(
      std::shared_ptr<GkeInferenceQuickstartConnection> connection,
      Options opts = {});
  ~GkeInferenceQuickstartClient();

  ///@{
  /// @name Copy and move support
  GkeInferenceQuickstartClient(GkeInferenceQuickstartClient const&) = default;
  GkeInferenceQuickstartClient& operator=(GkeInferenceQuickstartClient const&) =
      default;
  GkeInferenceQuickstartClient(GkeInferenceQuickstartClient&&) = default;
  GkeInferenceQuickstartClient& operator=(GkeInferenceQuickstartClient&&) =
      default;
  ///@}

  ///@{
  /// @name Equality
  friend bool operator==(GkeInferenceQuickstartClient const& a,
                         GkeInferenceQuickstartClient const& b) {
    return a.connection_ == b.connection_;
  }
  friend bool operator!=(GkeInferenceQuickstartClient const& a,
                         GkeInferenceQuickstartClient const& b) {
    return !(a == b);
  }
  ///@}

  // clang-format off
  ///
  /// Fetches available models. Open-source models follow the Huggingface Hub
  /// `owner/model_name` format.
  ///
  /// @param request Unary RPCs, such as the one wrapped by this
  ///     function, receive a single `request` proto message which includes all
  ///     the inputs for the RPC. In this case, the proto message is a
  ///     [google.cloud.gkerecommender.v1.FetchModelsRequest].
  ///     Proto messages are converted to C++ classes by Protobuf, using the
  ///     [Protobuf mapping rules].
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return a [StreamRange](@ref google::cloud::StreamRange)
  ///     to iterate of the results. See the documentation of this type for
  ///     details. In brief, this class has `begin()` and `end()` member
  ///     functions returning a iterator class meeting the
  ///     [input iterator requirements]. The value type for this iterator is a
  ///     [`StatusOr`] as the iteration may fail even after some values are
  ///     retrieved successfully, for example, if there is a network disconnect.
  ///     An empty set of results does not indicate an error, it indicates
  ///     that there are no resources meeting the request criteria.
  ///     On a successful iteration the `StatusOr<T>` contains a
  ///     [`std::string`].
  ///
  /// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
  /// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
  /// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
  /// [`future`]: @ref google::cloud::future
  /// [`StatusOr`]: @ref google::cloud::StatusOr
  /// [`Status`]: @ref google::cloud::Status
  /// [google.cloud.gkerecommender.v1.FetchModelsRequest]: @googleapis_reference_link{google/cloud/gkerecommender/v1/gkerecommender.proto#L117}
  ///
  // clang-format on
  StreamRange<std::string> FetchModels(
      google::cloud::gkerecommender::v1::FetchModelsRequest request,
      Options opts = {});

  // clang-format off
  ///
  /// Fetches available model servers. Open-source model servers use simplified,
  /// lowercase names (e.g., `vllm`).
  ///
  /// @param request Unary RPCs, such as the one wrapped by this
  ///     function, receive a single `request` proto message which includes all
  ///     the inputs for the RPC. In this case, the proto message is a
  ///     [google.cloud.gkerecommender.v1.FetchModelServersRequest].
  ///     Proto messages are converted to C++ classes by Protobuf, using the
  ///     [Protobuf mapping rules].
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return a [StreamRange](@ref google::cloud::StreamRange)
  ///     to iterate of the results. See the documentation of this type for
  ///     details. In brief, this class has `begin()` and `end()` member
  ///     functions returning a iterator class meeting the
  ///     [input iterator requirements]. The value type for this iterator is a
  ///     [`StatusOr`] as the iteration may fail even after some values are
  ///     retrieved successfully, for example, if there is a network disconnect.
  ///     An empty set of results does not indicate an error, it indicates
  ///     that there are no resources meeting the request criteria.
  ///     On a successful iteration the `StatusOr<T>` contains a
  ///     [`std::string`].
  ///
  /// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
  /// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
  /// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
  /// [`future`]: @ref google::cloud::future
  /// [`StatusOr`]: @ref google::cloud::StatusOr
  /// [`Status`]: @ref google::cloud::Status
  /// [google.cloud.gkerecommender.v1.FetchModelServersRequest]: @googleapis_reference_link{google/cloud/gkerecommender/v1/gkerecommender.proto#L152}
  ///
  // clang-format on
  StreamRange<std::string> FetchModelServers(
      google::cloud::gkerecommender::v1::FetchModelServersRequest request,
      Options opts = {});

  // clang-format off
  ///
  /// Fetches available model server versions. Open-source servers use their own
  /// versioning schemas (e.g., `vllm` uses semver like `v1.0.0`).
  ///
  /// Some model servers have different versioning schemas depending on the
  /// accelerator. For example, `vllm` uses semver on GPUs, but returns nightly
  /// build tags on TPUs. All available versions will be returned when different
  /// schemas are present.
  ///
  /// @param request Unary RPCs, such as the one wrapped by this
  ///     function, receive a single `request` proto message which includes all
  ///     the inputs for the RPC. In this case, the proto message is a
  ///     [google.cloud.gkerecommender.v1.FetchModelServerVersionsRequest].
  ///     Proto messages are converted to C++ classes by Protobuf, using the
  ///     [Protobuf mapping rules].
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return a [StreamRange](@ref google::cloud::StreamRange)
  ///     to iterate of the results. See the documentation of this type for
  ///     details. In brief, this class has `begin()` and `end()` member
  ///     functions returning a iterator class meeting the
  ///     [input iterator requirements]. The value type for this iterator is a
  ///     [`StatusOr`] as the iteration may fail even after some values are
  ///     retrieved successfully, for example, if there is a network disconnect.
  ///     An empty set of results does not indicate an error, it indicates
  ///     that there are no resources meeting the request criteria.
  ///     On a successful iteration the `StatusOr<T>` contains a
  ///     [`std::string`].
  ///
  /// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
  /// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
  /// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
  /// [`future`]: @ref google::cloud::future
  /// [`StatusOr`]: @ref google::cloud::StatusOr
  /// [`Status`]: @ref google::cloud::Status
  /// [google.cloud.gkerecommender.v1.FetchModelServerVersionsRequest]: @googleapis_reference_link{google/cloud/gkerecommender/v1/gkerecommender.proto#L194}
  ///
  // clang-format on
  StreamRange<std::string> FetchModelServerVersions(
      google::cloud::gkerecommender::v1::FetchModelServerVersionsRequest
          request,
      Options opts = {});

  // clang-format off
  ///
  /// Fetches available profiles. A profile contains performance metrics and
  /// cost information for a specific model server setup. Profiles can be
  /// filtered by parameters. If no filters are provided, all profiles are
  /// returned.
  ///
  /// Profiles display a single value per performance metric based on the
  /// provided performance requirements. If no requirements are given, the
  /// metrics represent the inflection point. See [Run best practice inference
  /// with GKE Inference Quickstart
  /// recipes](https://cloud.google.com/kubernetes-engine/docs/how-to/machine-learning/inference/inference-quickstart#how)
  /// for details.
  ///
  /// @param request Unary RPCs, such as the one wrapped by this
  ///     function, receive a single `request` proto message which includes all
  ///     the inputs for the RPC. In this case, the proto message is a
  ///     [google.cloud.gkerecommender.v1.FetchProfilesRequest].
  ///     Proto messages are converted to C++ classes by Protobuf, using the
  ///     [Protobuf mapping rules].
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return a [StreamRange](@ref google::cloud::StreamRange)
  ///     to iterate of the results. See the documentation of this type for
  ///     details. In brief, this class has `begin()` and `end()` member
  ///     functions returning a iterator class meeting the
  ///     [input iterator requirements]. The value type for this iterator is a
  ///     [`StatusOr`] as the iteration may fail even after some values are
  ///     retrieved successfully, for example, if there is a network disconnect.
  ///     An empty set of results does not indicate an error, it indicates
  ///     that there are no resources meeting the request criteria.
  ///     On a successful iteration the `StatusOr<T>` contains elements of type
  ///     [google.cloud.gkerecommender.v1.Profile], or rather,
  ///     the C++ class generated by Protobuf from that type. Please consult the
  ///     Protobuf documentation for details on the [Protobuf mapping rules].
  ///
  /// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
  /// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
  /// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
  /// [`future`]: @ref google::cloud::future
  /// [`StatusOr`]: @ref google::cloud::StatusOr
  /// [`Status`]: @ref google::cloud::Status
  /// [google.cloud.gkerecommender.v1.FetchProfilesRequest]: @googleapis_reference_link{google/cloud/gkerecommender/v1/gkerecommender.proto#L271}
  /// [google.cloud.gkerecommender.v1.Profile]: @googleapis_reference_link{google/cloud/gkerecommender/v1/gkerecommender.proto#L490}
  ///
  // clang-format on
  StreamRange<google::cloud::gkerecommender::v1::Profile> FetchProfiles(
      google::cloud::gkerecommender::v1::FetchProfilesRequest request,
      Options opts = {});

  // clang-format off
  ///
  /// Generates an optimized deployment manifest for a given model and model
  /// server, based on the specified accelerator, performance targets, and
  /// configurations. See [Run best practice inference with GKE Inference
  /// Quickstart
  /// recipes](https://cloud.google.com/kubernetes-engine/docs/how-to/machine-learning/inference/inference-quickstart)
  /// for deployment details.
  ///
  /// @param request Unary RPCs, such as the one wrapped by this
  ///     function, receive a single `request` proto message which includes all
  ///     the inputs for the RPC. In this case, the proto message is a
  ///     [google.cloud.gkerecommender.v1.GenerateOptimizedManifestRequest].
  ///     Proto messages are converted to C++ classes by Protobuf, using the
  ///     [Protobuf mapping rules].
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return the result of the RPC. The response message type
  ///     ([google.cloud.gkerecommender.v1.GenerateOptimizedManifestResponse])
  ///     is mapped to a C++ class using the [Protobuf mapping rules].
  ///     If the request fails, the [`StatusOr`] contains the error details.
  ///
  /// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
  /// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
  /// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
  /// [`future`]: @ref google::cloud::future
  /// [`StatusOr`]: @ref google::cloud::StatusOr
  /// [`Status`]: @ref google::cloud::Status
  /// [google.cloud.gkerecommender.v1.GenerateOptimizedManifestRequest]: @googleapis_reference_link{google/cloud/gkerecommender/v1/gkerecommender.proto#L516}
  /// [google.cloud.gkerecommender.v1.GenerateOptimizedManifestResponse]: @googleapis_reference_link{google/cloud/gkerecommender/v1/gkerecommender.proto#L559}
  ///
  // clang-format on
  StatusOr<google::cloud::gkerecommender::v1::GenerateOptimizedManifestResponse>
  GenerateOptimizedManifest(
      google::cloud::gkerecommender::v1::GenerateOptimizedManifestRequest const&
          request,
      Options opts = {});

  // clang-format off
  ///
  /// Fetches all of the benchmarking data available for a profile. Benchmarking
  /// data returns all of the performance metrics available for a given model
  /// server setup on a given instance type.
  ///
  /// @param request Unary RPCs, such as the one wrapped by this
  ///     function, receive a single `request` proto message which includes all
  ///     the inputs for the RPC. In this case, the proto message is a
  ///     [google.cloud.gkerecommender.v1.FetchBenchmarkingDataRequest].
  ///     Proto messages are converted to C++ classes by Protobuf, using the
  ///     [Protobuf mapping rules].
  /// @param opts Optional. Override the class-level options, such as retry and
  ///     backoff policies.
  /// @return the result of the RPC. The response message type
  ///     ([google.cloud.gkerecommender.v1.FetchBenchmarkingDataResponse])
  ///     is mapped to a C++ class using the [Protobuf mapping rules].
  ///     If the request fails, the [`StatusOr`] contains the error details.
  ///
  /// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
  /// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
  /// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
  /// [`future`]: @ref google::cloud::future
  /// [`StatusOr`]: @ref google::cloud::StatusOr
  /// [`Status`]: @ref google::cloud::Status
  /// [google.cloud.gkerecommender.v1.FetchBenchmarkingDataRequest]: @googleapis_reference_link{google/cloud/gkerecommender/v1/gkerecommender.proto#L242}
  /// [google.cloud.gkerecommender.v1.FetchBenchmarkingDataResponse]: @googleapis_reference_link{google/cloud/gkerecommender/v1/gkerecommender.proto#L263}
  ///
  // clang-format on
  StatusOr<google::cloud::gkerecommender::v1::FetchBenchmarkingDataResponse>
  FetchBenchmarkingData(
      google::cloud::gkerecommender::v1::FetchBenchmarkingDataRequest const&
          request,
      Options opts = {});

 private:
  std::shared_ptr<GkeInferenceQuickstartConnection> connection_;
  Options options_;
};

GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
}  // namespace gkerecommender_v1
}  // namespace cloud
}  // namespace google

#endif  // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_GKERECOMMENDER_V1_GKE_INFERENCE_QUICKSTART_CLIENT_H
