-
Notifications
You must be signed in to change notification settings - Fork 444
Expand file tree
/
Copy pathsql_flags_connection.h
More file actions
194 lines (172 loc) · 7.29 KB
/
sql_flags_connection.h
File metadata and controls
194 lines (172 loc) · 7.29 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
// Copyright 2023 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_flags.proto
#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SQL_V1_SQL_FLAGS_CONNECTION_H
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SQL_V1_SQL_FLAGS_CONNECTION_H
#include "google/cloud/sql/v1/cloud_sql_flags.pb.h"
#include "google/cloud/sql/v1/internal/sql_flags_retry_traits.h"
#include "google/cloud/sql/v1/sql_flags_connection_idempotency_policy.h"
#include "google/cloud/backoff_policy.h"
#include "google/cloud/internal/retry_policy_impl.h"
#include "google/cloud/options.h"
#include "google/cloud/status_or.h"
#include "google/cloud/version.h"
#include <memory>
namespace google {
namespace cloud {
namespace sql_v1 {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
/// The retry policy for `SqlFlagsServiceConnection`.
class SqlFlagsServiceRetryPolicy : public ::google::cloud::RetryPolicy {
public:
/// Creates a new instance of the policy, reset to the initial state.
virtual std::unique_ptr<SqlFlagsServiceRetryPolicy> clone() const = 0;
};
/**
* A retry policy for `SqlFlagsServiceConnection` based on counting errors.
*
* This policy stops retrying if:
* - An RPC returns a non-transient error.
* - More than a prescribed number of transient failures is detected.
*
* In this class the following status codes are treated as transient errors:
* - [`kUnavailable`](@ref google::cloud::StatusCode)
*/
class SqlFlagsServiceLimitedErrorCountRetryPolicy
: public SqlFlagsServiceRetryPolicy {
public:
/**
* Create an instance that tolerates up to @p maximum_failures transient
* errors.
*
* @note Disable the retry loop by providing an instance of this policy with
* @p maximum_failures == 0.
*/
explicit SqlFlagsServiceLimitedErrorCountRetryPolicy(int maximum_failures)
: impl_(maximum_failures) {}
SqlFlagsServiceLimitedErrorCountRetryPolicy(
SqlFlagsServiceLimitedErrorCountRetryPolicy&& rhs) noexcept
: SqlFlagsServiceLimitedErrorCountRetryPolicy(rhs.maximum_failures()) {}
SqlFlagsServiceLimitedErrorCountRetryPolicy(
SqlFlagsServiceLimitedErrorCountRetryPolicy const& rhs) noexcept
: SqlFlagsServiceLimitedErrorCountRetryPolicy(rhs.maximum_failures()) {}
int maximum_failures() const { return impl_.maximum_failures(); }
bool OnFailure(Status const& status) override {
return impl_.OnFailure(status);
}
bool IsExhausted() const override { return impl_.IsExhausted(); }
bool IsPermanentFailure(Status const& status) const override {
return impl_.IsPermanentFailure(status);
}
std::unique_ptr<SqlFlagsServiceRetryPolicy> clone() const override {
return std::make_unique<SqlFlagsServiceLimitedErrorCountRetryPolicy>(
maximum_failures());
}
// This is provided only for backwards compatibility.
using BaseType = SqlFlagsServiceRetryPolicy;
private:
google::cloud::internal::LimitedErrorCountRetryPolicy<
sql_v1_internal::SqlFlagsServiceRetryTraits>
impl_;
};
/**
* A retry policy for `SqlFlagsServiceConnection` based on elapsed time.
*
* This policy stops retrying if:
* - An RPC returns a non-transient error.
* - The elapsed time in the retry loop exceeds a prescribed duration.
*
* In this class the following status codes are treated as transient errors:
* - [`kUnavailable`](@ref google::cloud::StatusCode)
*/
class SqlFlagsServiceLimitedTimeRetryPolicy
: public SqlFlagsServiceRetryPolicy {
public:
/**
* Constructor given a `std::chrono::duration<>` object.
*
* @tparam DurationRep a placeholder to match the `Rep` tparam for @p
* duration's type. The semantics of this template parameter are
* documented in `std::chrono::duration<>`. In brief, the underlying
* arithmetic type used to store the number of ticks. For our purposes it
* is simply a formal parameter.
* @tparam DurationPeriod a placeholder to match the `Period` tparam for @p
* duration's type. The semantics of this template parameter are
* documented in `std::chrono::duration<>`. In brief, the length of the
* tick in seconds, expressed as a `std::ratio<>`. For our purposes it is
* simply a formal parameter.
* @param maximum_duration the maximum time allowed before the policy expires.
* While the application can express this time in any units they desire,
* the class truncates to milliseconds.
*
* @see https://en.cppreference.com/w/cpp/chrono/duration for more information
* about `std::chrono::duration`.
*/
template <typename DurationRep, typename DurationPeriod>
explicit SqlFlagsServiceLimitedTimeRetryPolicy(
std::chrono::duration<DurationRep, DurationPeriod> maximum_duration)
: impl_(maximum_duration) {}
SqlFlagsServiceLimitedTimeRetryPolicy(
SqlFlagsServiceLimitedTimeRetryPolicy&& rhs) noexcept
: SqlFlagsServiceLimitedTimeRetryPolicy(rhs.maximum_duration()) {}
SqlFlagsServiceLimitedTimeRetryPolicy(
SqlFlagsServiceLimitedTimeRetryPolicy const& rhs) noexcept
: SqlFlagsServiceLimitedTimeRetryPolicy(rhs.maximum_duration()) {}
std::chrono::milliseconds maximum_duration() const {
return impl_.maximum_duration();
}
bool OnFailure(Status const& status) override {
return impl_.OnFailure(status);
}
bool IsExhausted() const override { return impl_.IsExhausted(); }
bool IsPermanentFailure(Status const& status) const override {
return impl_.IsPermanentFailure(status);
}
std::unique_ptr<SqlFlagsServiceRetryPolicy> clone() const override {
return std::make_unique<SqlFlagsServiceLimitedTimeRetryPolicy>(
maximum_duration());
}
// This is provided only for backwards compatibility.
using BaseType = SqlFlagsServiceRetryPolicy;
private:
google::cloud::internal::LimitedTimeRetryPolicy<
sql_v1_internal::SqlFlagsServiceRetryTraits>
impl_;
};
/**
* The `SqlFlagsServiceConnection` object for `SqlFlagsServiceClient`.
*
* This interface defines virtual methods for each of the user-facing overload
* sets in `SqlFlagsServiceClient`. This allows users to inject custom behavior
* (e.g., with a Google Mock object) when writing tests that use objects of type
* `SqlFlagsServiceClient`.
*
* To create a concrete instance, see `MakeSqlFlagsServiceConnection()`.
*
* For mocking, see `sql_v1_mocks::MockSqlFlagsServiceConnection`.
*/
class SqlFlagsServiceConnection {
public:
virtual ~SqlFlagsServiceConnection() = 0;
virtual Options options() { return Options{}; }
virtual StatusOr<google::cloud::sql::v1::FlagsListResponse> List(
google::cloud::sql::v1::SqlFlagsListRequest const& request);
};
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
} // namespace sql_v1
} // namespace cloud
} // namespace google
#endif // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SQL_V1_SQL_FLAGS_CONNECTION_H