// Copyright 2024 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/sql/v1/cloud_sql_regions.proto

#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SQL_V1_SQL_REGIONS_CLIENT_H

#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SQL_V1_SQL_REGIONS_CLIENT_H

#include "google/cloud/sql/v1/sql_regions_rest_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 sql_v1 {

GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN

///

/// Service that exposes Cloud SQL region information. This service is only used

/// internally and does not follow the same patterns as the other v1 RPCs.

///

/// @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 SqlRegionsServiceClient {

public:

explicit SqlRegionsServiceClient(

std::shared_ptr<SqlRegionsServiceConnection> connection,

Options opts = {});

~SqlRegionsServiceClient();

///@{

/// @name Copy and move support

SqlRegionsServiceClient(SqlRegionsServiceClient const&) = default;

SqlRegionsServiceClient& operator=(SqlRegionsServiceClient const&) = default;

SqlRegionsServiceClient(SqlRegionsServiceClient&&) = default;

SqlRegionsServiceClient& operator=(SqlRegionsServiceClient&&) = default;

///@}

///@{

/// @name Equality

friend bool operator==(SqlRegionsServiceClient const& a,

SqlRegionsServiceClient const& b) {

return a.connection_ == b.connection_;

}

friend bool operator!=(SqlRegionsServiceClient const& a,

SqlRegionsServiceClient const& b) {

return !(a == b);

}

///@}

private:

std::shared_ptr<SqlRegionsServiceConnection> connection_;

Options options_;

};

GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END

} // namespace sql_v1

} // namespace cloud

} // namespace google

#endif // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SQL_V1_SQL_REGIONS_CLIENT_H