Api-roll 47: 2017-03-27

generated/googleapis/lib/servicecontrol/v1.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.servicecontrol.v1;
 
 import 'dart:core' as core;
 import 'dart:async' as async;
 import 'dart:convert' as convert;
 
 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
 import 'package:http/http.dart' as http;
@@ skipping 31 matching lines @@
       _requester = client;
 
   /**
    * Attempts to allocate quota for the specified consumer. It should be called
    * before the operation is executed.
    *
    * This method requires the `servicemanagement.services.quota`
    * permission on the specified service. For more information, see
    * [Google Cloud IAM](https://cloud.google.com/iam).
    *
+   * **NOTE:** the client code **must** fail-open if the server returns one
+   * of the following quota errors:
+   * -   `PROJECT_STATUS_UNAVAILABLE`
+   * -   `SERVICE_STATUS_UNAVAILABLE`
+   * -   `BILLING_STATUS_UNAVAILABLE`
+   * -   `QUOTA_SYSTEM_UNAVAILABLE`
+   *
+   * The server may inject above errors to prohibit any hard dependency
+   * on the quota system.
+   *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [serviceName] - Name of the service as specified in the service
    * configuration. For example,
    * `"pubsub.googleapis.com"`.
    *
    * See google.api.Service for the definition of a service name.
    *
@@ skipping 145 matching lines @@
     return _response.then((data) => new EndReconciliationResponse.fromJson(data));
   }
 
   /**
    * Releases previously allocated quota done through AllocateQuota method.
    *
    * This method requires the `servicemanagement.services.quota`
    * permission on the specified service. For more information, see
    * [Google Cloud IAM](https://cloud.google.com/iam).
    *
+   * **NOTE:** the client code **must** fail-open if the server returns one
+   * of the following quota errors:
+   * -   `PROJECT_STATUS_UNAVAILABLE`
+   * -   `SERVICE_STATUS_UNAVAILABLE`
+   * -   `BILLING_STATUS_UNAVAILABLE`
+   * -   `QUOTA_SYSTEM_UNAVAILABLE`
+   *
+   * The server may inject above errors to prohibit any hard dependency
+   * on the quota system.
+   *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [serviceName] - Name of the service as specified in the service
    * configuration. For example,
    * `"pubsub.googleapis.com"`.
    *
    * See google.api.Service for the definition of a service name.
    *
@@ skipping 246 matching lines @@
    * will be specified using the following delta metric:
    *   "serviceruntime.googleapis.com/api/consumer/quota_used_count"
    *
    * 2. For allocation quota, per quota metric total usage will be specified
    * using the following gauge metric:
    *   "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
    *
    * 3. For both rate quota and allocation quota, the quota limit reached
    * condition will be specified using the following boolean metric:
    *   "serviceruntime.googleapis.com/quota/exceeded"
+   *
+   * 4. For allocation quota, value for each quota limit associated with
+   * the metrics will be specified using the following gauge metric:
+   *   "serviceruntime.googleapis.com/quota/limit"
    */
   core.List<MetricValueSet> quotaMetrics;
   /** ID of the actual config used to process the request. */
   core.String serviceConfigId;
 
   AllocateQuotaResponse();
 
   AllocateQuotaResponse.fromJson(core.Map _json) {
     if (_json.containsKey("allocateErrors")) {
       allocateErrors = _json["allocateErrors"].map((value) => new QuotaError.fromJson(value)).toList();
@@ skipping 650 matching lines @@
 }
 
 class EndReconciliationResponse {
   /**
    * The same operation_id value used in the EndReconciliationRequest. Used for
    * logging and diagnostics purposes.
    */
   core.String operationId;
   /**
    * Metric values as tracked by One Platform before the adjustment was made.
+   * The following metrics will be included:
+   *
+   * 1. Per quota metric total usage will be specified using the following gauge
+   * metric:
+   *   "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
+   *
+   * 2. Value for each quota limit associated with the metrics will be specified
+   * using the following gauge metric:
+   *   "serviceruntime.googleapis.com/quota/limit"
+   *
+   * 3. Delta value of the usage after the reconciliation for limits associated
+   * with the metrics will be specified using the following metric:
+   *   "serviceruntime.googleapis.com/allocation/reconciliation_delta"
+   * The delta value is defined as:
+   *   new_usage_from_client - existing_value_in_spanner.
+   * This metric is not defined in serviceruntime.yaml or in Cloud Monarch.
+   * This metric is meant for callers' use only. Since this metric is not
+   * defined in the monitoring backend, reporting on this metric will result in
+   * an error.
    */
   core.List<MetricValueSet> quotaMetrics;
   /** Indicates the decision of the reconciliation end. */
   core.List<QuotaError> reconciliationErrors;
   /** ID of the actual config used to process the request. */
   core.String serviceConfigId;
 
   EndReconciliationResponse();
 
   EndReconciliationResponse.fromJson(core.Map _json) {
@@ skipping 678 matching lines @@
    * for the specific
    * consumer project.
    * - "CLIENT_APP_BLOCKED" : Client application of the consumer request is
    * invalid for the
    * specific consumer project.
    * - "API_KEY_INVALID" : Specified API key is invalid.
    * - "API_KEY_EXPIRED" : Specified API Key has expired.
    * - "SPATULA_HEADER_INVALID" : Consumer's spatula header is invalid.
    * - "LOAS_ROLE_INVALID" : The consumer's LOAS role is invalid.
    * - "NO_LOAS_PROJECT" : The consumer's LOAS role has no associated project.
-   * - "PROJECT_STATUS_UNVAILABLE" : The backend server for looking up project
+   * - "PROJECT_STATUS_UNAVAILABLE" : The backend server for looking up project
    * id/number is unavailable.
    * - "SERVICE_STATUS_UNAVAILABLE" : The backend server for checking service
    * status is unavailable.
    * - "BILLING_STATUS_UNAVAILABLE" : The backend server for checking billing
    * status is unavailable.
    * - "QUOTA_SYSTEM_UNAVAILABLE" : The backend server for checking quota limits
    * is unavailable.
    */
   core.String code;
   /** Free-form text that provides details on the cause of the error. */
@@ skipping 151 matching lines @@
    * Possible string values are:
    * - "UNSPECIFIED"
    * - "NORMAL" : For AllocateQuota request, allocates quota for the amount
    * specified in
    * the service configuration or specified using the quota metrics. If the
    * amount is higher than the available quota, allocation error will be
    * returned and no quota will be allocated.
    * For ReleaseQuota request, this mode is supported only for precise quota
    * limits. In this case, this operation releases quota for the amount
    * specified in the service configuration or specified using the quota
-   * metrics. If the release can make available quota negative, release error
+   * metrics. If the release can make used quota negative, release error
    * will be returned and no quota will be released.
    * - "BEST_EFFORT" : For AllocateQuota request, this mode is supported only
    * for imprecise
    * quota limits. In this case, the operation allocates quota for the amount
    * specified in the service configuration or specified using the quota
    * metrics. If the amount is higher than the available quota, request does
    * not fail but all available quota will be allocated.
    * For ReleaseQuota request, this mode is supported for both precise quota
    * limits and imprecise quota limits. In this case, this operation releases
    * quota for the amount specified in the service configuration or specified
-   * using the quota metrics. If the release can make available quota
-   * negative, request does not fail but only the available quota will be
-   * released. After the ReleaseQuota request completes, the available quota
+   * using the quota metrics. If the release can make used quota
+   * negative, request does not fail but only the used quota will be
+   * released. After the ReleaseQuota request completes, the used quota
    * will be 0, and never goes to negative.
    * - "CHECK_ONLY" : For AllocateQuota request, only checks if there is enough
    * quota
    * available and does not change the available quota. No lock is placed on
    * the available quota either. Not supported for ReleaseQuota request.
    */
   core.String quotaMode;
 
   QuotaOperation();
 
@@ skipping 35 matching lines @@
     if (quotaMetrics != null) {
       _json["quotaMetrics"] = quotaMetrics.map((value) => (value).toJson()).toList();
     }
     if (quotaMode != null) {
       _json["quotaMode"] = quotaMode;
     }
     return _json;
   }
 }
 
-/**
- * Represents the properties needed for quota operations.
- *
- * Use the metric_value_sets field in Operation message to provide cost
- * override with metric_name in <service_name>/quota/<quota_group_name>/cost
- * format. Overrides for unmatched quota groups will be ignored.
- * Costs are expected to be >= 0. Cost 0 will cause no quota check,
- * but still traffic restrictions will be enforced.
- */
+/** Represents the properties needed for quota operations. */
 class QuotaProperties {
   /**
    * LimitType IDs that should be used for checking quota. Key in this map
    * should be a valid LimitType string, and the value is the ID to be used. For
    * example, an entry <USER, 123> will cause all user quota limits to use 123
    * as the user ID. See google/api/quota.proto for the definition of LimitType.
    * CLIENT_PROJECT: Not supported.
    * USER: Value of this entry will be used for enforcing user-level quota
    *       limits. If none specified, caller IP passed in the
    *       servicecontrol.googleapis.com/caller_ip label will be used instead.
@@ skipping 91 matching lines @@
    * Quota metrics to indicate the result of release. Depending on the
    * request, one or more of the following metrics will be included:
    *
    * 1. For rate quota, per quota group or per quota metric released amount
    * will be specified using the following delta metric:
    *   "serviceruntime.googleapis.com/api/consumer/quota_refund_count"
    *
    * 2. For allocation quota, per quota metric total usage will be specified
    * using the following gauge metric:
    *   "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
+   *
+   * 3. For allocation quota, value for each quota limit associated with
+   * the metrics will be specified using the following gauge metric:
+   *   "serviceruntime.googleapis.com/quota/limit"
    */
   core.List<MetricValueSet> quotaMetrics;
   /** Indicates the decision of the release. */
   core.List<QuotaError> releaseErrors;
   /** ID of the actual config used to process the request. */
   core.String serviceConfigId;
 
   ReleaseQuotaResponse();
 
   ReleaseQuotaResponse.fromJson(core.Map _json) {
@@ skipping 273 matching lines @@
 }
 
 class StartReconciliationResponse {
   /**
    * The same operation_id value used in the StartReconciliationRequest. Used
    * for logging and diagnostics purposes.
    */
   core.String operationId;
   /**
    * Metric values as tracked by One Platform before the start of
-   * reconciliation.
+   * reconciliation. The following metrics will be included:
+   *
+   * 1. Per quota metric total usage will be specified using the following gauge
+   * metric:
+   *   "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
+   *
+   * 2. Value for each quota limit associated with the metrics will be specified
+   * using the following gauge metric:
+   *   "serviceruntime.googleapis.com/quota/limit"
    */
   core.List<MetricValueSet> quotaMetrics;
   /** Indicates the decision of the reconciliation start. */
   core.List<QuotaError> reconciliationErrors;
   /** ID of the actual config used to process the request. */
   core.String serviceConfigId;
 
   StartReconciliationResponse();
 
   StartReconciliationResponse.fromJson(core.Map _json) {
@@ skipping 124 matching lines @@
     }
     if (details != null) {
       _json["details"] = details;
     }
     if (message != null) {
       _json["message"] = message;
     }
     return _json;
   }
 }