Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
coryan committed Apr 6, 2024
1 parent 404cd19 commit a694a5b
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions google/cloud/common_options.h
Original file line number Diff line number Diff line change
Expand Up @@ -92,26 +92,33 @@ struct UserProjectOption {
};

/**
* Configure the QuotaUser system parameter.
* Configure the QuotaUser [system parameter].
*
* A pseudo user identifier for charging per-user quotas. If not specified, the
* authenticated principal is used. If there is no authenticated principal, the
* client IP address will be used. When specified, a valid API key with service
* restrictions must be used to identify the quota project. Otherwise, this
* parameter is ignored.
*
* [system parameter]: https://cloud.google.com/apis/docs/system-parameters
*
* @ingroup options
* @ingroup rest-options
*/
struct QuotaUserOption {
using Type = std::string;
};

/**
* Configure the UserIp query parameter.
* Configure the UserIp system parameter.
*
* @deprecated prefer using `google::cloud::QuotaUserOption`.
*
* This can be used to separate quota usage by source IP address.
*
* @deprecated prefer using `google::cloud::QuotaUser`.
* [system parameter]: https://cloud.google.com/apis/docs/system-parameters
*
* @ingroup options
* @ingroup rest-options
*/
struct UserIpOption {
Expand Down

0 comments on commit a694a5b

Please sign in to comment.