Updated APIs
diff --git a/generated/googleapis/lib/serviceusage/v1.dart b/generated/googleapis/lib/serviceusage/v1.dart
index acf148b..dc81939 100644
--- a/generated/googleapis/lib/serviceusage/v1.dart
+++ b/generated/googleapis/lib/serviceusage/v1.dart
@@ -49,16 +49,15 @@
OperationsResourceApi(commons.ApiRequester client) : _requester = client;
- /// Starts asynchronous cancellation on a long-running operation. The server
+ /// Starts asynchronous cancellation on a long-running operation. The server
/// makes a best effort to cancel the operation, but success is not
- /// guaranteed. If the server doesn't support this method, it returns
- /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use
- /// Operations.GetOperation or
- /// other methods to check whether the cancellation succeeded or whether the
- /// operation completed despite cancellation. On successful cancellation,
- /// the operation is not deleted; instead, it becomes an operation with
- /// an Operation.error value with a google.rpc.Status.code of 1,
- /// corresponding to `Code.CANCELLED`.
+ /// guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation
+ /// or other methods to check whether the cancellation succeeded or whether
+ /// the operation completed despite cancellation. On successful cancellation,
+ /// the operation is not deleted; instead, it becomes an operation with an
+ /// Operation.error value with a google.rpc.Status.code of 1, corresponding to
+ /// `Code.CANCELLED`.
///
/// [request] - The metadata request object.
///
@@ -153,7 +152,7 @@
return _response.then((data) => new Empty.fromJson(data));
}
- /// Gets the latest state of a long-running operation. Clients can use this
+ /// Gets the latest state of a long-running operation. Clients can use this
/// method to poll the operation result at intervals as recommended by the API
/// service.
///
@@ -199,27 +198,25 @@
}
/// Lists operations that match the specified filter in the request. If the
- /// server doesn't support this method, it returns `UNIMPLEMENTED`.
- ///
- /// NOTE: the `name` binding allows API services to override the binding
- /// to use different resource name schemes, such as `users / * /operations`.
- /// To
+ /// server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the
+ /// `name` binding allows API services to override the binding to use
+ /// different resource name schemes, such as `users / * /operations`. To
/// override the binding, API services can add a binding such as
- /// `"/v1/{name=users / * }/operations"` to their service configuration.
- /// For backwards compatibility, the default name includes the operations
- /// collection id, however overriding users must ensure the name binding
- /// is the parent resource, without the operations collection id.
+ /// `"/v1/{name=users / * }/operations"` to their service configuration. For
+ /// backwards compatibility, the default name includes the operations
+ /// collection id, however overriding users must ensure the name binding is
+ /// the parent resource, without the operations collection id.
///
/// Request parameters:
///
+ /// [pageSize] - The standard list page size.
+ ///
+ /// [pageToken] - The standard list page token.
+ ///
/// [filter] - The standard list filter.
///
/// [name] - The name of the operation's parent resource.
///
- /// [pageToken] - The standard list page token.
- ///
- /// [pageSize] - The standard list page size.
- ///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
@@ -231,10 +228,10 @@
/// If the used [http_1.Client] completes with an error when making a REST
/// call, this method will complete with the same error.
async.Future<ListOperationsResponse> list(
- {core.String filter,
- core.String name,
+ {core.int pageSize,
core.String pageToken,
- core.int pageSize,
+ core.String filter,
+ core.String name,
core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
@@ -243,18 +240,18 @@
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body;
+ if (pageSize != null) {
+ _queryParams["pageSize"] = ["${pageSize}"];
+ }
+ if (pageToken != null) {
+ _queryParams["pageToken"] = [pageToken];
+ }
if (filter != null) {
_queryParams["filter"] = [filter];
}
if (name != null) {
_queryParams["name"] = [name];
}
- if (pageToken != null) {
- _queryParams["pageToken"] = [pageToken];
- }
- if (pageSize != null) {
- _queryParams["pageSize"] = ["${pageSize}"];
- }
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
@@ -277,21 +274,17 @@
ServicesResourceApi(commons.ApiRequester client) : _requester = client;
/// Enable multiple services on a project. The operation is atomic: if
- /// enabling
- /// any service fails, then the entire batch fails, and no state changes
- /// occur.
- /// To enable a single service, use the `EnableService` method instead.
+ /// enabling any service fails, then the entire batch fails, and no state
+ /// changes occur. To enable a single service, use the `EnableService` method
+ /// instead.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
- /// [parent] - Parent to enable services on.
- ///
- /// An example name would be:
- /// `projects/123` where `123` is the project number.
- ///
- /// The `BatchEnableServices` method currently only supports projects.
+ /// [parent] - Parent to enable services on. An example name would be:
+ /// `projects/123` where `123` is the project number. The
+ /// `BatchEnableServices` method currently only supports projects.
/// Value must have pattern "^[^/]+/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
@@ -342,20 +335,16 @@
///
/// Request parameters:
///
- /// [parent] - Parent to retrieve services from.
- /// If this is set, the parent of all of the services specified in `names`
- /// must
- /// match this field. An example name would be: `projects/123` where `123` is
- /// the project number. The `BatchGetServices` method currently only supports
- /// projects.
+ /// [parent] - Parent to retrieve services from. If this is set, the parent of
+ /// all of the services specified in `names` must match this field. An example
+ /// name would be: `projects/123` where `123` is the project number. The
+ /// `BatchGetServices` method currently only supports projects.
/// Value must have pattern "^[^/]+/[^/]+$".
///
- /// [names] - Names of the services to retrieve.
- ///
- /// An example name would be:
+ /// [names] - Names of the services to retrieve. An example name would be:
/// `projects/123/services/serviceusage.googleapis.com` where `123` is the
- /// project number.
- /// A single request can get a maximum of 20 services at a time.
+ /// project number. A single request can get a maximum of 30 services at a
+ /// time.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
@@ -400,25 +389,21 @@
.then((data) => new BatchGetServicesResponse.fromJson(data));
}
- /// Disable a service so that it can no longer be used with a project.
- /// This prevents unintended usage that may cause unexpected billing
- /// charges or security leaks.
- ///
- /// It is not valid to call the disable method on a service that is not
- /// currently enabled. Callers will receive a `FAILED_PRECONDITION` status if
- /// the target service is not currently enabled.
+ /// Disable a service so that it can no longer be used with a project. This
+ /// prevents unintended usage that may cause unexpected billing charges or
+ /// security leaks. It is not valid to call the disable method on a service
+ /// that is not currently enabled. Callers will receive a
+ /// `FAILED_PRECONDITION` status if the target service is not currently
+ /// enabled.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
- /// [name] - Name of the consumer and service to disable the service on.
- ///
- /// The enable and disable methods currently only support projects.
- ///
- /// An example name would be:
- /// `projects/123/services/serviceusage.googleapis.com` where `123` is the
- /// project number.
+ /// [name] - Name of the consumer and service to disable the service on. The
+ /// enable and disable methods currently only support projects. An example
+ /// name would be: `projects/123/services/serviceusage.googleapis.com` where
+ /// `123` is the project number.
/// Value must have pattern "^[^/]+/[^/]+/services/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
@@ -468,15 +453,10 @@
///
/// Request parameters:
///
- /// [name] - Name of the consumer and service to enable the service on.
- ///
- /// The `EnableService` and `DisableService` methods currently only support
- /// projects.
- ///
- /// Enabling a service requires that the service is public or is shared with
- /// the user enabling the service.
- ///
- /// An example name would be:
+ /// [name] - Name of the consumer and service to enable the service on. The
+ /// `EnableService` and `DisableService` methods currently only support
+ /// projects. Enabling a service requires that the service is public or is
+ /// shared with the user enabling the service. An example name would be:
/// `projects/123/services/serviceusage.googleapis.com` where `123` is the
/// project number.
/// Value must have pattern "^[^/]+/[^/]+/services/[^/]+$".
@@ -526,7 +506,6 @@
/// Request parameters:
///
/// [name] - Name of the consumer and service to get the `ConsumerState` for.
- ///
/// An example name would be:
/// `projects/123/services/serviceusage.googleapis.com` where `123` is the
/// project number.
@@ -571,31 +550,30 @@
}
/// List all services available to the specified project, and the current
- /// state of those services with respect to the project. The list includes
- /// all public services, all services for which the calling user has the
+ /// state of those services with respect to the project. The list includes all
+ /// public services, all services for which the calling user has the
/// `servicemanagement.services.bind` permission, and all services that have
- /// already been enabled on the project. The list can be filtered to
- /// only include services in a specific state, for example to only include
- /// services enabled on the project.
+ /// already been enabled on the project. The list can be filtered to only
+ /// include services in a specific state, for example to only include services
+ /// enabled on the project. WARNING: If you need to query enabled services
+ /// frequently or across an organization, you should use [Cloud Asset
+ /// Inventory API](https://cloud.google.com/asset-inventory/docs/apis), which
+ /// provides higher throughput and richer filtering capability.
///
/// Request parameters:
///
- /// [parent] - Parent to search for services on.
- ///
- /// An example name would be:
+ /// [parent] - Parent to search for services on. An example name would be:
/// `projects/123` where `123` is the project number.
/// Value must have pattern "^[^/]+/[^/]+$".
///
+ /// [filter] - Only list services that conform to the given filter. The
+ /// allowed filter strings are `state:ENABLED` and `state:DISABLED`.
+ ///
/// [pageToken] - Token identifying which result to start with, which is
- /// returned by a
- /// previous list call.
+ /// returned by a previous list call.
///
- /// [pageSize] - Requested size of the next page of data.
- /// Requested page size cannot exceed 200.
- /// If not set, the default page size is 50.
- ///
- /// [filter] - Only list services that conform to the given filter.
- /// The allowed filter strings are `state:ENABLED` and `state:DISABLED`.
+ /// [pageSize] - Requested size of the next page of data. Requested page size
+ /// cannot exceed 200. If not set, the default page size is 50.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
@@ -608,9 +586,9 @@
/// If the used [http_1.Client] completes with an error when making a REST
/// call, this method will complete with the same error.
async.Future<ListServicesResponse> list(core.String parent,
- {core.String pageToken,
+ {core.String filter,
+ core.String pageToken,
core.int pageSize,
- core.String filter,
core.String $fields}) {
var _url;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
@@ -622,15 +600,15 @@
if (parent == null) {
throw new core.ArgumentError("Parameter parent is required.");
}
+ if (filter != null) {
+ _queryParams["filter"] = [filter];
+ }
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
- if (filter != null) {
- _queryParams["filter"] = [filter];
- }
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
@@ -648,17 +626,98 @@
}
}
-/// Api is a light-weight descriptor for an API Interface.
-///
-/// Interfaces are also described as "protocol buffer services" in some
-/// contexts,
-/// such as by the "service" keyword in a .proto file, but they are different
-/// from API Services, which represent a concrete implementation of an interface
-/// as opposed to simply a description of methods and bindings. They are also
+/// Quota policy created by quota administrator.
+class AdminQuotaPolicy {
+ /// The cloud resource container at which the quota policy is created. The
+ /// format is {container_type}/{container_number}
+ core.String container;
+
+ /// If this map is nonempty, then this policy applies only to specific values
+ /// for dimensions defined in the limit unit. For example, an policy on a
+ /// limit with the unit 1/{project}/{region} could contain an entry with the
+ /// key "region" and the value "us-east-1"; the policy is only applied to
+ /// quota consumed in that region. This map has the following restrictions: *
+ /// If "region" appears as a key, its value must be a valid Cloud region. * If
+ /// "zone" appears as a key, its value must be a valid Cloud zone. * Keys
+ /// other than "region" or "zone" are not valid.
+ core.Map<core.String, core.String> dimensions;
+
+ /// The name of the metric to which this policy applies. An example name would
+ /// be: `compute.googleapis.com/cpus`
+ core.String metric;
+
+ /// The resource name of the policy. This name is generated by the server when
+ /// the policy is created. Example names would be:
+ /// `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d`
+ core.String name;
+
+ /// The quota policy value. Can be any nonnegative integer, or -1 (unlimited
+ /// quota).
+ core.String policyValue;
+
+ /// The limit unit of the limit to which this policy applies. An example unit
+ /// would be: `1/{project}/{region}` Note that `{project}` and `{region}` are
+ /// not placeholders in this example; the literal characters `{` and `}` occur
+ /// in the string.
+ core.String unit;
+
+ AdminQuotaPolicy();
+
+ AdminQuotaPolicy.fromJson(core.Map _json) {
+ if (_json.containsKey("container")) {
+ container = _json["container"];
+ }
+ if (_json.containsKey("dimensions")) {
+ dimensions =
+ (_json["dimensions"] as core.Map).cast<core.String, core.String>();
+ }
+ if (_json.containsKey("metric")) {
+ metric = _json["metric"];
+ }
+ if (_json.containsKey("name")) {
+ name = _json["name"];
+ }
+ if (_json.containsKey("policyValue")) {
+ policyValue = _json["policyValue"];
+ }
+ if (_json.containsKey("unit")) {
+ unit = _json["unit"];
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (container != null) {
+ _json["container"] = container;
+ }
+ if (dimensions != null) {
+ _json["dimensions"] = dimensions;
+ }
+ if (metric != null) {
+ _json["metric"] = metric;
+ }
+ if (name != null) {
+ _json["name"] = name;
+ }
+ if (policyValue != null) {
+ _json["policyValue"] = policyValue;
+ }
+ if (unit != null) {
+ _json["unit"] = unit;
+ }
+ return _json;
+ }
+}
+
+/// Api is a light-weight descriptor for an API Interface. Interfaces are also
+/// described as "protocol buffer services" in some contexts, such as by the
+/// "service" keyword in a .proto file, but they are different from API
+/// Services, which represent a concrete implementation of an interface as
+/// opposed to simply a description of methods and bindings. They are also
/// sometimes simply referred to as "APIs" in other contexts, such as the name
-/// of
-/// this message itself. See https://cloud.google.com/apis/design/glossary for
-/// detailed terminology.
+/// of this message itself. See https://cloud.google.com/apis/design/glossary
+/// for detailed terminology.
class Api {
/// The methods of this interface, in unspecified order.
core.List<Method> methods;
@@ -688,20 +747,15 @@
/// omitted, it defaults to zero. If the entire version field is empty, the
/// major version is derived from the package name, as outlined below. If the
/// field is not empty, the version in the package name will be verified to be
- /// consistent with what is provided here.
- ///
- /// The versioning schema uses [semantic
- /// versioning](http://semver.org) where the major version number
+ /// consistent with what is provided here. The versioning schema uses
+ /// [semantic versioning](http://semver.org) where the major version number
/// indicates a breaking change and the minor version an additive,
- /// non-breaking change. Both version numbers are signals to users
- /// what to expect from different versions, and should be carefully
- /// chosen based on the product plan.
- ///
- /// The major version is also reflected in the package name of the
- /// interface, which must end in `v<major-version>`, as in
- /// `google.feature.v1`. For major versions 0 and 1, the suffix can
- /// be omitted. Zero major versions must only be used for
- /// experimental, non-GA interfaces.
+ /// non-breaking change. Both version numbers are signals to users what to
+ /// expect from different versions, and should be carefully chosen based on
+ /// the product plan. The major version is also reflected in the package name
+ /// of the interface, which must end in `v`, as in `google.feature.v1`. For
+ /// major versions 0 and 1, the suffix can be omitted. Zero major versions
+ /// must only be used for experimental, non-GA interfaces.
core.String version;
Api();
@@ -764,27 +818,22 @@
}
}
-/// Configuration for an authentication provider, including support for
-/// [JSON Web Token
+/// Configuration for an authentication provider, including support for [JSON
+/// Web Token
/// (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
class AuthProvider {
/// The list of JWT
/// [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
/// that are allowed to access. A JWT containing any of these audiences will
- /// be accepted. When this setting is absent, JWTs with audiences:
- /// - "https://[service.name]/[google.protobuf.Api.name]"
- /// - "https://[service.name]/"
- /// will be accepted.
- /// For example, if no audiences are in the setting, LibraryService API will
- /// accept JWTs with the following audiences:
- /// -
+ /// be accepted. When this setting is absent, JWTs with audiences: -
+ /// "https://[service.name]/[google.protobuf.Api.name]" -
+ /// "https://[service.name]/" will be accepted. For example, if no audiences
+ /// are in the setting, LibraryService API will accept JWTs with the following
+ /// audiences: -
/// https://library-example.googleapis.com/google.example.library.v1.LibraryService
- /// - https://library-example.googleapis.com/
- ///
- /// Example:
- ///
- /// audiences: bookstore_android.apps.googleusercontent.com,
- /// bookstore_web.apps.googleusercontent.com
+ /// - https://library-example.googleapis.com/ Example: audiences:
+ /// bookstore_android.apps.googleusercontent.com,
+ /// bookstore_web.apps.googleusercontent.com
core.String audiences;
/// Redirect URL if JWT token is required but not present or is expired.
@@ -792,50 +841,33 @@
core.String authorizationUrl;
/// The unique identifier of the auth provider. It will be referred to by
- /// `AuthRequirement.provider_id`.
- ///
- /// Example: "bookstore_auth".
+ /// `AuthRequirement.provider_id`. Example: "bookstore_auth".
core.String id;
/// Identifies the principal that issued the JWT. See
/// https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
- /// Usually a URL or an email address.
- ///
- /// Example: https://securetoken.google.com
+ /// Usually a URL or an email address. Example: https://securetoken.google.com
/// Example: 1234567-compute@developer.gserviceaccount.com
core.String issuer;
/// URL of the provider's public key set to validate signature of the JWT. See
/// [OpenID
/// Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
- /// Optional if the key set document:
- /// - can be retrieved from
- /// [OpenID
+ /// Optional if the key set document: - can be retrieved from [OpenID
/// Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
- /// the issuer.
- /// - can be inferred from the email domain of the issuer (e.g. a Google
- /// service account).
- ///
- /// Example: https://www.googleapis.com/oauth2/v1/certs
+ /// the issuer. - can be inferred from the email domain of the issuer (e.g. a
+ /// Google service account). Example:
+ /// https://www.googleapis.com/oauth2/v1/certs
core.String jwksUri;
- /// Defines the locations to extract the JWT.
- ///
- /// JWT locations can be either from HTTP headers or URL query parameters.
- /// The rule is that the first match wins. The checking order is: checking
- /// all headers first, then URL query parameters.
- ///
- /// If not specified, default to use following 3 locations:
- /// 1) Authorization: Bearer
- /// 2) x-goog-iap-jwt-assertion
- /// 3) access_token query parameter
- ///
- /// Default locations can be specified as followings:
- /// jwt_locations:
- /// - header: Authorization
- /// value_prefix: "Bearer "
- /// - header: x-goog-iap-jwt-assertion
- /// - query: access_token
+ /// Defines the locations to extract the JWT. JWT locations can be either from
+ /// HTTP headers or URL query parameters. The rule is that the first match
+ /// wins. The checking order is: checking all headers first, then URL query
+ /// parameters. If not specified, default to use following 3 locations: 1)
+ /// Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query
+ /// parameter Default locations can be specified as followings: jwt_locations:
+ /// - header: Authorization value_prefix: "Bearer " - header:
+ /// x-goog-iap-jwt-assertion - query: access_token
core.List<JwtLocation> jwtLocations;
AuthProvider();
@@ -889,33 +921,24 @@
}
}
-/// User-defined authentication requirements, including support for
-/// [JSON Web Token
+/// User-defined authentication requirements, including support for [JSON Web
+/// Token
/// (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
class AuthRequirement {
/// NOTE: This will be deprecated soon, once AuthProvider.audiences is
- /// implemented and accepted in all the runtime components.
- ///
- /// The list of JWT
+ /// implemented and accepted in all the runtime components. The list of JWT
/// [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
/// that are allowed to access. A JWT containing any of these audiences will
/// be accepted. When this setting is absent, only JWTs with audience
- /// "https://Service_name/API_name"
- /// will be accepted. For example, if no audiences are in the setting,
- /// LibraryService API will only accept JWTs with the following audience
+ /// "https://Service_name/API_name" will be accepted. For example, if no
+ /// audiences are in the setting, LibraryService API will only accept JWTs
+ /// with the following audience
/// "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
- ///
- /// Example:
- ///
- /// audiences: bookstore_android.apps.googleusercontent.com,
- /// bookstore_web.apps.googleusercontent.com
+ /// Example: audiences: bookstore_android.apps.googleusercontent.com,
+ /// bookstore_web.apps.googleusercontent.com
core.String audiences;
- /// id from authentication provider.
- ///
- /// Example:
- ///
- /// provider_id: bookstore_auth
+ /// id from authentication provider. Example: provider_id: bookstore_auth
core.String providerId;
AuthRequirement();
@@ -943,25 +966,16 @@
}
/// `Authentication` defines the authentication configuration for an API.
-///
-/// Example for an API targeted for external use:
-///
-/// name: calendar.googleapis.com
-/// authentication:
-/// providers:
-/// - id: google_calendar_auth
-/// jwks_uri: https://www.googleapis.com/oauth2/v1/certs
-/// issuer: https://securetoken.google.com
-/// rules:
-/// - selector: "*"
-/// requirements:
-/// provider_id: google_calendar_auth
+/// Example for an API targeted for external use: name: calendar.googleapis.com
+/// authentication: providers: - id: google_calendar_auth jwks_uri:
+/// https://www.googleapis.com/oauth2/v1/certs issuer:
+/// https://securetoken.google.com rules: - selector: "*" requirements:
+/// provider_id: google_calendar_auth
class Authentication {
/// Defines a set of authentication providers that a service supports.
core.List<AuthProvider> providers;
/// A list of authentication rules that apply to individual API methods.
- ///
/// **NOTE:** All service configuration rules follow "last one wins" order.
core.List<AuthenticationRule> rules;
@@ -994,15 +1008,11 @@
}
}
-/// Authentication rules for the service.
-///
-/// By default, if a method has any authentication requirements, every request
-/// must include a valid credential matching one of the requirements.
-/// It's an error to include more than one kind of credential in a single
-/// request.
-///
-/// If a method doesn't have any auth requirements, request credentials will be
-/// ignored.
+/// Authentication rules for the service. By default, if a method has any
+/// authentication requirements, every request must include a valid credential
+/// matching one of the requirements. It's an error to include more than one
+/// kind of credential in a single request. If a method doesn't have any auth
+/// requirements, request credentials will be ignored.
class AuthenticationRule {
/// If true, the service accepts API keys without any other credential.
core.bool allowWithoutCredential;
@@ -1013,9 +1023,8 @@
/// Requirements for additional authentication providers.
core.List<AuthRequirement> requirements;
- /// Selects the methods to which this rule applies.
- ///
- /// Refer to selector for syntax details.
+ /// Selects the methods to which this rule applies. Refer to selector for
+ /// syntax details.
core.String selector;
AuthenticationRule();
@@ -1060,7 +1069,6 @@
/// `Backend` defines the backend configuration for a service.
class Backend {
/// A list of API backend rules that apply to individual API methods.
- ///
/// **NOTE:** All service configuration rules follow "last one wins" order.
core.List<BackendRule> rules;
@@ -1086,26 +1094,14 @@
/// A backend rule provides configuration for an individual API element.
class BackendRule {
- /// The address of the API backend.
- ///
- /// The scheme is used to determine the backend protocol and security.
- /// The following schemes are accepted:
- ///
- /// SCHEME PROTOCOL SECURITY
- /// http:// HTTP None
- /// https:// HTTP TLS
- /// grpc:// gRPC None
- /// grpcs:// gRPC TLS
- ///
- /// It is recommended to explicitly include a scheme. Leaving out the scheme
- /// may cause constrasting behaviors across platforms.
- ///
- /// If the port is unspecified, the default is:
- /// - 80 for schemes without TLS
- /// - 443 for schemes with TLS
- ///
- /// For HTTP backends, use protocol
- /// to specify the protocol version.
+ /// The address of the API backend. The scheme is used to determine the
+ /// backend protocol and security. The following schemes are accepted: SCHEME
+ /// PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None
+ /// grpcs:// gRPC TLS It is recommended to explicitly include a scheme.
+ /// Leaving out the scheme may cause constrasting behaviors across platforms.
+ /// If the port is unspecified, the default is: - 80 for schemes without TLS -
+ /// 443 for schemes with TLS For HTTP backends, use protocol to specify the
+ /// protocol version.
core.String address;
/// The number of seconds to wait for a response from a request. The default
@@ -1135,112 +1131,42 @@
/// Possible string values are:
/// - "PATH_TRANSLATION_UNSPECIFIED"
/// - "CONSTANT_ADDRESS" : Use the backend address as-is, with no modification
- /// to the path. If the
- /// URL pattern contains variables, the variable names and values will be
- /// appended to the query string. If a query string parameter and a URL
- /// pattern variable have the same name, this may result in duplicate keys in
- /// the query string.
- ///
- /// # Examples
- ///
- /// Given the following operation config:
- ///
- /// Method path: /api/company/{cid}/user/{uid}
- /// Backend address: https://example.cloudfunctions.net/getUser
- ///
- /// Requests to the following request paths will call the backend at the
- /// translated path:
- ///
- /// Request path: /api/company/widgetworks/user/johndoe
- /// Translated:
+ /// to the path. If the URL pattern contains variables, the variable names and
+ /// values will be appended to the query string. If a query string parameter
+ /// and a URL pattern variable have the same name, this may result in
+ /// duplicate keys in the query string. # Examples Given the following
+ /// operation config: Method path: /api/company/{cid}/user/{uid} Backend
+ /// address: https://example.cloudfunctions.net/getUser Requests to the
+ /// following request paths will call the backend at the translated path:
+ /// Request path: /api/company/widgetworks/user/johndoe Translated:
/// https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe
- ///
- /// Request path: /api/company/widgetworks/user/johndoe?timezone=EST
- /// Translated:
+ /// Request path: /api/company/widgetworks/user/johndoe?timezone=EST
+ /// Translated:
/// https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe
/// - "APPEND_PATH_TO_ADDRESS" : The request path will be appended to the
- /// backend address.
- ///
- /// # Examples
- ///
- /// Given the following operation config:
- ///
- /// Method path: /api/company/{cid}/user/{uid}
- /// Backend address: https://example.appspot.com
- ///
- /// Requests to the following request paths will call the backend at the
- /// translated path:
- ///
- /// Request path: /api/company/widgetworks/user/johndoe
- /// Translated:
- /// https://example.appspot.com/api/company/widgetworks/user/johndoe
- ///
- /// Request path: /api/company/widgetworks/user/johndoe?timezone=EST
- /// Translated:
+ /// backend address. # Examples Given the following operation config: Method
+ /// path: /api/company/{cid}/user/{uid} Backend address:
+ /// https://example.appspot.com Requests to the following request paths will
+ /// call the backend at the translated path: Request path:
+ /// /api/company/widgetworks/user/johndoe Translated:
+ /// https://example.appspot.com/api/company/widgetworks/user/johndoe Request
+ /// path: /api/company/widgetworks/user/johndoe?timezone=EST Translated:
/// https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST
core.String pathTranslation;
- /// The protocol used for sending a request to the backend.
- /// The supported values are "http/1.1" and "h2".
- ///
- /// The default value is inferred from the scheme in the
- /// address field:
- ///
- /// SCHEME PROTOCOL
- /// http:// http/1.1
- /// https:// http/1.1
- /// grpc:// h2
- /// grpcs:// h2
- ///
- /// For secure HTTP backends (https://) that support HTTP/2, set this field
- /// to "h2" for improved performance.
- ///
+ /// The protocol used for sending a request to the backend. The supported
+ /// values are "http/1.1" and "h2". The default value is inferred from the
+ /// scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https://
+ /// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that
+ /// support HTTP/2, set this field to "h2" for improved performance.
/// Configuring this field to non-default values is only supported for secure
- /// HTTP backends. This field will be ignored for all other backends.
- ///
- /// See
+ /// HTTP backends. This field will be ignored for all other backends. See
/// https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
/// for more details on the supported values.
core.String protocol;
- /// Unimplemented. Do not use.
- ///
- /// The new name the selected proto elements should be renamed to.
- ///
- /// The package, the service and the method can all be renamed.
- /// The backend server should implement the renamed proto. However, clients
- /// should call the original method, and ESF routes the traffic to the renamed
- /// method.
- ///
- /// HTTP clients should call the URL mapped to the original method.
- /// gRPC and Stubby clients should call the original method with package name.
- ///
- /// For legacy reasons, ESF allows Stubby clients to call with the
- /// short name (without the package name). However, for API Versioning(or
- /// multiple methods mapped to the same short name), all Stubby clients must
- /// call the method's full name with the package name, otherwise the first one
- /// (selector) wins.
- ///
- /// If this `rename_to` is specified with a trailing `*`, the `selector` must
- /// be specified with a trailing `*` as well. The all element short names
- /// matched by the `*` in the selector will be kept in the `rename_to`.
- ///
- /// For example,
- /// rename_rules:
- /// - selector: |-
- /// google.example.library.v1.*
- /// rename_to: google.example.library.*
- ///
- /// The selector matches `google.example.library.v1.Library.CreateShelf` and
- /// `google.example.library.v1.Library.CreateBook`, they will be renamed to
- /// `google.example.library.Library.CreateShelf` and
- /// `google.example.library.Library.CreateBook`. It essentially renames the
- /// proto package name section of the matched proto service and methods.
- core.String renameTo;
-
- /// Selects the methods to which this rule applies.
- ///
- /// Refer to selector for syntax details.
+ /// Selects the methods to which this rule applies. Refer to selector for
+ /// syntax details.
core.String selector;
BackendRule();
@@ -1270,9 +1196,6 @@
if (_json.containsKey("protocol")) {
protocol = _json["protocol"];
}
- if (_json.containsKey("renameTo")) {
- renameTo = _json["renameTo"];
- }
if (_json.containsKey("selector")) {
selector = _json["selector"];
}
@@ -1305,9 +1228,6 @@
if (protocol != null) {
_json["protocol"] = protocol;
}
- if (renameTo != null) {
- _json["renameTo"] = renameTo;
- }
if (selector != null) {
_json["selector"] = selector;
}
@@ -1367,18 +1287,12 @@
/// Request message for the `BatchEnableServices` method.
class BatchEnableServicesRequest {
- /// The identifiers of the services to enable on the project.
- ///
- /// A valid identifier would be:
- /// serviceusage.googleapis.com
- ///
- /// Enabling services requires that each service is public or is shared with
- /// the user enabling the service.
- ///
- /// A single request can enable a maximum of 20 services at a time. If more
- /// than 20 services are specified, the request will fail, and no state
- /// changes
- /// will occur.
+ /// The identifiers of the services to enable on the project. A valid
+ /// identifier would be: serviceusage.googleapis.com Enabling services
+ /// requires that each service is public or is shared with the user enabling
+ /// the service. A single request can enable a maximum of 20 services at a
+ /// time. If more than 20 services are specified, the request will fail, and
+ /// no state changes will occur.
core.List<core.String> serviceIds;
BatchEnableServicesRequest();
@@ -1399,9 +1313,9 @@
}
}
-/// Response message for the `BatchEnableServices` method.
-/// This response message is assigned to the `response` field of the returned
-/// Operation when that operation is done.
+/// Response message for the `BatchEnableServices` method. This response message
+/// is assigned to the `response` field of the returned Operation when that
+/// operation is done.
class BatchEnableServicesResponse {
/// If allow_partial_success is true, and one or more services could not be
/// enabled, this field contains the details about each failure.
@@ -1465,33 +1379,27 @@
}
}
-/// Billing related configuration of the service.
-///
-/// The following example shows how to configure monitored resources and metrics
-/// for billing:
-///
-/// monitored_resources:
-/// - type: library.googleapis.com/branch
-/// labels:
-/// - key: /city
-/// description: The city where the library branch is located in.
-/// - key: /name
-/// description: The name of the branch.
-/// metrics:
-/// - name: library.googleapis.com/book/borrowed_count
-/// metric_kind: DELTA
-/// value_type: INT64
-/// billing:
-/// consumer_destinations:
-/// - monitored_resource: library.googleapis.com/branch
-/// metrics:
-/// - library.googleapis.com/book/borrowed_count
+/// Billing related configuration of the service. The following example shows
+/// how to configure monitored resources and metrics for billing,
+/// `consumer_destinations` is the only supported destination and the monitored
+/// resources need at least one label key `cloud.googleapis.com/location` to
+/// indicate the location of the billing usage, using different monitored
+/// resources between monitoring and billing is recommended so they can be
+/// evolved independently: monitored_resources: - type:
+/// library.googleapis.com/billing_branch labels: - key:
+/// cloud.googleapis.com/location description: | Predefined label to support
+/// billing location restriction. - key: city description: | Custom label to
+/// define the city where the library branch is located in. - key: name
+/// description: Custom label to define the name of the library branch. metrics:
+/// - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA
+/// value_type: INT64 unit: "1" billing: consumer_destinations: -
+/// monitored_resource: library.googleapis.com/billing_branch metrics: -
+/// library.googleapis.com/book/borrowed_count
class Billing {
- /// Billing configurations for sending metrics to the consumer project.
- /// There can be multiple consumer destinations per service, each one must
- /// have
- /// a different monitored resource type. A metric can be used in at most
- /// one consumer destination.
+ /// Billing configurations for sending metrics to the consumer project. There
+ /// can be multiple consumer destinations per service, each one must have a
+ /// different monitored resource type. A metric can be used in at most one
+ /// consumer destination.
core.List<BillingDestination> consumerDestinations;
Billing();
@@ -1516,11 +1424,11 @@
}
}
-/// Configuration of a specific billing destination (Currently only support
-/// bill against consumer project).
+/// Configuration of a specific billing destination (Currently only support bill
+/// against consumer project).
class BillingDestination {
- /// Names of the metrics to report to this billing destination.
- /// Each name must be defined in Service.metrics section.
+ /// Names of the metrics to report to this billing destination. Each name must
+ /// be defined in Service.metrics section.
core.List<core.String> metrics;
/// The monitored resource type. The type must be defined in
@@ -1564,46 +1472,22 @@
}
}
-/// `Context` defines which contexts an API requests.
-///
-/// Example:
-///
-/// context:
-/// rules:
-/// - selector: "*"
-/// requested:
-/// - google.rpc.context.ProjectContext
-/// - google.rpc.context.OriginContext
-///
-/// The above specifies that all methods in the API request
-/// `google.rpc.context.ProjectContext` and
-/// `google.rpc.context.OriginContext`.
-///
-/// Available context types are defined in package
-/// `google.rpc.context`.
-///
-/// This also provides mechanism to whitelist any protobuf message extension
-/// that
-/// can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
-/// “x-goog-ext-<extension_id>-jspb” format. For example, list any service
-/// specific protobuf types that can appear in grpc metadata as follows in your
-/// yaml file:
-///
-/// Example:
-///
-/// context:
-/// rules:
-/// - selector: "google.example.library.v1.LibraryService.CreateBook"
-/// allowed_request_extensions:
-/// - google.foo.v1.NewExtension
-/// allowed_response_extensions:
-/// - google.foo.v1.NewExtension
-///
-/// You can also specify extension ID instead of fully qualified extension name
-/// here.
+/// `Context` defines which contexts an API requests. Example: context: rules: -
+/// selector: "*" requested: - google.rpc.context.ProjectContext -
+/// google.rpc.context.OriginContext The above specifies that all methods in the
+/// API request `google.rpc.context.ProjectContext` and
+/// `google.rpc.context.OriginContext`. Available context types are defined in
+/// package `google.rpc.context`. This also provides mechanism to whitelist any
+/// protobuf message extension that can be sent in grpc metadata using
+/// “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any
+/// service specific protobuf types that can appear in grpc metadata as follows
+/// in your yaml file: Example: context: rules: - selector:
+/// "google.example.library.v1.LibraryService.CreateBook"
+/// allowed_request_extensions: - google.foo.v1.NewExtension
+/// allowed_response_extensions: - google.foo.v1.NewExtension You can also
+/// specify extension ID instead of fully qualified extension name here.
class Context {
/// A list of RPC context rules that apply to individual API methods.
- ///
/// **NOTE:** All service configuration rules follow "last one wins" order.
core.List<ContextRule> rules;
@@ -1644,9 +1528,8 @@
/// A list of full type names of requested contexts.
core.List<core.String> requested;
- /// Selects the methods to which this rule applies.
- ///
- /// Refer to selector for syntax details.
+ /// Selects the methods to which this rule applies. Refer to selector for
+ /// syntax details.
core.String selector;
ContextRule();
@@ -1693,12 +1576,12 @@
}
}
-/// Selects and configures the service controller used by the service. The
+/// Selects and configures the service controller used by the service. The
/// service controller handles features like abuse, quota, billing, logging,
/// monitoring, etc.
class Control {
- /// The service control environment to use. If empty, no control plane
- /// feature (like quota and billing) will be enabled.
+ /// The service control environment to use. If empty, no control plane feature
+ /// (like quota and billing) will be enabled.
core.String environment;
Control();
@@ -1719,19 +1602,12 @@
}
}
-/// Customize service error responses. For example, list any service
-/// specific protobuf types that can appear in error detail lists of
-/// error responses.
-///
-/// Example:
-///
-/// custom_error:
-/// types:
-/// - google.foo.v1.CustomError
-/// - google.foo.v1.AnotherError
+/// Customize service error responses. For example, list any service specific
+/// protobuf types that can appear in error detail lists of error responses.
+/// Example: custom_error: types: - google.foo.v1.CustomError -
+/// google.foo.v1.AnotherError
class CustomError {
/// The list of custom error rules that apply to individual API messages.
- ///
/// **NOTE:** All service configuration rules follow "last one wins" order.
core.List<CustomErrorRule> rules;
@@ -1766,13 +1642,12 @@
/// A custom error rule.
class CustomErrorRule {
- /// Mark this message as possible payload in error response. Otherwise,
+ /// Mark this message as possible payload in error response. Otherwise,
/// objects of this type will be filtered when they appear in error payload.
core.bool isErrorType;
- /// Selects messages to which this rule applies.
- ///
- /// Refer to selector for syntax details.
+ /// Selects messages to which this rule applies. Refer to selector for syntax
+ /// details.
core.String selector;
CustomErrorRule();
@@ -1833,6 +1708,16 @@
/// Request message for the `DisableService` method.
class DisableServiceRequest {
+ /// Defines the behavior for checking service usage when disabling a service.
+ /// Possible string values are:
+ /// - "CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED" : When unset, the default
+ /// behavior is used, which is SKIP.
+ /// - "SKIP" : If set, skip checking service usage when disabling a service.
+ /// - "CHECK" : If set, service usage is checked when disabling the service.
+ /// If a service, or its dependents, has usage in the last 30 days, the
+ /// request returns a FAILED_PRECONDITION error.
+ core.String checkIfServiceHasUsage;
+
/// Indicates if services that are enabled and which depend on this service
/// should also be disabled. If not set, an error will be generated if any
/// enabled services depend on the service to be disabled. When set, the
@@ -1843,6 +1728,9 @@
DisableServiceRequest();
DisableServiceRequest.fromJson(core.Map _json) {
+ if (_json.containsKey("checkIfServiceHasUsage")) {
+ checkIfServiceHasUsage = _json["checkIfServiceHasUsage"];
+ }
if (_json.containsKey("disableDependentServices")) {
disableDependentServices = _json["disableDependentServices"];
}
@@ -1851,6 +1739,9 @@
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
+ if (checkIfServiceHasUsage != null) {
+ _json["checkIfServiceHasUsage"] = checkIfServiceHasUsage;
+ }
if (disableDependentServices != null) {
_json["disableDependentServices"] = disableDependentServices;
}
@@ -1858,9 +1749,9 @@
}
}
-/// Response message for the `DisableService` method.
-/// This response message is assigned to the `response` field of the returned
-/// Operation when that operation is done.
+/// Response message for the `DisableService` method. This response message is
+/// assigned to the `response` field of the returned Operation when that
+/// operation is done.
class DisableServiceResponse {
/// The new state of the service after disabling.
GoogleApiServiceusageV1Service service;
@@ -1883,96 +1774,60 @@
}
}
-/// `Documentation` provides the information for describing a service.
-///
-/// Example:
-/// <pre><code>documentation:
-/// summary: >
-/// The Google Calendar API gives access
-/// to most calendar features.
-/// pages:
-/// - name: Overview
-/// content: (== include google/foo/overview.md ==)
-/// - name: Tutorial
-/// content: (== include google/foo/tutorial.md ==)
-/// subpages;
-/// - name: Java
-/// content: (== include google/foo/tutorial_java.md ==)
-/// rules:
-/// - selector: google.calendar.Calendar.Get
-/// description: >
-/// ...
-/// - selector: google.calendar.Calendar.Put
-/// description: >
-/// ...
-/// </code></pre>
-/// Documentation is provided in markdown syntax. In addition to
-/// standard markdown features, definition lists, tables and fenced
-/// code blocks are supported. Section headers can be provided and are
-/// interpreted relative to the section nesting of the context where
-/// a documentation fragment is embedded.
-///
-/// Documentation from the IDL is merged with documentation defined
-/// via the config at normalization time, where documentation provided
-/// by config rules overrides IDL provided.
-///
-/// A number of constructs specific to the API platform are supported
-/// in documentation text.
-///
-/// In order to reference a proto element, the following
-/// notation can be used:
-/// <pre><code>[fully.qualified.proto.name][]</code></pre>
-/// To override the display text used for the link, this can be used:
-/// <pre><code>[display text][fully.qualified.proto.name]</code></pre>
-/// Text can be excluded from doc using the following notation:
-/// <pre><code>(-- internal comment --)</code></pre>
-///
-/// A few directives are available in documentation. Note that
-/// directives must appear on a single line to be properly
-/// identified. The `include` directive includes a markdown file from
-/// an external source:
-/// <pre><code>(== include path/to/file ==)</code></pre>
-/// The `resource_for` directive marks a message to be the resource of
-/// a collection in REST view. If it is not specified, tools attempt
-/// to infer the resource from the operations in a collection:
-/// <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
-/// The directive `suppress_warning` does not directly affect documentation
-/// and is documented together with service config validation.
+/// `Documentation` provides the information for describing a service. Example:
+/// documentation: summary: > The Google Calendar API gives access to most
+/// calendar features. pages: - name: Overview content: (== include
+/// google/foo/overview.md ==) - name: Tutorial content: (== include
+/// google/foo/tutorial.md ==) subpages; - name: Java content: (== include
+/// google/foo/tutorial_java.md ==) rules: - selector:
+/// google.calendar.Calendar.Get description: > ... - selector:
+/// google.calendar.Calendar.Put description: > ... Documentation is provided in
+/// markdown syntax. In addition to standard markdown features, definition
+/// lists, tables and fenced code blocks are supported. Section headers can be
+/// provided and are interpreted relative to the section nesting of the context
+/// where a documentation fragment is embedded. Documentation from the IDL is
+/// merged with documentation defined via the config at normalization time,
+/// where documentation provided by config rules overrides IDL provided. A
+/// number of constructs specific to the API platform are supported in
+/// documentation text. In order to reference a proto element, the following
+/// notation can be used: [fully.qualified.proto.name][] To override the display
+/// text used for the link, this can be used: [display
+/// text][fully.qualified.proto.name] Text can be excluded from doc using the
+/// following notation: (-- internal comment --) A few directives are available
+/// in documentation. Note that directives must appear on a single line to be
+/// properly identified. The `include` directive includes a markdown file from
+/// an external source: (== include path/to/file ==) The `resource_for`
+/// directive marks a message to be the resource of a collection in REST view.
+/// If it is not specified, tools attempt to infer the resource from the
+/// operations in a collection: (== resource_for v1.shelves.books ==) The
+/// directive `suppress_warning` does not directly affect documentation and is
+/// documented together with service config validation.
class Documentation {
/// The URL to the root of documentation.
core.String documentationRootUrl;
- /// Declares a single overview page. For example:
- /// <pre><code>documentation:
- /// summary: ...
- /// overview: (== include overview.md ==)
- /// </code></pre>
- /// This is a shortcut for the following declaration (using pages style):
- /// <pre><code>documentation:
- /// summary: ...
- /// pages:
- /// - name: Overview
- /// content: (== include overview.md ==)
- /// </code></pre>
- /// Note: you cannot specify both `overview` field and `pages` field.
+ /// Declares a single overview page. For example: documentation: summary: ...
+ /// overview: (== include overview.md ==) This is a shortcut for the following
+ /// declaration (using pages style): documentation: summary: ... pages: -
+ /// name: Overview content: (== include overview.md ==) Note: you cannot
+ /// specify both `overview` field and `pages` field.
core.String overview;
/// The top level pages for the documentation set.
core.List<Page> pages;
/// A list of documentation rules that apply to individual API elements.
- ///
/// **NOTE:** All service configuration rules follow "last one wins" order.
core.List<DocumentationRule> rules;
- /// Specifies the service root url if the default one (the service name
- /// from the yaml file) is not suitable. This can be seen in any fully
- /// specified service urls as well as sections that show a base that other
- /// urls are relative to.
+ /// Specifies the service root url if the default one (the service name from
+ /// the yaml file) is not suitable. This can be seen in any fully specified
+ /// service urls as well as sections that show a base that other urls are
+ /// relative to.
core.String serviceRootUrl;
- /// A short summary of what the service does. Can only be provided by
- /// plain text.
+ /// A short summary of what the service does. Can only be provided by plain
+ /// text.
core.String summary;
Documentation();
@@ -2077,13 +1932,9 @@
/// A generic empty message that you can re-use to avoid defining duplicated
/// empty messages in your APIs. A typical example is to use it as the request
-/// or the response type of an API method. For instance:
-///
-/// service Foo {
-/// rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
-/// }
-///
-/// The JSON representation for `Empty` is empty JSON object `{}`.
+/// or the response type of an API method. For instance: service Foo { rpc
+/// Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
+/// representation for `Empty` is empty JSON object `{}`.
class Empty {
Empty();
@@ -2141,9 +1992,9 @@
}
}
-/// Response message for the `EnableService` method.
-/// This response message is assigned to the `response` field of the returned
-/// Operation when that operation is done.
+/// Response message for the `EnableService` method. This response message is
+/// assigned to the `response` field of the returned Operation when that
+/// operation is done.
class EnableServiceResponse {
/// The new state of the service after enabling.
GoogleApiServiceusageV1Service service;
@@ -2166,48 +2017,34 @@
}
}
-/// `Endpoint` describes a network endpoint that serves a set of APIs.
-/// A service may expose any number of endpoints, and all endpoints share the
-/// same service configuration, such as quota configuration and monitoring
-/// configuration.
-///
-/// Example service configuration:
-///
-/// name: library-example.googleapis.com
-/// endpoints:
-/// # Below entry makes 'google.example.library.v1.Library'
-/// # API be served from endpoint address library-example.googleapis.com.
-/// # It also allows HTTP OPTIONS calls to be passed to the backend, for
-/// # it to decide whether the subsequent cross-origin request is
-/// # allowed to proceed.
-/// - name: library-example.googleapis.com
-/// allow_cors: true
+/// `Endpoint` describes a network endpoint that serves a set of APIs. A service
+/// may expose any number of endpoints, and all endpoints share the same service
+/// configuration, such as quota configuration and monitoring configuration.
+/// Example service configuration: name: library-example.googleapis.com
+/// endpoints: # Below entry makes 'google.example.library.v1.Library' # API be
+/// served from endpoint address library-example.googleapis.com. # It also
+/// allows HTTP OPTIONS calls to be passed to the backend, for # it to decide
+/// whether the subsequent cross-origin request is # allowed to proceed. - name:
+/// library-example.googleapis.com allow_cors: true
class Endpoint {
/// DEPRECATED: This field is no longer supported. Instead of using aliases,
/// please specify multiple google.api.Endpoint for each of the intended
- /// aliases.
- ///
- /// Additional names that this endpoint will be hosted on.
+ /// aliases. Additional names that this endpoint will be hosted on.
core.List<core.String> aliases;
/// Allowing
/// [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
/// cross-domain traffic, would allow the backends served from this endpoint
- /// to
- /// receive and respond to HTTP OPTIONS requests. The response will be used by
- /// the browser to determine whether the subsequent cross-origin request is
+ /// to receive and respond to HTTP OPTIONS requests. The response will be used
+ /// by the browser to determine whether the subsequent cross-origin request is
/// allowed to proceed.
core.bool allowCors;
- /// The list of features enabled on this endpoint.
- core.List<core.String> features;
-
/// The canonical name of this endpoint.
core.String name;
/// The specification of an Internet routable address of API frontend that
- /// will
- /// handle requests to this [API
+ /// will handle requests to this [API
/// Endpoint](https://cloud.google.com/apis/design/glossary). It should be
/// either a valid IPv4 address or a fully-qualified domain name. For example,
/// "8.8.8.8" or "myservice.appspot.com".
@@ -2222,9 +2059,6 @@
if (_json.containsKey("allowCors")) {
allowCors = _json["allowCors"];
}
- if (_json.containsKey("features")) {
- features = (_json["features"] as core.List).cast<core.String>();
- }
if (_json.containsKey("name")) {
name = _json["name"];
}
@@ -2242,9 +2076,6 @@
if (allowCors != null) {
_json["allowCors"] = allowCors;
}
- if (features != null) {
- _json["features"] = features;
- }
if (name != null) {
_json["name"] = name;
}
@@ -2419,8 +2250,8 @@
/// Whether to use alternative packed wire representation.
core.bool packed;
- /// The field type URL, without the scheme, for message or enumeration
- /// types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
+ /// The field type URL, without the scheme, for message or enumeration types.
+ /// Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
core.String typeUrl;
Field();
@@ -2501,15 +2332,13 @@
class GetServiceIdentityResponse {
/// Service identity that service producer can use to access consumer
/// resources. If exists is true, it contains email and unique_id. If exists
- /// is
- /// false, it contains pre-constructed email and empty unique_id.
+ /// is false, it contains pre-constructed email and empty unique_id.
ServiceIdentity identity;
/// Service identity state.
/// Possible string values are:
/// - "IDENTITY_STATE_UNSPECIFIED" : Default service identity state. This
- /// value is used if the state is
- /// omitted.
+ /// value is used if the state is omitted.
/// - "ACTIVE" : Service identity has been created and can be used.
core.String state;
@@ -2538,29 +2367,16 @@
}
/// `Service` is the root object of Google service configuration schema. It
-/// describes basic information about a service, such as the name and the
-/// title, and delegates other aspects to sub-sections. Each sub-section is
-/// either a proto message or a repeated proto message that configures a
-/// specific aspect, such as auth. See each proto message definition for
-/// details.
-///
-/// Example:
-///
-/// type: google.api.Service
-/// config_version: 3
-/// name: calendar.googleapis.com
-/// title: Google Calendar API
-/// apis:
-/// - name: google.calendar.v3.Calendar
-/// authentication:
-/// providers:
-/// - id: google_calendar_auth
-/// jwks_uri: https://www.googleapis.com/oauth2/v1/certs
-/// issuer: https://securetoken.google.com
-/// rules:
-/// - selector: "*"
-/// requirements:
-/// provider_id: google_calendar_auth
+/// describes basic information about a service, such as the name and the title,
+/// and delegates other aspects to sub-sections. Each sub-section is either a
+/// proto message or a repeated proto message that configures a specific aspect,
+/// such as auth. See each proto message definition for details. Example: type:
+/// google.api.Service config_version: 3 name: calendar.googleapis.com title:
+/// Google Calendar API apis: - name: google.calendar.v3.Calendar
+/// authentication: providers: - id: google_calendar_auth jwks_uri:
+/// https://www.googleapis.com/oauth2/v1/certs issuer:
+/// https://securetoken.google.com rules: - selector: "*" requirements:
+/// provider_id: google_calendar_auth
class GoogleApiService {
/// A list of API interfaces exported by this service. Only the `name` field
/// of the google.protobuf.Api needs to be provided by the configuration
@@ -2580,9 +2396,8 @@
/// The semantic version of the service configuration. The config version
/// affects the interpretation of the service configuration. For example,
- /// certain features are enabled by default for certain config versions.
- ///
- /// The latest config version is `3`.
+ /// certain features are enabled by default for certain config versions. The
+ /// latest config version is `3`.
core.int configVersion;
/// Context configuration.
@@ -2597,28 +2412,24 @@
/// Additional API documentation.
Documentation documentation;
- /// Configuration for network endpoints. If this is empty, then an endpoint
+ /// Configuration for network endpoints. If this is empty, then an endpoint
/// with the same name as the service is automatically generated to service
- /// all
- /// defined APIs.
+ /// all defined APIs.
core.List<Endpoint> endpoints;
- /// A list of all enum types included in this API service. Enums
- /// referenced directly or indirectly by the `apis` are automatically
- /// included. Enums which are not referenced but shall be included
- /// should be listed here by name. Example:
- ///
- /// enums:
- /// - name: google.someapi.v1.SomeEnum
+ /// A list of all enum types included in this API service. Enums referenced
+ /// directly or indirectly by the `apis` are automatically included. Enums
+ /// which are not referenced but shall be included should be listed here by
+ /// name. Example: enums: - name: google.someapi.v1.SomeEnum
core.List<Enum> enums;
/// HTTP configuration.
Http http;
- /// A unique ID for a specific instance of this message, typically assigned
- /// by the client for tracking purpose. Must be no longer than 63 characters
- /// and only lower case letters, digits, '.', '_' and '-' are allowed. If
- /// empty, the server may choose to generate one instead.
+ /// A unique ID for a specific instance of this message, typically assigned by
+ /// the client for tracking purpose. Must be no longer than 63 characters and
+ /// only lower case letters, digits, '.', '_' and '-' are allowed. If empty,
+ /// the server may choose to generate one instead.
core.String id;
/// Logging configuration.
@@ -2630,17 +2441,17 @@
/// Defines the metrics used by this service.
core.List<MetricDescriptor> metrics;
- /// Defines the monitored resources used by this service. This is required
- /// by the Service.monitoring and Service.logging configurations.
+ /// Defines the monitored resources used by this service. This is required by
+ /// the Service.monitoring and Service.logging configurations.
core.List<MonitoredResourceDescriptor> monitoredResources;
/// Monitoring configuration.
Monitoring monitoring;
- /// The service name, which is a DNS-like logical identifier for the
- /// service, such as `calendar.googleapis.com`. The service name
- /// typically goes through DNS verification to make sure the owner
- /// of the service also owns the DNS name.
+ /// The service name, which is a DNS-like logical identifier for the service,
+ /// such as `calendar.googleapis.com`. The service name typically goes through
+ /// DNS verification to make sure the owner of the service also owns the DNS
+ /// name.
core.String name;
/// The Google project that owns this service.
@@ -2655,24 +2466,21 @@
/// System parameter configuration.
SystemParameters systemParameters;
- /// A list of all proto message types included in this API service.
- /// It serves similar purpose as [google.api.Service.types], except that
- /// these types are not needed by user-defined APIs. Therefore, they will not
- /// show up in the generated discovery doc. This field should only be used
- /// to define system APIs in ESF.
+ /// A list of all proto message types included in this API service. It serves
+ /// similar purpose as [google.api.Service.types], except that these types are
+ /// not needed by user-defined APIs. Therefore, they will not show up in the
+ /// generated discovery doc. This field should only be used to define system
+ /// APIs in ESF.
core.List<Type> systemTypes;
/// The product title for this service.
core.String title;
- /// A list of all proto message types included in this API service.
- /// Types referenced directly or indirectly by the `apis` are
- /// automatically included. Messages which are not referenced but
- /// shall be included, such as types used by the `google.protobuf.Any` type,
- /// should be listed here by name. Example:
- ///
- /// types:
- /// - name: google.protobuf.Int32
+ /// A list of all proto message types included in this API service. Types
+ /// referenced directly or indirectly by the `apis` are automatically
+ /// included. Messages which are not referenced but shall be included, such as
+ /// types used by the `google.protobuf.Any` type, should be listed here by
+ /// name. Example: types: - name: google.protobuf.Int32
core.List<Type> types;
/// Configuration controlling usage of this service.
@@ -2873,30 +2681,22 @@
}
}
-/// The per-product per-project service identity for a service.
-///
-///
-/// Use this field to configure per-product per-project service identity.
-/// Example of a service identity configuration.
-///
-/// usage:
-/// service_identity:
-/// - service_account_parent: "projects/123456789"
-/// display_name: "Cloud XXX Service Agent"
-/// description: "Used as the identity of Cloud XXX to access resources"
+/// The per-product per-project service identity for a service. Use this field
+/// to configure per-product per-project service identity. Example of a service
+/// identity configuration. usage: service_identity: - service_account_parent:
+/// "projects/123456789" display_name: "Cloud XXX Service Agent" description:
+/// "Used as the identity of Cloud XXX to access resources"
class GoogleApiServiceIdentity {
- /// Optional. A user-specified opaque description of the service account.
- /// Must be less than or equal to 256 UTF-8 bytes.
+ /// Optional. A user-specified opaque description of the service account. Must
+ /// be less than or equal to 256 UTF-8 bytes.
core.String description;
- /// Optional. A user-specified name for the service account.
- /// Must be less than or equal to 100 UTF-8 bytes.
+ /// Optional. A user-specified name for the service account. Must be less than
+ /// or equal to 100 UTF-8 bytes.
core.String displayName;
- /// A service account project that hosts the service accounts.
- ///
- /// An example name would be:
- /// `projects/123456789`
+ /// A service account project that hosts the service accounts. An example name
+ /// would be: `projects/123456789`
core.String serviceAccountParent;
GoogleApiServiceIdentity();
@@ -2931,8 +2731,8 @@
/// The operation metadata returned for the batchend services operation.
class GoogleApiServiceusageV1OperationMetadata {
- /// The full name of the resources that this operation is directly
- /// associated with.
+ /// The full name of the resources that this operation is directly associated
+ /// with.
core.List<core.String> resourceNames;
GoogleApiServiceusageV1OperationMetadata();
@@ -2955,33 +2755,27 @@
/// A service that is available for use by the consumer.
class GoogleApiServiceusageV1Service {
- /// The service configuration of the available service.
- /// Some fields may be filtered out of the configuration in responses to
- /// the `ListServices` method. These fields are present only in responses to
- /// the `GetService` method.
+ /// The service configuration of the available service. Some fields may be
+ /// filtered out of the configuration in responses to the `ListServices`
+ /// method. These fields are present only in responses to the `GetService`
+ /// method.
GoogleApiServiceusageV1ServiceConfig config;
- /// The resource name of the consumer and service.
- ///
- /// A valid name would be:
- /// - projects/123/services/serviceusage.googleapis.com
+ /// The resource name of the consumer and service. A valid name would be: -
+ /// projects/123/services/serviceusage.googleapis.com
core.String name;
- /// The resource name of the consumer.
- ///
- /// A valid name would be:
- /// - projects/123
+ /// The resource name of the consumer. A valid name would be: - projects/123
core.String parent;
/// Whether or not the service has been enabled for use by the consumer.
/// Possible string values are:
/// - "STATE_UNSPECIFIED" : The default value, which indicates that the
- /// enabled state of the service
- /// is unspecified or not meaningful. Currently, all consumers other than
- /// projects (such as folders and organizations) are always in this state.
+ /// enabled state of the service is unspecified or not meaningful. Currently,
+ /// all consumers other than projects (such as folders and organizations) are
+ /// always in this state.
/// - "DISABLED" : The service cannot be used by this consumer. It has either
- /// been explicitly
- /// disabled, or has never been enabled.
+ /// been explicitly disabled, or has never been enabled.
/// - "ENABLED" : The service has been explicitly enabled for use by this
/// consumer.
core.String state;
@@ -3026,8 +2820,7 @@
/// The configuration of the service.
class GoogleApiServiceusageV1ServiceConfig {
/// A list of API interfaces exported by this service. Contains only the
- /// names,
- /// versions, and method names of the interfaces.
+ /// names, versions, and method names of the interfaces.
core.List<Api> apis;
/// Auth configuration. Contains only the OAuth rules.
@@ -3041,10 +2834,16 @@
/// of the endpoints.
core.List<Endpoint> endpoints;
- /// The DNS address at which this service is available.
- ///
- /// An example DNS address would be:
- /// `calendar.googleapis.com`.
+ /// Defines the monitored resources used by this service. This is required by
+ /// the Service.monitoring and Service.logging configurations.
+ core.List<MonitoredResourceDescriptor> monitoredResources;
+
+ /// Monitoring configuration. This should not include the
+ /// 'producer_destinations' field.
+ Monitoring monitoring;
+
+ /// The DNS address at which this service is available. An example DNS address
+ /// would be: `calendar.googleapis.com`.
core.String name;
/// Quota configuration.
@@ -3075,6 +2874,15 @@
.map<Endpoint>((value) => new Endpoint.fromJson(value))
.toList();
}
+ if (_json.containsKey("monitoredResources")) {
+ monitoredResources = (_json["monitoredResources"] as core.List)
+ .map<MonitoredResourceDescriptor>(
+ (value) => new MonitoredResourceDescriptor.fromJson(value))
+ .toList();
+ }
+ if (_json.containsKey("monitoring")) {
+ monitoring = new Monitoring.fromJson(_json["monitoring"]);
+ }
if (_json.containsKey("name")) {
name = _json["name"];
}
@@ -3104,6 +2912,13 @@
if (endpoints != null) {
_json["endpoints"] = endpoints.map((value) => (value).toJson()).toList();
}
+ if (monitoredResources != null) {
+ _json["monitoredResources"] =
+ monitoredResources.map((value) => (value).toJson()).toList();
+ }
+ if (monitoring != null) {
+ _json["monitoring"] = (monitoring).toJson();
+ }
if (name != null) {
_json["name"] = name;
}
@@ -3124,15 +2939,13 @@
class GoogleApiServiceusageV1beta1GetServiceIdentityResponse {
/// Service identity that service producer can use to access consumer
/// resources. If exists is true, it contains email and unique_id. If exists
- /// is
- /// false, it contains pre-constructed email and empty unique_id.
+ /// is false, it contains pre-constructed email and empty unique_id.
GoogleApiServiceusageV1beta1ServiceIdentity identity;
/// Service identity state.
/// Possible string values are:
/// - "IDENTITY_STATE_UNSPECIFIED" : Default service identity state. This
- /// value is used if the state is
- /// omitted.
+ /// value is used if the state is omitted.
/// - "ACTIVE" : Service identity has been created and can be used.
core.String state;
@@ -3198,20 +3011,16 @@
}
/// Defines the HTTP configuration for an API service. It contains a list of
-/// HttpRule, each specifying the mapping of an RPC method
-/// to one or more HTTP REST API methods.
+/// HttpRule, each specifying the mapping of an RPC method to one or more HTTP
+/// REST API methods.
class Http {
/// When set to true, URL path parameters will be fully URI-decoded except in
/// cases of single segment matches in reserved expansion, where "%2F" will be
- /// left encoded.
- ///
- /// The default behavior is to not decode RFC 6570 reserved characters in
- /// multi
- /// segment matches.
+ /// left encoded. The default behavior is to not decode RFC 6570 reserved
+ /// characters in multi segment matches.
core.bool fullyDecodeReservedExpansion;
/// A list of HTTP configuration rules that apply to individual API methods.
- ///
/// **NOTE:** All service configuration rules follow "last one wins" order.
core.List<HttpRule> rules;
@@ -3241,284 +3050,146 @@
}
}
-/// # gRPC Transcoding
-///
-/// gRPC Transcoding is a feature for mapping between a gRPC method and one or
-/// more HTTP REST endpoints. It allows developers to build a single API service
-/// that supports both gRPC APIs and REST APIs. Many systems, including [Google
-/// APIs](https://github.com/googleapis/googleapis),
-/// [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
-/// Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
-/// and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
-/// and use it for large scale production services.
-///
-/// `HttpRule` defines the schema of the gRPC/REST mapping. The mapping
-/// specifies
-/// how different portions of the gRPC request message are mapped to the URL
-/// path, URL query parameters, and HTTP request body. It also controls how the
-/// gRPC response message is mapped to the HTTP response body. `HttpRule` is
-/// typically specified as an `google.api.http` annotation on the gRPC method.
-///
-/// Each mapping specifies a URL path template and an HTTP method. The path
-/// template may refer to one or more fields in the gRPC request message, as
-/// long
-/// as each field is a non-repeated field with a primitive (non-message) type.
-/// The path template controls how fields of the request message are mapped to
-/// the URL path.
-///
-/// Example:
-///
-/// service Messaging {
-/// rpc GetMessage(GetMessageRequest) returns (Message) {
-/// option (google.api.http) = {
-/// get: "/v1/{name=messages / * }"
-/// };
-/// }
-/// }
-/// message GetMessageRequest {
-/// string name = 1; // Mapped to URL path.
-/// }
-/// message Message {
-/// string text = 1; // The resource content.
-/// }
-///
-/// This enables an HTTP REST to gRPC mapping as below:
-///
-/// HTTP | gRPC
-/// -----|-----
-/// `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
-///
-/// Any fields in the request message which are not bound by the path template
-/// automatically become HTTP query parameters if there is no HTTP request body.
-/// For example:
-///
-/// service Messaging {
-/// rpc GetMessage(GetMessageRequest) returns (Message) {
-/// option (google.api.http) = {
-/// get:"/v1/messages/{message_id}"
-/// };
-/// }
-/// }
-/// message GetMessageRequest {
-/// message SubMessage {
-/// string subfield = 1;
-/// }
-/// string message_id = 1; // Mapped to URL path.
-/// int64 revision = 2; // Mapped to URL query parameter `revision`.
-/// SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
-/// }
-///
-/// This enables a HTTP JSON to RPC mapping as below:
-///
-/// HTTP | gRPC
-/// -----|-----
-/// `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
-/// `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
-/// "foo"))`
-///
-/// Note that fields which are mapped to URL query parameters must have a
-/// primitive type or a repeated primitive type or a non-repeated message type.
-/// In the case of a repeated type, the parameter can be repeated in the URL
-/// as `...?param=A¶m=B`. In the case of a message type, each field of the
+/// # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC
+/// method and one or more HTTP REST endpoints. It allows developers to build a
+/// single API service that supports both gRPC APIs and REST APIs. Many systems,
+/// including [Google APIs](https://github.com/googleapis/googleapis), [Cloud
+/// Endpoints](https://cloud.google.com/endpoints), [gRPC
+/// Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and
+/// [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and
+/// use it for large scale production services. `HttpRule` defines the schema of
+/// the gRPC/REST mapping. The mapping specifies how different portions of the
+/// gRPC request message are mapped to the URL path, URL query parameters, and
+/// HTTP request body. It also controls how the gRPC response message is mapped
+/// to the HTTP response body. `HttpRule` is typically specified as an
+/// `google.api.http` annotation on the gRPC method. Each mapping specifies a
+/// URL path template and an HTTP method. The path template may refer to one or
+/// more fields in the gRPC request message, as long as each field is a
+/// non-repeated field with a primitive (non-message) type. The path template
+/// controls how fields of the request message are mapped to the URL path.
+/// Example: service Messaging { rpc GetMessage(GetMessageRequest) returns
+/// (Message) { option (google.api.http) = { get: "/v1/{name=messages / * }" };
+/// } } message GetMessageRequest { string name = 1; // Mapped to URL path. }
+/// message Message { string text = 1; // The resource content. } This enables
+/// an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET
+/// /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in
+/// the request message which are not bound by the path template automatically
+/// become HTTP query parameters if there is no HTTP request body. For example:
+/// service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) {
+/// option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message
+/// GetMessageRequest { message SubMessage { string subfield = 1; } string
+/// message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL
+/// query parameter `revision`. SubMessage sub = 3; // Mapped to URL query
+/// parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as
+/// below: HTTP | gRPC -----|----- `GET
+/// /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id:
+/// "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields
+/// which are mapped to URL query parameters must have a primitive type or a
+/// repeated primitive type or a non-repeated message type. In the case of a
+/// repeated type, the parameter can be repeated in the URL as
+/// `...?param=A¶m=B`. In the case of a message type, each field of the
/// message is mapped to a separate parameter, such as
-/// `...?foo.a=A&foo.b=B&foo.c=C`.
-///
-/// For HTTP methods that allow a request body, the `body` field
-/// specifies the mapping. Consider a REST update method on the
-/// message resource collection:
-///
-/// service Messaging {
-/// rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
-/// option (google.api.http) = {
-/// patch: "/v1/messages/{message_id}"
-/// body: "message"
-/// };
-/// }
-/// }
-/// message UpdateMessageRequest {
-/// string message_id = 1; // mapped to the URL
-/// Message message = 2; // mapped to the body
-/// }
-///
-/// The following HTTP JSON to RPC mapping is enabled, where the
-/// representation of the JSON in the request body is determined by
-/// protos JSON encoding:
-///
-/// HTTP | gRPC
-/// -----|-----
-/// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
-/// "123456" message { text: "Hi!" })`
-///
-/// The special name `*` can be used in the body mapping to define that
-/// every field not bound by the path template should be mapped to the
-/// request body. This enables the following alternative definition of
-/// the update method:
-///
-/// service Messaging {
-/// rpc UpdateMessage(Message) returns (Message) {
-/// option (google.api.http) = {
-/// patch: "/v1/messages/{message_id}"
-/// body: "*"
-/// };
-/// }
-/// }
-/// message Message {
-/// string message_id = 1;
-/// string text = 2;
-/// }
-///
-///
-/// The following HTTP JSON to RPC mapping is enabled:
-///
-/// HTTP | gRPC
-/// -----|-----
-/// `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
-/// "123456" text: "Hi!")`
-///
-/// Note that when using `*` in the body mapping, it is not possible to
-/// have HTTP parameters, as all fields not bound by the path end in
-/// the body. This makes this option more rarely used in practice when
-/// defining REST APIs. The common usage of `*` is in custom methods
-/// which don't use the URL at all for transferring data.
-///
-/// It is possible to define multiple HTTP methods for one RPC by using
-/// the `additional_bindings` option. Example:
-///
-/// service Messaging {
-/// rpc GetMessage(GetMessageRequest) returns (Message) {
-/// option (google.api.http) = {
-/// get: "/v1/messages/{message_id}"
-/// additional_bindings {
-/// get: "/v1/users/{user_id}/messages/{message_id}"
-/// }
-/// };
-/// }
-/// }
-/// message GetMessageRequest {
-/// string message_id = 1;
-/// string user_id = 2;
-/// }
-///
-/// This enables the following two alternative HTTP JSON to RPC mappings:
-///
-/// HTTP | gRPC
-/// -----|-----
-/// `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
+/// `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body,
+/// the `body` field specifies the mapping. Consider a REST update method on the
+/// message resource collection: service Messaging { rpc
+/// UpdateMessage(UpdateMessageRequest) returns (Message) { option
+/// (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" };
+/// } } message UpdateMessageRequest { string message_id = 1; // mapped to the
+/// URL Message message = 2; // mapped to the body } The following HTTP JSON to
+/// RPC mapping is enabled, where the representation of the JSON in the request
+/// body is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH
+/// /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456"
+/// message { text: "Hi!" })` The special name `*` can be used in the body
+/// mapping to define that every field not bound by the path template should be
+/// mapped to the request body. This enables the following alternative
+/// definition of the update method: service Messaging { rpc
+/// UpdateMessage(Message) returns (Message) { option (google.api.http) = {
+/// patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string
+/// message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is
+/// enabled: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { "text": "Hi!"
+/// }` | `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using
+/// `*` in the body mapping, it is not possible to have HTTP parameters, as all
+/// fields not bound by the path end in the body. This makes this option more
+/// rarely used in practice when defining REST APIs. The common usage of `*` is
+/// in custom methods which don't use the URL at all for transferring data. It
+/// is possible to define multiple HTTP methods for one RPC by using the
+/// `additional_bindings` option. Example: service Messaging { rpc
+/// GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) =
+/// { get: "/v1/messages/{message_id}" additional_bindings { get:
+/// "/v1/users/{user_id}/messages/{message_id}" } }; } } message
+/// GetMessageRequest { string message_id = 1; string user_id = 2; } This
+/// enables the following two alternative HTTP JSON to RPC mappings: HTTP | gRPC
+/// -----|----- `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
/// `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
-/// "123456")`
-///
-/// ## Rules for HTTP mapping
-///
-/// 1. Leaf request fields (recursive expansion nested messages in the request
-/// message) are classified into three categories:
-/// - Fields referred by the path template. They are passed via the URL path.
-/// - Fields referred by the HttpRule.body. They are passed via the HTTP
-/// request body.
-/// - All other fields are passed via the URL query parameters, and the
-/// parameter name is the field path in the request message. A repeated
-/// field can be represented as multiple query parameters under the same
-/// name.
-/// 2. If HttpRule.body is "*", there is no URL query parameter, all fields
-/// are passed via URL path and HTTP request body.
-/// 3. If HttpRule.body is omitted, there is no HTTP request body, all
-/// fields are passed via URL path and URL query parameters.
-///
-/// ### Path template syntax
-///
-/// Template = "/" Segments [ Verb ] ;
-/// Segments = Segment { "/" Segment } ;
-/// Segment = "*" | "**" | LITERAL | Variable ;
-/// Variable = "{" FieldPath [ "=" Segments ] "}" ;
-/// FieldPath = IDENT { "." IDENT } ;
-/// Verb = ":" LITERAL ;
-///
-/// The syntax `*` matches a single URL path segment. The syntax `**` matches
-/// zero or more URL path segments, which must be the last part of the URL path
-/// except the `Verb`.
-///
-/// The syntax `Variable` matches part of the URL path as specified by its
-/// template. A variable template must not contain other variables. If a
-/// variable
-/// matches a single path segment, its template may be omitted, e.g. `{var}`
-/// is equivalent to `{var=*}`.
-///
-/// The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
-/// contains any reserved character, such characters should be percent-encoded
-/// before the matching.
-///
-/// If a variable contains exactly one path segment, such as `"{var}"` or
-/// `"{var=*}"`, when such a variable is expanded into a URL path on the client
-/// side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
-/// server side does the reverse decoding. Such variables show up in the
-/// [Discovery
+/// "123456")` ## Rules for HTTP mapping 1. Leaf request fields (recursive
+/// expansion nested messages in the request message) are classified into three
+/// categories: - Fields referred by the path template. They are passed via the
+/// URL path. - Fields referred by the HttpRule.body. They are passed via the
+/// HTTP request body. - All other fields are passed via the URL query
+/// parameters, and the parameter name is the field path in the request message.
+/// A repeated field can be represented as multiple query parameters under the
+/// same name. 2. If HttpRule.body is "*", there is no URL query parameter, all
+/// fields are passed via URL path and HTTP request body. 3. If HttpRule.body is
+/// omitted, there is no HTTP request body, all fields are passed via URL path
+/// and URL query parameters. ### Path template syntax Template = "/" Segments [
+/// Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL
+/// | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath =
+/// IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single
+/// URL path segment. The syntax `**` matches zero or more URL path segments,
+/// which must be the last part of the URL path except the `Verb`. The syntax
+/// `Variable` matches part of the URL path as specified by its template. A
+/// variable template must not contain other variables. If a variable matches a
+/// single path segment, its template may be omitted, e.g. `{var}` is equivalent
+/// to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If
+/// the `LITERAL` contains any reserved character, such characters should be
+/// percent-encoded before the matching. If a variable contains exactly one path
+/// segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded
+/// into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]`
+/// are percent-encoded. The server side does the reverse decoding. Such
+/// variables show up in the [Discovery
/// Document](https://developers.google.com/discovery/v1/reference/apis) as
-/// `{var}`.
-///
-/// If a variable contains multiple path segments, such as `"{var=foo / * }"`
-/// or `"{var=**}"`, when such a variable is expanded into a URL path on the
-/// client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
-/// The server side does the reverse decoding, except "%2F" and "%2f" are left
-/// unchanged. Such variables show up in the
-/// [Discovery
+/// `{var}`. If a variable contains multiple path segments, such as `"{var=foo /
+/// * }"` or `"{var=**}"`, when such a variable is expanded into a URL path on
+/// the client side, all characters except `[-_.~/0-9a-zA-Z]` are
+/// percent-encoded. The server side does the reverse decoding, except "%2F" and
+/// "%2f" are left unchanged. Such variables show up in the [Discovery
/// Document](https://developers.google.com/discovery/v1/reference/apis) as
-/// `{+var}`.
-///
-/// ## Using gRPC API Service Configuration
-///
-/// gRPC API Service Configuration (service config) is a configuration language
-/// for configuring a gRPC service to become a user-facing product. The
-/// service config is simply the YAML representation of the `google.api.Service`
-/// proto message.
-///
-/// As an alternative to annotating your proto file, you can configure gRPC
+/// `{+var}`. ## Using gRPC API Service Configuration gRPC API Service
+/// Configuration (service config) is a configuration language for configuring a
+/// gRPC service to become a user-facing product. The service config is simply
+/// the YAML representation of the `google.api.Service` proto message. As an
+/// alternative to annotating your proto file, you can configure gRPC
/// transcoding in your service config YAML files. You do this by specifying a
/// `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
-/// effect as the proto annotation. This can be particularly useful if you
-/// have a proto that is reused in multiple services. Note that any transcoding
+/// effect as the proto annotation. This can be particularly useful if you have
+/// a proto that is reused in multiple services. Note that any transcoding
/// specified in the service config will override any matching transcoding
-/// configuration in the proto.
-///
-/// Example:
-///
-/// http:
-/// rules:
-/// # Selects a gRPC method and applies HttpRule to it.
-/// - selector: example.v1.Messaging.GetMessage
-/// get: /v1/messages/{message_id}/{sub.subfield}
-///
-/// ## Special notes
-///
-/// When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
-/// proto to JSON conversion must follow the [proto3
+/// configuration in the proto. Example: http: rules: # Selects a gRPC method
+/// and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get:
+/// /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC
+/// Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON
+/// conversion must follow the [proto3
/// specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
-///
-/// While the single segment variable follows the semantics of
-/// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
+/// While the single segment variable follows the semantics of [RFC
+/// 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
/// Expansion, the multi segment variable **does not** follow RFC 6570 Section
-/// 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
-/// does not expand special characters like `?` and `#`, which would lead
-/// to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
-/// for multi segment variables.
-///
-/// The path variables **must not** refer to any repeated or mapped field,
-/// because client libraries are not capable of handling such variable
-/// expansion.
-///
-/// The path variables **must not** capture the leading "/" character. The
-/// reason
-/// is that the most common use case "{var}" does not capture the leading "/"
-/// character. For consistency, all path variables must share the same behavior.
-///
-/// Repeated message fields must not be mapped to URL query parameters, because
-/// no client library can support such complicated mapping.
-///
-/// If an API needs to use a JSON array for request or response body, it can map
-/// the request or response body to a repeated field. However, some gRPC
-/// Transcoding implementations may not support this feature.
+/// 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not
+/// expand special characters like `?` and `#`, which would lead to invalid
+/// URLs. As the result, gRPC Transcoding uses a custom encoding for multi
+/// segment variables. The path variables **must not** refer to any repeated or
+/// mapped field, because client libraries are not capable of handling such
+/// variable expansion. The path variables **must not** capture the leading "/"
+/// character. The reason is that the most common use case "{var}" does not
+/// capture the leading "/" character. For consistency, all path variables must
+/// share the same behavior. Repeated message fields must not be mapped to URL
+/// query parameters, because no client library can support such complicated
+/// mapping. If an API needs to use a JSON array for request or response body,
+/// it can map the request or response body to a repeated field. However, some
+/// gRPC Transcoding implementations may not support this feature.
class HttpRule {
- /// Additional HTTP bindings for the selector. Nested bindings must
- /// not contain an `additional_bindings` field themselves (that is,
- /// the nesting may only be one level deep).
+ /// Additional HTTP bindings for the selector. Nested bindings must not
+ /// contain an `additional_bindings` field themselves (that is, the nesting
+ /// may only be one level deep).
core.List<HttpRule> additionalBindings;
/// When this flag is set to true, HTTP requests will be allowed to invoke a
@@ -3528,15 +3199,14 @@
/// The name of the request field whose value is mapped to the HTTP request
/// body, or `*` for mapping all request fields not captured by the path
/// pattern to the HTTP body, or omitted for not having any HTTP request body.
- ///
/// NOTE: the referred field must be present at the top-level of the request
/// message type.
core.String body;
/// The custom pattern is used for specifying an HTTP method that is not
- /// included in the `pattern` field, such as HEAD, or "*" to leave the
- /// HTTP method unspecified for this rule. The wild-card rule is useful
- /// for services that provide content to Web (HTML) clients.
+ /// included in the `pattern` field, such as HEAD, or "*" to leave the HTTP
+ /// method unspecified for this rule. The wild-card rule is useful for
+ /// services that provide content to Web (HTML) clients.
CustomHttpPattern custom;
/// Maps to HTTP DELETE. Used for deleting a resource.
@@ -3556,16 +3226,13 @@
core.String put;
/// Optional. The name of the response field whose value is mapped to the HTTP
- /// response body. When omitted, the entire response message will be used
- /// as the HTTP response body.
- ///
- /// NOTE: The referred field must be present at the top-level of the response
- /// message type.
+ /// response body. When omitted, the entire response message will be used as
+ /// the HTTP response body. NOTE: The referred field must be present at the
+ /// top-level of the response message type.
core.String responseBody;
- /// Selects a method to which this rule applies.
- ///
- /// Refer to selector for syntax details.
+ /// Selects a method to which this rule applies. Refer to selector for syntax
+ /// details.
core.String selector;
HttpRule();
@@ -3674,6 +3341,32 @@
}
}
+/// Response message for ImportAdminQuotaPolicies
+class ImportAdminQuotaPoliciesResponse {
+ /// The policies that were created from the imported data.
+ core.List<AdminQuotaPolicy> policies;
+
+ ImportAdminQuotaPoliciesResponse();
+
+ ImportAdminQuotaPoliciesResponse.fromJson(core.Map _json) {
+ if (_json.containsKey("policies")) {
+ policies = (_json["policies"] as core.List)
+ .map<AdminQuotaPolicy>(
+ (value) => new AdminQuotaPolicy.fromJson(value))
+ .toList();
+ }
+ }
+
+ core.Map<core.String, core.Object> toJson() {
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
+ if (policies != null) {
+ _json["policies"] = policies.map((value) => (value).toJson()).toList();
+ }
+ return _json;
+ }
+}
+
/// Response message for ImportConsumerOverrides
class ImportConsumerOverridesResponse {
/// The overrides that were created from the imported data.
@@ -3707,13 +3400,11 @@
/// Specifies URL query parameter name to extract JWT token.
core.String query;
- /// The value prefix. The value format is "value_prefix{token}"
- /// Only applies to "in" header type. Must be empty for "in" query type.
- /// If not empty, the header value has to match (case sensitive) this prefix.
- /// If not matched, JWT will not be extracted. If matched, JWT will be
- /// extracted after the prefix is removed.
- ///
- /// For example, for "Authorization: Bearer {JWT}",
+ /// The value prefix. The value format is "value_prefix{token}" Only applies
+ /// to "in" header type. Must be empty for "in" query type. If not empty, the
+ /// header value has to match (case sensitive) this prefix. If not matched,
+ /// JWT will not be extracted. If matched, JWT will be extracted after the
+ /// prefix is removed. For example, for "Authorization: Bearer {JWT}",
/// value_prefix="Bearer " with a space at the end.
core.String valuePrefix;
@@ -3829,8 +3520,7 @@
/// Response message for the `ListServices` method.
class ListServicesResponse {
- /// Token that can be passed to `ListServices` to resume a paginated
- /// query.
+ /// Token that can be passed to `ListServices` to resume a paginated query.
core.String nextPageToken;
/// The available services for the requested project.
@@ -3863,32 +3553,28 @@
}
}
-/// A description of a log type. Example in YAML format:
-///
-/// - name: library.googleapis.com/activity_history
-/// description: The history of borrowing and returning library items.
-/// display_name: Activity
-/// labels:
-/// - key: /customer_id
-/// description: Identifier of a library customer
+/// A description of a log type. Example in YAML format: - name:
+/// library.googleapis.com/activity_history description: The history of
+/// borrowing and returning library items. display_name: Activity labels: - key:
+/// /customer_id description: Identifier of a library customer
class LogDescriptor {
- /// A human-readable description of this log. This information appears in
- /// the documentation and can contain details.
+ /// A human-readable description of this log. This information appears in the
+ /// documentation and can contain details.
core.String description;
- /// The human-readable name for this log. This information appears on
- /// the user interface and should be concise.
+ /// The human-readable name for this log. This information appears on the user
+ /// interface and should be concise.
core.String displayName;
/// The set of labels that are available to describe a specific log entry.
- /// Runtime requests that contain labels not specified here are
- /// considered invalid.
+ /// Runtime requests that contain labels not specified here are considered
+ /// invalid.
core.List<LabelDescriptor> labels;
/// The name of the log. It must be less than 512 characters long and can
/// include the following characters: upper- and lower-case alphanumeric
- /// characters [A-Za-z0-9], and punctuation characters including
- /// slash, underscore, hyphen, period [/_-.].
+ /// characters [A-Za-z0-9], and punctuation characters including slash,
+ /// underscore, hyphen, period [/_-.].
core.String name;
LogDescriptor();
@@ -3929,46 +3615,29 @@
}
}
-/// Logging configuration of the service.
-///
-/// The following example shows how to configure logs to be sent to the
-/// producer and consumer projects. In the example, the `activity_history`
-/// log is sent to both the producer and consumer projects, whereas the
-/// `purchase_history` log is only sent to the producer project.
-///
-/// monitored_resources:
-/// - type: library.googleapis.com/branch
-/// labels:
-/// - key: /city
-/// description: The city where the library branch is located in.
-/// - key: /name
-/// description: The name of the branch.
-/// logs:
-/// - name: activity_history
-/// labels:
-/// - key: /customer_id
-/// - name: purchase_history
-/// logging:
-/// producer_destinations:
-/// - monitored_resource: library.googleapis.com/branch
-/// logs:
-/// - activity_history
-/// - purchase_history
-/// consumer_destinations:
-/// - monitored_resource: library.googleapis.com/branch
-/// logs:
-/// - activity_history
+/// Logging configuration of the service. The following example shows how to
+/// configure logs to be sent to the producer and consumer projects. In the
+/// example, the `activity_history` log is sent to both the producer and
+/// consumer projects, whereas the `purchase_history` log is only sent to the
+/// producer project. monitored_resources: - type: library.googleapis.com/branch
+/// labels: - key: /city description: The city where the library branch is
+/// located in. - key: /name description: The name of the branch. logs: - name:
+/// activity_history labels: - key: /customer_id - name: purchase_history
+/// logging: producer_destinations: - monitored_resource:
+/// library.googleapis.com/branch logs: - activity_history - purchase_history
+/// consumer_destinations: - monitored_resource: library.googleapis.com/branch
+/// logs: - activity_history
class Logging {
- /// Logging configurations for sending logs to the consumer project.
- /// There can be multiple consumer destinations, each one must have a
- /// different monitored resource type. A log can be used in at most
- /// one consumer destination.
+ /// Logging configurations for sending logs to the consumer project. There can
+ /// be multiple consumer destinations, each one must have a different
+ /// monitored resource type. A log can be used in at most one consumer
+ /// destination.
core.List<LoggingDestination> consumerDestinations;
- /// Logging configurations for sending logs to the producer project.
- /// There can be multiple producer destinations, each one must have a
- /// different monitored resource type. A log can be used in at most
- /// one producer destination.
+ /// Logging configurations for sending logs to the producer project. There can
+ /// be multiple producer destinations, each one must have a different
+ /// monitored resource type. A log can be used in at most one producer
+ /// destination.
core.List<LoggingDestination> producerDestinations;
Logging();
@@ -4003,13 +3672,13 @@
}
}
-/// Configuration of a specific logging destination (the producer project
-/// or the consumer project).
+/// Configuration of a specific logging destination (the producer project or the
+/// consumer project).
class LoggingDestination {
- /// Names of the logs to be sent to this destination. Each name must
- /// be defined in the Service.logs section. If the log name is
- /// not a domain scoped name, it will be automatically prefixed with
- /// the service name followed by "/".
+ /// Names of the logs to be sent to this destination. Each name must be
+ /// defined in the Service.logs section. If the log name is not a domain
+ /// scoped name, it will be automatically prefixed with the service name
+ /// followed by "/".
core.List<core.String> logs;
/// The monitored resource type. The type must be defined in the
@@ -4135,12 +3804,11 @@
/// associated with user-visible concepts, such as Quota.
core.String displayName;
- /// The set of labels that can be used to describe a specific
- /// instance of this metric type. For example, the
- /// `appengine.googleapis.com/http/server/response_latencies` metric
- /// type has a label for the HTTP response code, `response_code`, so
- /// you can look at latencies for successful responses or just
- /// for responses that failed.
+ /// The set of labels that can be used to describe a specific instance of this
+ /// metric type. For example, the
+ /// `appengine.googleapis.com/http/server/response_latencies` metric type has
+ /// a label for the HTTP response code, `response_code`, so you can look at
+ /// latencies for successful responses or just for responses that failed.
core.List<LabelDescriptor> labels;
/// Optional. The launch stage of the metric definition.
@@ -4151,35 +3819,30 @@
/// - "PRELAUNCH" : Prelaunch features are hidden from users and are only
/// visible internally.
/// - "EARLY_ACCESS" : Early Access features are limited to a closed group of
- /// testers. To use
- /// these features, you must sign up in advance and sign a Trusted Tester
- /// agreement (which includes confidentiality provisions). These features may
- /// be unstable, changed in backward-incompatible ways, and are not
- /// guaranteed to be released.
+ /// testers. To use these features, you must sign up in advance and sign a
+ /// Trusted Tester agreement (which includes confidentiality provisions).
+ /// These features may be unstable, changed in backward-incompatible ways, and
+ /// are not guaranteed to be released.
/// - "ALPHA" : Alpha is a limited availability test for releases before they
- /// are cleared
- /// for widespread use. By Alpha, all significant design issues are resolved
- /// and we are in the process of verifying functionality. Alpha customers
- /// need to apply for access, agree to applicable terms, and have their
- /// projects whitelisted. Alpha releases don’t have to be feature complete,
- /// no SLAs are provided, and there are no technical support obligations, but
- /// they will be far enough along that customers can actually use them in
- /// test environments or for limited-use tests -- just like they would in
- /// normal production cases.
+ /// are cleared for widespread use. By Alpha, all significant design issues
+ /// are resolved and we are in the process of verifying functionality. Alpha
+ /// customers need to apply for access, agree to applicable terms, and have
+ /// their projects whitelisted. Alpha releases don’t have to be feature
+ /// complete, no SLAs are provided, and there are no technical support
+ /// obligations, but they will be far enough along that customers can actually
+ /// use them in test environments or for limited-use tests -- just like they
+ /// would in normal production cases.
/// - "BETA" : Beta is the point at which we are ready to open a release for
- /// any
- /// customer to use. There are no SLA or technical support obligations in a
- /// Beta release. Products will be complete from a feature perspective, but
+ /// any customer to use. There are no SLA or technical support obligations in
+ /// a Beta release. Products will be complete from a feature perspective, but
/// may have some open outstanding issues. Beta releases are suitable for
/// limited production use cases.
/// - "GA" : GA features are open to all developers and are considered stable
- /// and
- /// fully qualified for production use.
+ /// and fully qualified for production use.
/// - "DEPRECATED" : Deprecated features are scheduled to be shut down and
- /// removed. For more
- /// information, see the “Deprecation Policy” section of our [Terms of
- /// Service](https://cloud.google.com/terms/)
- /// and the [Google Cloud Platform Subject to the Deprecation
+ /// removed. For more information, see the “Deprecation Policy” section of our
+ /// [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud
+ /// Platform Subject to the Deprecation
/// Policy](https://cloud.google.com/terms/deprecation) documentation.
core.String launchStage;
@@ -4193,16 +3856,14 @@
/// - "METRIC_KIND_UNSPECIFIED" : Do not use this default value.
/// - "GAUGE" : An instantaneous measurement of a value.
/// - "DELTA" : The change in a value during a time interval.
- /// - "CUMULATIVE" : A value accumulated over a time interval. Cumulative
- /// measurements in a time series should have the same start time
- /// and increasing end times, until an event resets the cumulative
- /// value to zero and sets a new start time for the following
- /// points.
+ /// - "CUMULATIVE" : A value accumulated over a time interval. Cumulative
+ /// measurements in a time series should have the same start time and
+ /// increasing end times, until an event resets the cumulative value to zero
+ /// and sets a new start time for the following points.
core.String metricKind;
- /// Read-only. If present, then a time
- /// series, which is identified partially by
- /// a metric type and a MonitoredResourceDescriptor, that is associated
+ /// Read-only. If present, then a time series, which is identified partially
+ /// by a metric type and a MonitoredResourceDescriptor, that is associated
/// with this metric type can only be associated with one of the monitored
/// resource types listed here.
core.List<core.String> monitoredResourceTypes;
@@ -4211,129 +3872,75 @@
core.String name;
/// The metric type, including its DNS name prefix. The type is not
- /// URL-encoded. All user-defined metric types have the DNS name
- /// `custom.googleapis.com` or `external.googleapis.com`. Metric types should
+ /// URL-encoded. All user-defined metric types have the DNS name
+ /// `custom.googleapis.com` or `external.googleapis.com`. Metric types should
/// use a natural hierarchical grouping. For example:
- ///
- /// "custom.googleapis.com/invoice/paid/amount"
- /// "external.googleapis.com/prometheus/up"
- /// "appengine.googleapis.com/http/server/response_latencies"
+ /// "custom.googleapis.com/invoice/paid/amount"
+ /// "external.googleapis.com/prometheus/up"
+ /// "appengine.googleapis.com/http/server/response_latencies"
core.String type;
- /// The units in which the metric value is reported. It is only applicable
- /// if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
- /// defines the representation of the stored metric values.
- ///
- /// Different systems may scale the values to be more easily displayed (so a
- /// value of `0.02KBy` _might_ be displayed as `20By`, and a value of
- /// `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is
- /// `KBy`, then the value of the metric is always in thousands of bytes, no
- /// matter how it may be displayed..
- ///
- /// If you want a custom metric to record the exact number of CPU-seconds used
- /// by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is
- /// `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005
- /// CPU-seconds, then the value is written as `12005`.
- ///
+ /// The units in which the metric value is reported. It is only applicable if
+ /// the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
+ /// defines the representation of the stored metric values. Different systems
+ /// may scale the values to be more easily displayed (so a value of `0.02KBy`
+ /// _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be
+ /// displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of
+ /// the metric is always in thousands of bytes, no matter how it may be
+ /// displayed.. If you want a custom metric to record the exact number of
+ /// CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric
+ /// whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the
+ /// job uses 12,005 CPU-seconds, then the value is written as `12005`.
/// Alternatively, if you want a custom metric to record data in a more
/// granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
- /// `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`),
- /// or use `Kis{CPU}` and write `11.723` (which is `12005/1024`).
- ///
- /// The supported units are a subset of [The Unified Code for Units of
- /// Measure](http://unitsofmeasure.org/ucum.html) standard:
- ///
- /// **Basic units (UNIT)**
- ///
- /// * `bit` bit
- /// * `By` byte
- /// * `s` second
- /// * `min` minute
- /// * `h` hour
- /// * `d` day
- ///
- /// **Prefixes (PREFIX)**
- ///
- /// * `k` kilo (10^3)
- /// * `M` mega (10^6)
- /// * `G` giga (10^9)
- /// * `T` tera (10^12)
- /// * `P` peta (10^15)
- /// * `E` exa (10^18)
- /// * `Z` zetta (10^21)
- /// * `Y` yotta (10^24)
- ///
- /// * `m` milli (10^-3)
- /// * `u` micro (10^-6)
- /// * `n` nano (10^-9)
- /// * `p` pico (10^-12)
- /// * `f` femto (10^-15)
- /// * `a` atto (10^-18)
- /// * `z` zepto (10^-21)
- /// * `y` yocto (10^-24)
- ///
- /// * `Ki` kibi (2^10)
- /// * `Mi` mebi (2^20)
- /// * `Gi` gibi (2^30)
- /// * `Ti` tebi (2^40)
- /// * `Pi` pebi (2^50)
- ///
- /// **Grammar**
- ///
- /// The grammar also includes these connectors:
- ///
- /// * `/` division or ratio (as an infix operator). For examples,
- /// `kBy/{email}` or `MiBy/10ms` (although you should almost never
- /// have `/s` in a metric `unit`; rates should always be computed at
- /// query time from the underlying cumulative or delta value).
- /// * `.` multiplication or composition (as an infix operator). For
- /// examples, `GBy.d` or `k{watt}.h`.
- ///
- /// The grammar for a unit is as follows:
- ///
- /// Expression = Component { "." Component } { "/" Component } ;
- ///
- /// Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
- /// | Annotation
- /// | "1"
- /// ;
- ///
- /// Annotation = "{" NAME "}" ;
- ///
- /// Notes:
- ///
- /// * `Annotation` is just a comment if it follows a `UNIT`. If the annotation
- /// is used alone, then the unit is equivalent to `1`. For examples,
- /// `{request}/s == 1/s`, `By{transmitted}/s == By/s`.
- /// * `NAME` is a sequence of non-blank printable ASCII characters not
- /// containing `{` or `}`.
- /// * `1` represents a unitary [dimensionless
- /// unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
- /// as in `1/s`. It is typically used when none of the basic units are
- /// appropriate. For example, "new users per day" can be represented as
- /// `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new
- /// users). Alternatively, "thousands of page views per day" would be
- /// represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric
- /// value of `5.3` would mean "5300 page views per day").
- /// * `%` represents dimensionless value of 1/100, and annotates values giving
- /// a percentage (so the metric values are typically in the range of 0..100,
- /// and a metric value `3` means "3 percent").
- /// * `10^2.%` indicates a metric contains a ratio, typically in the range
- /// 0..1, that will be multiplied by 100 and displayed as a percentage
- /// (so a metric value `0.03` means "3 percent").
+ /// `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or
+ /// use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported
+ /// units are a subset of [The Unified Code for Units of
+ /// Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units
+ /// (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour *
+ /// `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M`
+ /// mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E`
+ /// exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) *
+ /// `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto
+ /// (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) *
+ /// `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40)
+ /// * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors:
+ /// * `/` division or ratio (as an infix operator). For examples,
+ /// `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s`
+ /// in a metric `unit`; rates should always be computed at query time from the
+ /// underlying cumulative or delta value). * `.` multiplication or composition
+ /// (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar
+ /// for a unit is as follows: Expression = Component { "." Component } { "/"
+ /// Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] |
+ /// Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is
+ /// just a comment if it follows a `UNIT`. If the annotation is used alone,
+ /// then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`,
+ /// `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable
+ /// ASCII characters not containing `{` or `}`. * `1` represents a unitary
+ /// [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity)
+ /// of 1, such as in `1/s`. It is typically used when none of the basic units
+ /// are appropriate. For example, "new users per day" can be represented as
+ /// `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users).
+ /// Alternatively, "thousands of page views per day" would be represented as
+ /// `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would
+ /// mean "5300 page views per day"). * `%` represents dimensionless value of
+ /// 1/100, and annotates values giving a percentage (so the metric values are
+ /// typically in the range of 0..100, and a metric value `3` means "3
+ /// percent"). * `10^2.%` indicates a metric contains a ratio, typically in
+ /// the range 0..1, that will be multiplied by 100 and displayed as a
+ /// percentage (so a metric value `0.03` means "3 percent").
core.String unit;
- /// Whether the measurement is an integer, a floating-point number, etc.
- /// Some combinations of `metric_kind` and `value_type` might not be
- /// supported.
+ /// Whether the measurement is an integer, a floating-point number, etc. Some
+ /// combinations of `metric_kind` and `value_type` might not be supported.
/// Possible string values are:
/// - "VALUE_TYPE_UNSPECIFIED" : Do not use this default value.
- /// - "BOOL" : The value is a boolean.
- /// This value type can be used only if the metric kind is `GAUGE`.
+ /// - "BOOL" : The value is a boolean. This value type can be used only if the
+ /// metric kind is `GAUGE`.
/// - "INT64" : The value is a signed 64-bit integer.
/// - "DOUBLE" : The value is a double precision floating point number.
- /// - "STRING" : The value is a text string.
- /// This value type can be used only if the metric kind is `GAUGE`.
+ /// - "STRING" : The value is a text string. This value type can be used only
+ /// if the metric kind is `GAUGE`.
/// - "DISTRIBUTION" : The value is a `Distribution`.
/// - "MONEY" : The value is money.
core.String valueType;
@@ -4422,8 +4029,8 @@
/// Additional annotations that can be used to guide the usage of a metric.
class MetricDescriptorMetadata {
/// The delay of data points caused by ingestion. Data points older than this
- /// age are guaranteed to be ingested and available to be read, excluding
- /// data loss due to errors.
+ /// age are guaranteed to be ingested and available to be read, excluding data
+ /// loss due to errors.
core.String ingestDelay;
/// Deprecated. Must use the MetricDescriptor.launch_stage instead.
@@ -4434,35 +4041,30 @@
/// - "PRELAUNCH" : Prelaunch features are hidden from users and are only
/// visible internally.
/// - "EARLY_ACCESS" : Early Access features are limited to a closed group of
- /// testers. To use
- /// these features, you must sign up in advance and sign a Trusted Tester
- /// agreement (which includes confidentiality provisions). These features may
- /// be unstable, changed in backward-incompatible ways, and are not
- /// guaranteed to be released.
+ /// testers. To use these features, you must sign up in advance and sign a
+ /// Trusted Tester agreement (which includes confidentiality provisions).
+ /// These features may be unstable, changed in backward-incompatible ways, and
+ /// are not guaranteed to be released.
/// - "ALPHA" : Alpha is a limited availability test for releases before they
- /// are cleared
- /// for widespread use. By Alpha, all significant design issues are resolved
- /// and we are in the process of verifying functionality. Alpha customers
- /// need to apply for access, agree to applicable terms, and have their
- /// projects whitelisted. Alpha releases don’t have to be feature complete,
- /// no SLAs are provided, and there are no technical support obligations, but
- /// they will be far enough along that customers can actually use them in
- /// test environments or for limited-use tests -- just like they would in
- /// normal production cases.
+ /// are cleared for widespread use. By Alpha, all significant design issues
+ /// are resolved and we are in the process of verifying functionality. Alpha
+ /// customers need to apply for access, agree to applicable terms, and have
+ /// their projects whitelisted. Alpha releases don’t have to be feature
+ /// complete, no SLAs are provided, and there are no technical support
+ /// obligations, but they will be far enough along that customers can actually
+ /// use them in test environments or for limited-use tests -- just like they
+ /// would in normal production cases.
/// - "BETA" : Beta is the point at which we are ready to open a release for
- /// any
- /// customer to use. There are no SLA or technical support obligations in a
- /// Beta release. Products will be complete from a feature perspective, but
+ /// any customer to use. There are no SLA or technical support obligations in
+ /// a Beta release. Products will be complete from a feature perspective, but
/// may have some open outstanding issues. Beta releases are suitable for
/// limited production use cases.
/// - "GA" : GA features are open to all developers and are considered stable
- /// and
- /// fully qualified for production use.
+ /// and fully qualified for production use.
/// - "DEPRECATED" : Deprecated features are scheduled to be shut down and
- /// removed. For more
- /// information, see the “Deprecation Policy” section of our [Terms of
- /// Service](https://cloud.google.com/terms/)
- /// and the [Google Cloud Platform Subject to the Deprecation
+ /// removed. For more information, see the “Deprecation Policy” section of our
+ /// [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud
+ /// Platform Subject to the Deprecation
/// Policy](https://cloud.google.com/terms/deprecation) documentation.
core.String launchStage;
@@ -4506,16 +4108,13 @@
/// metric's configured quota behaviors to apply to the method call.
class MetricRule {
/// Metrics to update when the selected methods are called, and the associated
- /// cost applied to each metric.
- ///
- /// The key of the map is the metric name, and the values are the amount
- /// increased for the metric against which the quota limits are defined.
- /// The value must not be negative.
+ /// cost applied to each metric. The key of the map is the metric name, and
+ /// the values are the amount increased for the metric against which the quota
+ /// limits are defined. The value must not be negative.
core.Map<core.String, core.String> metricCosts;
- /// Selects the methods to which this rule applies.
- ///
- /// Refer to selector for syntax details.
+ /// Selects the methods to which this rule applies. Refer to selector for
+ /// syntax details.
core.String selector;
MetricRule();
@@ -4545,88 +4144,39 @@
/// Declares an API Interface to be included in this interface. The including
/// interface must redeclare all the methods from the included interface, but
-/// documentation and options are inherited as follows:
-///
-/// - If after comment and whitespace stripping, the documentation
-/// string of the redeclared method is empty, it will be inherited
-/// from the original method.
-///
-/// - Each annotation belonging to the service config (http,
-/// visibility) which is not set in the redeclared method will be
-/// inherited.
-///
-/// - If an http annotation is inherited, the path pattern will be
-/// modified as follows. Any version prefix will be replaced by the
-/// version of the including interface plus the root path if
-/// specified.
-///
-/// Example of a simple mixin:
-///
-/// package google.acl.v1;
-/// service AccessControl {
-/// // Get the underlying ACL object.
-/// rpc GetAcl(GetAclRequest) returns (Acl) {
-/// option (google.api.http).get = "/v1/{resource=**}:getAcl";
-/// }
-/// }
-///
-/// package google.storage.v2;
-/// service Storage {
-/// // rpc GetAcl(GetAclRequest) returns (Acl);
-///
-/// // Get a data record.
-/// rpc GetData(GetDataRequest) returns (Data) {
-/// option (google.api.http).get = "/v2/{resource=**}";
-/// }
-/// }
-///
-/// Example of a mixin configuration:
-///
-/// apis:
-/// - name: google.storage.v2.Storage
-/// mixins:
-/// - name: google.acl.v1.AccessControl
-///
-/// The mixin construct implies that all methods in `AccessControl` are
-/// also declared with same name and request/response types in
-/// `Storage`. A documentation generator or annotation processor will
-/// see the effective `Storage.GetAcl` method after inherting
-/// documentation and annotations as follows:
-///
-/// service Storage {
-/// // Get the underlying ACL object.
-/// rpc GetAcl(GetAclRequest) returns (Acl) {
-/// option (google.api.http).get = "/v2/{resource=**}:getAcl";
-/// }
-/// ...
-/// }
-///
-/// Note how the version in the path pattern changed from `v1` to `v2`.
-///
-/// If the `root` field in the mixin is specified, it should be a
-/// relative path under which inherited HTTP paths are placed. Example:
-///
-/// apis:
-/// - name: google.storage.v2.Storage
-/// mixins:
-/// - name: google.acl.v1.AccessControl
-/// root: acls
-///
-/// This implies the following inherited HTTP annotation:
-///
-/// service Storage {
-/// // Get the underlying ACL object.
-/// rpc GetAcl(GetAclRequest) returns (Acl) {
-/// option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
-/// }
-/// ...
-/// }
+/// documentation and options are inherited as follows: - If after comment and
+/// whitespace stripping, the documentation string of the redeclared method is
+/// empty, it will be inherited from the original method. - Each annotation
+/// belonging to the service config (http, visibility) which is not set in the
+/// redeclared method will be inherited. - If an http annotation is inherited,
+/// the path pattern will be modified as follows. Any version prefix will be
+/// replaced by the version of the including interface plus the root path if
+/// specified. Example of a simple mixin: package google.acl.v1; service
+/// AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest)
+/// returns (Acl) { option (google.api.http).get = "/v1/{resource=**}:getAcl"; }
+/// } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest)
+/// returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns
+/// (Data) { option (google.api.http).get = "/v2/{resource=**}"; } } Example of
+/// a mixin configuration: apis: - name: google.storage.v2.Storage mixins: -
+/// name: google.acl.v1.AccessControl The mixin construct implies that all
+/// methods in `AccessControl` are also declared with same name and
+/// request/response types in `Storage`. A documentation generator or annotation
+/// processor will see the effective `Storage.GetAcl` method after inheriting
+/// documentation and annotations as follows: service Storage { // Get the
+/// underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option
+/// (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... } Note how the
+/// version in the path pattern changed from `v1` to `v2`. If the `root` field
+/// in the mixin is specified, it should be a relative path under which
+/// inherited HTTP paths are placed. Example: apis: - name:
+/// google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root:
+/// acls This implies the following inherited HTTP annotation: service Storage {
+/// // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) {
+/// option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; } ... }
class Mixin {
/// The fully qualified name of the interface which is included.
core.String name;
- /// If non-empty specifies a path under which inherited HTTP paths
- /// are rooted.
+ /// If non-empty specifies a path under which inherited HTTP paths are rooted.
core.String root;
Mixin();
@@ -4654,15 +4204,12 @@
}
/// An object that describes the schema of a MonitoredResource object using a
-/// type name and a set of labels. For example, the monitored resource
+/// type name and a set of labels. For example, the monitored resource
/// descriptor for Google Compute Engine VM instances has a type of
/// `"gce_instance"` and specifies the use of the labels `"instance_id"` and
-/// `"zone"` to identify particular VM instances.
-///
-/// Different APIs can support different monitored resource types. APIs
-/// generally
-/// provide a `list` method that returns the monitored resource descriptors used
-/// by the API.
+/// `"zone"` to identify particular VM instances. Different APIs can support
+/// different monitored resource types. APIs generally provide a `list` method
+/// that returns the monitored resource descriptors used by the API.
class MonitoredResourceDescriptor {
/// Optional. A detailed description of the monitored resource type that might
/// be used in documentation.
@@ -4670,8 +4217,8 @@
/// Optional. A concise name for the monitored resource type that might be
/// displayed in user interfaces. It should be a Title Cased Noun Phrase,
- /// without any article or other determiners. For example,
- /// `"Google Cloud SQL Database"`.
+ /// without any article or other determiners. For example, `"Google Cloud SQL
+ /// Database"`.
core.String displayName;
/// Required. A set of labels used to describe instances of this monitored
@@ -4687,49 +4234,43 @@
/// - "PRELAUNCH" : Prelaunch features are hidden from users and are only
/// visible internally.
/// - "EARLY_ACCESS" : Early Access features are limited to a closed group of
- /// testers. To use
- /// these features, you must sign up in advance and sign a Trusted Tester
- /// agreement (which includes confidentiality provisions). These features may
- /// be unstable, changed in backward-incompatible ways, and are not
- /// guaranteed to be released.
+ /// testers. To use these features, you must sign up in advance and sign a
+ /// Trusted Tester agreement (which includes confidentiality provisions).
+ /// These features may be unstable, changed in backward-incompatible ways, and
+ /// are not guaranteed to be released.
/// - "ALPHA" : Alpha is a limited availability test for releases before they
- /// are cleared
- /// for widespread use. By Alpha, all significant design issues are resolved
- /// and we are in the process of verifying functionality. Alpha customers
- /// need to apply for access, agree to applicable terms, and have their
- /// projects whitelisted. Alpha releases don’t have to be feature complete,
- /// no SLAs are provided, and there are no technical support obligations, but
- /// they will be far enough along that customers can actually use them in
- /// test environments or for limited-use tests -- just like they would in
- /// normal production cases.
+ /// are cleared for widespread use. By Alpha, all significant design issues
+ /// are resolved and we are in the process of verifying functionality. Alpha
+ /// customers need to apply for access, agree to applicable terms, and have
+ /// their projects whitelisted. Alpha releases don’t have to be feature
+ /// complete, no SLAs are provided, and there are no technical support
+ /// obligations, but they will be far enough along that customers can actually
+ /// use them in test environments or for limited-use tests -- just like they
+ /// would in normal production cases.
/// - "BETA" : Beta is the point at which we are ready to open a release for
- /// any
- /// customer to use. There are no SLA or technical support obligations in a
- /// Beta release. Products will be complete from a feature perspective, but
+ /// any customer to use. There are no SLA or technical support obligations in
+ /// a Beta release. Products will be complete from a feature perspective, but
/// may have some open outstanding issues. Beta releases are suitable for
/// limited production use cases.
/// - "GA" : GA features are open to all developers and are considered stable
- /// and
- /// fully qualified for production use.
+ /// and fully qualified for production use.
/// - "DEPRECATED" : Deprecated features are scheduled to be shut down and
- /// removed. For more
- /// information, see the “Deprecation Policy” section of our [Terms of
- /// Service](https://cloud.google.com/terms/)
- /// and the [Google Cloud Platform Subject to the Deprecation
+ /// removed. For more information, see the “Deprecation Policy” section of our
+ /// [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud
+ /// Platform Subject to the Deprecation
/// Policy](https://cloud.google.com/terms/deprecation) documentation.
core.String launchStage;
/// Optional. The resource name of the monitored resource descriptor:
- /// `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
- /// {type} is the value of the `type` field in this object and
- /// {project_id} is a project ID that provides API-specific context for
- /// accessing the type. APIs that do not use project information can use the
- /// resource name format `"monitoredResourceDescriptors/{type}"`.
+ /// `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type}
+ /// is the value of the `type` field in this object and {project_id} is a
+ /// project ID that provides API-specific context for accessing the type. APIs
+ /// that do not use project information can use the resource name format
+ /// `"monitoredResourceDescriptors/{type}"`.
core.String name;
/// Required. The monitored resource type. For example, the type
/// `"cloudsql_database"` represents databases in Google Cloud SQL.
- /// The maximum length of this value is 256 characters.
core.String type;
MonitoredResourceDescriptor();
@@ -4782,46 +4323,33 @@
}
}
-/// Monitoring configuration of the service.
-///
-/// The example below shows how to configure monitored resources and metrics
-/// for monitoring. In the example, a monitored resource and two metrics are
-/// defined. The `library.googleapis.com/book/returned_count` metric is sent
-/// to both producer and consumer projects, whereas the
-/// `library.googleapis.com/book/overdue_count` metric is only sent to the
-/// consumer project.
-///
-/// monitored_resources:
-/// - type: library.googleapis.com/branch
-/// labels:
-/// - key: /city
-/// description: The city where the library branch is located in.
-/// - key: /name
-/// description: The name of the branch.
-/// metrics:
-/// - name: library.googleapis.com/book/returned_count
-/// metric_kind: DELTA
-/// value_type: INT64
-/// labels:
-/// - key: /customer_id
-/// - name: library.googleapis.com/book/overdue_count
-/// metric_kind: GAUGE
-/// value_type: INT64
-/// labels:
-/// - key: /customer_id
-/// monitoring:
-/// producer_destinations:
-/// - monitored_resource: library.googleapis.com/branch
-/// metrics:
-/// - library.googleapis.com/book/returned_count
-/// consumer_destinations:
-/// - monitored_resource: library.googleapis.com/branch
-/// metrics:
-/// - library.googleapis.com/book/returned_count
-/// - library.googleapis.com/book/overdue_count
+/// Monitoring configuration of the service. The example below shows how to
+/// configure monitored resources and metrics for monitoring. In the example, a
+/// monitored resource and two metrics are defined. The
+/// `library.googleapis.com/book/returned_count` metric is sent to both producer
+/// and consumer projects, whereas the `library.googleapis.com/book/num_overdue`
+/// metric is only sent to the consumer project. monitored_resources: - type:
+/// library.googleapis.com/Branch display_name: "Library Branch" description: "A
+/// branch of a library." launch_stage: GA labels: - key: resource_container
+/// description: "The Cloud container (ie. project id) for the Branch." - key:
+/// location description: "The location of the library branch." - key: branch_id
+/// description: "The id of the branch." metrics: - name:
+/// library.googleapis.com/book/returned_count display_name: "Books Returned"
+/// description: "The count of books that have been returned." launch_stage: GA
+/// metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id
+/// description: "The id of the customer." - name:
+/// library.googleapis.com/book/num_overdue display_name: "Books Overdue"
+/// description: "The current number of overdue books." launch_stage: GA
+/// metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
+/// description: "The id of the customer." monitoring: producer_destinations: -
+/// monitored_resource: library.googleapis.com/Branch metrics: -
+/// library.googleapis.com/book/returned_count consumer_destinations: -
+/// monitored_resource: library.googleapis.com/Branch metrics: -
+/// library.googleapis.com/book/returned_count -
+/// library.googleapis.com/book/num_overdue
class Monitoring {
/// Monitoring configurations for sending metrics to the consumer project.
- /// There can be multiple consumer destinations. A monitored resouce type may
+ /// There can be multiple consumer destinations. A monitored resource type may
/// appear in multiple monitoring destinations if different aggregations are
/// needed for different sets of metrics associated with that monitored
/// resource type. A monitored resource and metric pair may only be used once
@@ -4829,7 +4357,7 @@
core.List<MonitoringDestination> consumerDestinations;
/// Monitoring configurations for sending metrics to the producer project.
- /// There can be multiple producer destinations. A monitored resouce type may
+ /// There can be multiple producer destinations. A monitored resource type may
/// appear in multiple monitoring destinations if different aggregations are
/// needed for different sets of metrics associated with that monitored
/// resource type. A monitored resource and metric pair may only be used once
@@ -4868,11 +4396,11 @@
}
}
-/// Configuration of a specific monitoring destination (the producer project
-/// or the consumer project).
+/// Configuration of a specific monitoring destination (the producer project or
+/// the consumer project).
class MonitoringDestination {
- /// Types of the metrics to report to this monitoring destination.
- /// Each type must be defined in Service.metrics section.
+ /// Types of the metrics to report to this monitoring destination. Each type
+ /// must be defined in Service.metrics section.
core.List<core.String> metrics;
/// The monitored resource type. The type must be defined in
@@ -4906,29 +4434,21 @@
/// OAuth scopes are a way to define data and permissions on data. For example,
/// there are scopes defined for "Read-only access to Google Calendar" and
/// "Access to Cloud Platform". Users can consent to a scope for an application,
-/// giving it permission to access that data on their behalf.
-///
-/// OAuth scope specifications should be fairly coarse grained; a user will need
-/// to see and understand the text description of what your scope means.
-///
-/// In most cases: use one or at most two OAuth scopes for an entire family of
-/// products. If your product has multiple APIs, you should probably be sharing
-/// the OAuth scope across all of those APIs.
-///
-/// When you need finer grained OAuth consent screens: talk with your product
-/// management about how developers will use them in practice.
-///
-/// Please note that even though each of the canonical scopes is enough for a
-/// request to be accepted and passed to the backend, a request can still fail
-/// due to the backend requiring additional scopes or permissions.
+/// giving it permission to access that data on their behalf. OAuth scope
+/// specifications should be fairly coarse grained; a user will need to see and
+/// understand the text description of what your scope means. In most cases: use
+/// one or at most two OAuth scopes for an entire family of products. If your
+/// product has multiple APIs, you should probably be sharing the OAuth scope
+/// across all of those APIs. When you need finer grained OAuth consent screens:
+/// talk with your product management about how developers will use them in
+/// practice. Please note that even though each of the canonical scopes is
+/// enough for a request to be accepted and passed to the backend, a request can
+/// still fail due to the backend requiring additional scopes or permissions.
class OAuthRequirements {
/// The list of publicly documented OAuth scopes that are allowed access. An
- /// OAuth token containing any of these scopes will be accepted.
- ///
- /// Example:
- ///
- /// canonical_scopes: https://www.googleapis.com/auth/calendar,
- /// https://www.googleapis.com/auth/calendar.read
+ /// OAuth token containing any of these scopes will be accepted. Example:
+ /// canonical_scopes: https://www.googleapis.com/auth/calendar,
+ /// https://www.googleapis.com/auth/calendar.read
core.String canonicalScopes;
OAuthRequirements();
@@ -4952,17 +4472,17 @@
/// This resource represents a long-running operation that is the result of a
/// network API call.
class Operation {
- /// If the value is `false`, it means the operation is still in progress.
- /// If `true`, the operation is completed, and either `error` or `response` is
+ /// If the value is `false`, it means the operation is still in progress. If
+ /// `true`, the operation is completed, and either `error` or `response` is
/// available.
core.bool done;
/// The error result of the operation in case of failure or cancellation.
Status error;
- /// Service-specific metadata associated with the operation. It typically
+ /// Service-specific metadata associated with the operation. It typically
/// contains progress information and common metadata such as create time.
- /// Some services might not provide such metadata. Any method that returns a
+ /// Some services might not provide such metadata. Any method that returns a
/// long-running operation should document the metadata type, if any.
///
/// The values for Object must be JSON objects. It can consist of `num`,
@@ -4970,19 +4490,17 @@
core.Map<core.String, core.Object> metadata;
/// The server-assigned name, which is only unique within the same service
- /// that
- /// originally returns it. If you use the default HTTP mapping, the
+ /// that originally returns it. If you use the default HTTP mapping, the
/// `name` should be a resource name ending with `operations/{unique_id}`.
core.String name;
- /// The normal response of the operation in case of success. If the original
+ /// The normal response of the operation in case of success. If the original
/// method returns no data on success, such as `Delete`, the response is
- /// `google.protobuf.Empty`. If the original method is standard
- /// `Get`/`Create`/`Update`, the response should be the resource. For other
- /// methods, the response should have the type `XxxResponse`, where `Xxx`
- /// is the original method name. For example, if the original method name
- /// is `TakeSnapshot()`, the inferred response type is
- /// `TakeSnapshotResponse`.
+ /// `google.protobuf.Empty`. If the original method is standard
+ /// `Get`/`Create`/`Update`, the response should be the resource. For other
+ /// methods, the response should have the type `XxxResponse`, where `Xxx` is
+ /// the original method name. For example, if the original method name is
+ /// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
@@ -5034,8 +4552,8 @@
/// The operation metadata returned for the batchend services operation.
class OperationMetadata {
- /// The full name of the resources that this operation is directly
- /// associated with.
+ /// The full name of the resources that this operation is directly associated
+ /// with.
core.List<core.String> resourceNames;
OperationMetadata();
@@ -5060,8 +4578,8 @@
/// enumeration, etc.
class Option {
/// The option's name. For protobuf built-in options (options defined in
- /// descriptor.proto), this is the short name. For example, `"map_entry"`.
- /// For custom options, it should be the fully-qualified name. For example,
+ /// descriptor.proto), this is the short name. For example, `"map_entry"`. For
+ /// custom options, it should be the fully-qualified name. For example,
/// `"google.api.http"`.
core.String name;
@@ -5101,24 +4619,18 @@
/// Represents a documentation page. A page can contain subpages to represent
/// nested documentation set structure.
class Page {
- /// The Markdown content of the page. You can use <code>(== include {path}
- /// ==)</code> to include content from a Markdown file.
+ /// The Markdown content of the page. You can use (== include {path} ==) to
+ /// include content from a Markdown file.
core.String content;
/// The name of the page. It will be used as an identity of the page to
/// generate URI of the page, text of the link to this page in navigation,
/// etc. The full page name (start from the root page name to this page
/// concatenated with `.`) can be used as reference to the page in your
- /// documentation. For example:
- /// <pre><code>pages:
- /// - name: Tutorial
- /// content: (== include tutorial.md ==)
- /// subpages:
- /// - name: Java
- /// content: (== include tutorial_java.md ==)
- /// </code></pre>
- /// You can reference `Java` page using Markdown reference link syntax:
- /// `Java`.
+ /// documentation. For example: pages: - name: Tutorial content: (== include
+ /// tutorial.md ==) subpages: - name: Java content: (== include
+ /// tutorial_java.md ==) You can reference `Java` page using Markdown
+ /// reference link syntax: `Java`.
core.String name;
/// Subpages of this page. The order of subpages specified here will be
@@ -5158,61 +4670,33 @@
}
/// Quota configuration helps to achieve fairness and budgeting in service
-/// usage.
-///
-/// The metric based quota configuration works this way:
-/// - The service configuration defines a set of metrics.
-/// - For API calls, the quota.metric_rules maps methods to metrics with
-/// corresponding costs.
-/// - The quota.limits defines limits on the metrics, which will be used for
-/// quota checks at runtime.
-///
-/// An example quota configuration in yaml format:
-///
-/// quota:
-/// limits:
-///
-/// - name: apiWriteQpsPerProject
-/// metric: library.googleapis.com/write_calls
-/// unit: "1/min/{project}" # rate limit for consumer projects
-/// values:
-/// STANDARD: 10000
-///
-///
-/// # The metric rules bind all methods to the read_calls metric,
-/// # except for the UpdateBook and DeleteBook methods. These two methods
-/// # are mapped to the write_calls metric, with the UpdateBook method
-/// # consuming at twice rate as the DeleteBook method.
-/// metric_rules:
-/// - selector: "*"
-/// metric_costs:
-/// library.googleapis.com/read_calls: 1
-/// - selector: google.example.library.v1.LibraryService.UpdateBook
-/// metric_costs:
-/// library.googleapis.com/write_calls: 2
-/// - selector: google.example.library.v1.LibraryService.DeleteBook
-/// metric_costs:
-/// library.googleapis.com/write_calls: 1
-///
-/// Corresponding Metric definition:
-///
-/// metrics:
-/// - name: library.googleapis.com/read_calls
-/// display_name: Read requests
-/// metric_kind: DELTA
-/// value_type: INT64
-///
-/// - name: library.googleapis.com/write_calls
-/// display_name: Write requests
-/// metric_kind: DELTA
-/// value_type: INT64
+/// usage. The metric based quota configuration works this way: - The service
+/// configuration defines a set of metrics. - For API calls, the
+/// quota.metric_rules maps methods to metrics with corresponding costs. - The
+/// quota.limits defines limits on the metrics, which will be used for quota
+/// checks at runtime. An example quota configuration in yaml format: quota:
+/// limits: - name: apiWriteQpsPerProject metric:
+/// library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for
+/// consumer projects values: STANDARD: 10000 # The metric rules bind all
+/// methods to the read_calls metric, # except for the UpdateBook and DeleteBook
+/// methods. These two methods # are mapped to the write_calls metric, with the
+/// UpdateBook method # consuming at twice rate as the DeleteBook method.
+/// metric_rules: - selector: "*" metric_costs:
+/// library.googleapis.com/read_calls: 1 - selector:
+/// google.example.library.v1.LibraryService.UpdateBook metric_costs:
+/// library.googleapis.com/write_calls: 2 - selector:
+/// google.example.library.v1.LibraryService.DeleteBook metric_costs:
+/// library.googleapis.com/write_calls: 1 Corresponding Metric definition:
+/// metrics: - name: library.googleapis.com/read_calls display_name: Read
+/// requests metric_kind: DELTA value_type: INT64 - name:
+/// library.googleapis.com/write_calls display_name: Write requests metric_kind:
+/// DELTA value_type: INT64
class Quota {
/// List of `QuotaLimit` definitions for the service.
core.List<QuotaLimit> limits;
/// List of `MetricRule` definitions, each one mapping a selected method to
- /// one
- /// or more metrics.
+ /// one or more metrics.
core.List<MetricRule> metricRules;
Quota();
@@ -5249,77 +4733,60 @@
/// type combination defined within a `QuotaGroup`.
class QuotaLimit {
/// Default number of tokens that can be consumed during the specified
- /// duration. This is the number of tokens assigned when a client
- /// application developer activates the service for his/her project.
- ///
- /// Specifying a value of 0 will block all requests. This can be used if you
- /// are provisioning quota to selected consumers and blocking others.
- /// Similarly, a value of -1 will indicate an unlimited quota. No other
- /// negative values are allowed.
- ///
- /// Used by group-based quotas only.
+ /// duration. This is the number of tokens assigned when a client application
+ /// developer activates the service for his/her project. Specifying a value of
+ /// 0 will block all requests. This can be used if you are provisioning quota
+ /// to selected consumers and blocking others. Similarly, a value of -1 will
+ /// indicate an unlimited quota. No other negative values are allowed. Used by
+ /// group-based quotas only.
core.String defaultLimit;
- /// Optional. User-visible, extended description for this quota limit.
- /// Should be used only when more context is needed to understand this limit
- /// than provided by the limit's display name (see: `display_name`).
+ /// Optional. User-visible, extended description for this quota limit. Should
+ /// be used only when more context is needed to understand this limit than
+ /// provided by the limit's display name (see: `display_name`).
core.String description;
- /// User-visible display name for this limit.
- /// Optional. If not set, the UI will provide a default display name based on
- /// the quota configuration. This field can be used to override the default
- /// display name generated from the configuration.
+ /// User-visible display name for this limit. Optional. If not set, the UI
+ /// will provide a default display name based on the quota configuration. This
+ /// field can be used to override the default display name generated from the
+ /// configuration.
core.String displayName;
- /// Duration of this limit in textual notation. Must be "100s" or "1d".
- ///
- /// Used by group-based quotas only.
+ /// Duration of this limit in textual notation. Must be "100s" or "1d". Used
+ /// by group-based quotas only.
core.String duration;
- /// Free tier value displayed in the Developers Console for this limit.
- /// The free tier is the number of tokens that will be subtracted from the
- /// billed amount when billing is enabled.
- /// This field can only be set on a limit with duration "1d", in a billable
- /// group; it is invalid on any other limit. If this field is not set, it
- /// defaults to 0, indicating that there is no free tier for this service.
- ///
- /// Used by group-based quotas only.
+ /// Free tier value displayed in the Developers Console for this limit. The
+ /// free tier is the number of tokens that will be subtracted from the billed
+ /// amount when billing is enabled. This field can only be set on a limit with
+ /// duration "1d", in a billable group; it is invalid on any other limit. If
+ /// this field is not set, it defaults to 0, indicating that there is no free
+ /// tier for this service. Used by group-based quotas only.
core.String freeTier;
/// Maximum number of tokens that can be consumed during the specified
/// duration. Client application developers can override the default limit up
/// to this maximum. If specified, this value cannot be set to a value less
/// than the default limit. If not specified, it is set to the default limit.
- ///
/// To allow clients to apply overrides with no upper bound, set this to -1,
- /// indicating unlimited maximum quota.
- ///
- /// Used by group-based quotas only.
+ /// indicating unlimited maximum quota. Used by group-based quotas only.
core.String maxLimit;
/// The name of the metric this quota limit applies to. The quota limits with
/// the same metric will be checked together during runtime. The metric must
- /// be
- /// defined within the service config.
+ /// be defined within the service config.
core.String metric;
- /// Name of the quota limit.
- ///
- /// The name must be provided, and it must be unique within the service. The
- /// name can only include alphanumeric characters as well as '-'.
- ///
- /// The maximum length of the limit name is 64 characters.
+ /// Name of the quota limit. The name must be provided, and it must be unique
+ /// within the service. The name can only include alphanumeric characters as
+ /// well as '-'. The maximum length of the limit name is 64 characters.
core.String name;
/// Specify the unit of the quota limit. It uses the same syntax as
- /// Metric.unit. The supported unit kinds are determined by the quota
- /// backend system.
- ///
- /// Here are some examples:
- /// * "1/min/{project}" for quota per minute per project.
- ///
- /// Note: the order of unit components is insignificant.
- /// The "1" at the beginning is required to follow the metric unit syntax.
+ /// Metric.unit. The supported unit kinds are determined by the quota backend
+ /// system. Here are some examples: * "1/min/{project}" for quota per minute
+ /// per project. Note: the order of unit components is insignificant. The "1"
+ /// at the beginning is required to follow the metric unit syntax.
core.String unit;
/// Tiered limit values. You must specify this as a key:value pair, with an
@@ -5401,64 +4868,56 @@
/// A quota override
class QuotaOverride {
+ /// The resource name of the ancestor that requested the override. For
+ /// example: "organizations/12345" or "folders/67890". Used by admin overrides
+ /// only.
+ core.String adminOverrideAncestor;
+
/// If this map is nonempty, then this override applies only to specific
- /// values
- /// for dimensions defined in the limit unit.
- ///
- /// For example, an override on a limit with the unit 1/{project}/{region}
- /// could contain an entry with the key "region" and the value "us-east-1";
- /// the override is only applied to quota consumed in that region.
- ///
- /// This map has the following restrictions:
- ///
- /// * Keys that are not defined in the limit's unit are not valid keys.
- /// Any string appearing in {brackets} in the unit (besides {project} or
- /// {user}) is a defined key.
- /// * "project" is not a valid key; the project is already specified in
- /// the parent resource name.
- /// * "user" is not a valid key; the API does not support quota overrides
- /// that apply only to a specific user.
- /// * If "region" appears as a key, its value must be a valid Cloud region.
- /// * If "zone" appears as a key, its value must be a valid Cloud zone.
- /// * If any valid key other than "region" or "zone" appears in the map,
- /// then
- /// all valid keys other than "region" or "zone" must also appear in the
- /// map.
+ /// values for dimensions defined in the limit unit. For example, an override
+ /// on a limit with the unit 1/{project}/{region} could contain an entry with
+ /// the key "region" and the value "us-east-1"; the override is only applied
+ /// to quota consumed in that region. This map has the following restrictions:
+ /// * Keys that are not defined in the limit's unit are not valid keys. Any
+ /// string appearing in {brackets} in the unit (besides {project} or {user})
+ /// is a defined key. * "project" is not a valid key; the project is already
+ /// specified in the parent resource name. * "user" is not a valid key; the
+ /// API does not support quota overrides that apply only to a specific user. *
+ /// If "region" appears as a key, its value must be a valid Cloud region. * If
+ /// "zone" appears as a key, its value must be a valid Cloud zone. * If any
+ /// valid key other than "region" or "zone" appears in the map, then all valid
+ /// keys other than "region" or "zone" must also appear in the map.
core.Map<core.String, core.String> dimensions;
- /// The name of the metric to which this override applies.
- ///
- /// An example name would be:
- /// `compute.googleapis.com/cpus`
+ /// The name of the metric to which this override applies. An example name
+ /// would be: `compute.googleapis.com/cpus`
core.String metric;
- /// The resource name of the override.
- /// This name is generated by the server when the override is created.
- ///
- /// Example names would be:
+ /// The resource name of the override. This name is generated by the server
+ /// when the override is created. Example names would be:
/// `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
/// `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
- ///
/// The resource name is intended to be opaque and should not be parsed for
/// its component strings, since its representation could change in the
/// future.
core.String name;
- /// The overriding quota limit value.
- /// Can be any nonnegative integer, or -1 (unlimited quota).
+ /// The overriding quota limit value. Can be any nonnegative integer, or -1
+ /// (unlimited quota).
core.String overrideValue;
- /// The limit unit of the limit to which this override applies.
- ///
- /// An example unit would be:
- /// `1/{project}/{region}`
- /// Note that `{project}` and `{region}` are not placeholders in this example;
- /// the literal characters `{` and `}` occur in the string.
+ /// The limit unit of the limit to which this override applies. An example
+ /// unit would be: `1/{project}/{region}` Note that `{project}` and `{region}`
+ /// are not placeholders in this example; the literal characters `{` and `}`
+ /// occur in the string.
core.String unit;
QuotaOverride();
QuotaOverride.fromJson(core.Map _json) {
+ if (_json.containsKey("adminOverrideAncestor")) {
+ adminOverrideAncestor = _json["adminOverrideAncestor"];
+ }
if (_json.containsKey("dimensions")) {
dimensions =
(_json["dimensions"] as core.Map).cast<core.String, core.String>();
@@ -5480,6 +4939,9 @@
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
+ if (adminOverrideAncestor != null) {
+ _json["adminOverrideAncestor"] = adminOverrideAncestor;
+ }
if (dimensions != null) {
_json["dimensions"] = dimensions;
}
@@ -5534,11 +4996,11 @@
}
}
-/// `SourceContext` represents information about the source of a
-/// protobuf element, like the file in which it is defined.
+/// `SourceContext` represents information about the source of a protobuf
+/// element, like the file in which it is defined.
class SourceContext {
/// The path-qualified name of the .proto file that contained the associated
- /// protobuf element. For example: `"google/protobuf/source_context.proto"`.
+ /// protobuf element. For example: `"google/protobuf/source_context.proto"`.
core.String fileName;
SourceContext();
@@ -5591,15 +5053,14 @@
/// The `Status` type defines a logical error model that is suitable for
/// different programming environments, including REST APIs and RPC APIs. It is
/// used by [gRPC](https://github.com/grpc). Each `Status` message contains
-/// three pieces of data: error code, error message, and error details.
-///
-/// You can find out more about this error model and how to work with it in the
-/// [API Design Guide](https://cloud.google.com/apis/design/errors).
+/// three pieces of data: error code, error message, and error details. You can
+/// find out more about this error model and how to work with it in the [API
+/// Design Guide](https://cloud.google.com/apis/design/errors).
class Status {
/// The status code, which should be an enum value of google.rpc.Code.
core.int code;
- /// A list of messages that carry the error details. There is a common set of
+ /// A list of messages that carry the error details. There is a common set of
/// message types for APIs to use.
///
/// The values for Object must be JSON objects. It can consist of `num`,
@@ -5645,9 +5106,8 @@
}
/// Define a parameter's name and location. The parameter may be passed as
-/// either
-/// an HTTP header or a URL query parameter, and if both are passed the behavior
-/// is implementation-dependent.
+/// either an HTTP header or a URL query parameter, and if both are passed the
+/// behavior is implementation-dependent.
class SystemParameter {
/// Define the HTTP header name to use for the parameter. It is case
/// insensitive.
@@ -5694,17 +5154,14 @@
/// Define a system parameter rule mapping system parameter definitions to
/// methods.
class SystemParameterRule {
- /// Define parameters. Multiple names may be defined for a parameter.
- /// For a given method call, only one of them should be used. If multiple
- /// names are used the behavior is implementation-dependent.
- /// If none of the specified names are present the behavior is
- /// parameter-dependent.
+ /// Define parameters. Multiple names may be defined for a parameter. For a
+ /// given method call, only one of them should be used. If multiple names are
+ /// used the behavior is implementation-dependent. If none of the specified
+ /// names are present the behavior is parameter-dependent.
core.List<SystemParameter> parameters;
/// Selects the methods to which this rule applies. Use '*' to indicate all
- /// methods in all APIs.
- ///
- /// Refer to selector for syntax details.
+ /// methods in all APIs. Refer to selector for syntax details.
core.String selector;
SystemParameterRule();
@@ -5734,42 +5191,22 @@
}
}
-/// ### System parameter configuration
-///
-/// A system parameter is a special kind of parameter defined by the API
-/// system, not by an individual API. It is typically mapped to an HTTP header
-/// and/or a URL query parameter. This configuration specifies which methods
-/// change the names of the system parameters.
+/// ### System parameter configuration A system parameter is a special kind of
+/// parameter defined by the API system, not by an individual API. It is
+/// typically mapped to an HTTP header and/or a URL query parameter. This
+/// configuration specifies which methods change the names of the system
+/// parameters.
class SystemParameters {
- /// Define system parameters.
- ///
- /// The parameters defined here will override the default parameters
- /// implemented by the system. If this field is missing from the service
- /// config, default system parameters will be used. Default system parameters
- /// and names is implementation-dependent.
- ///
- /// Example: define api key for all methods
- ///
- /// system_parameters
- /// rules:
- /// - selector: "*"
- /// parameters:
- /// - name: api_key
- /// url_query_parameter: api_key
- ///
- ///
- /// Example: define 2 api key names for a specific method.
- ///
- /// system_parameters
- /// rules:
- /// - selector: "/ListShelves"
- /// parameters:
- /// - name: api_key
- /// http_header: Api-Key1
- /// - name: api_key
- /// http_header: Api-Key2
- ///
- /// **NOTE:** All service configuration rules follow "last one wins" order.
+ /// Define system parameters. The parameters defined here will override the
+ /// default parameters implemented by the system. If this field is missing
+ /// from the service config, default system parameters will be used. Default
+ /// system parameters and names is implementation-dependent. Example: define
+ /// api key for all methods system_parameters rules: - selector: "*"
+ /// parameters: - name: api_key url_query_parameter: api_key Example: define 2
+ /// api key names for a specific method. system_parameters rules: - selector:
+ /// "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name:
+ /// api_key http_header: Api-Key2 **NOTE:** All service configuration rules
+ /// follow "last one wins" order.
core.List<SystemParameterRule> rules;
SystemParameters();
@@ -5871,9 +5308,7 @@
/// Configuration controlling usage of a service.
class Usage {
/// The full resource name of a channel used for sending notifications to the
- /// service producer.
- ///
- /// Google Service Management currently only supports
+ /// service producer. Google Service Management currently only supports
/// [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
/// channel. To use Google Cloud Pub/Sub as the channel, this must be the name
/// of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
@@ -5881,13 +5316,12 @@
core.String producerNotificationChannel;
/// Requirements that must be satisfied before a consumer project can use the
- /// service. Each requirement is of the form <service.name>/<requirement-id>;
- /// for example 'serviceusage.googleapis.com/billing-enabled'.
+ /// service. Each requirement is of the form /; for example
+ /// 'serviceusage.googleapis.com/billing-enabled'.
core.List<core.String> requirements;
- /// A list of usage rules that apply to individual API methods.
- ///
- /// **NOTE:** All service configuration rules follow "last one wins" order.
+ /// A list of usage rules that apply to individual API methods. **NOTE:** All
+ /// service configuration rules follow "last one wins" order.
core.List<UsageRule> rules;
/// The configuration of a per-product per-project service identity.
@@ -5932,46 +5366,29 @@
}
}
-/// Usage configuration rules for the service.
-///
-/// NOTE: Under development.
-///
-///
-/// Use this rule to configure unregistered calls for the service. Unregistered
-/// calls are calls that do not contain consumer project identity.
-/// (Example: calls that do not contain an API key).
-/// By default, API methods do not allow unregistered calls, and each method
-/// call
-/// must be identified by a consumer project identity. Use this rule to
-/// allow/disallow unregistered calls.
-///
-/// Example of an API that wants to allow unregistered calls for entire service.
-///
-/// usage:
-/// rules:
-/// - selector: "*"
-/// allow_unregistered_calls: true
-///
-/// Example of a method that wants to allow unregistered calls.
-///
-/// usage:
-/// rules:
-/// - selector: "google.example.library.v1.LibraryService.CreateBook"
-/// allow_unregistered_calls: true
+/// Usage configuration rules for the service. NOTE: Under development. Use this
+/// rule to configure unregistered calls for the service. Unregistered calls are
+/// calls that do not contain consumer project identity. (Example: calls that do
+/// not contain an API key). By default, API methods do not allow unregistered
+/// calls, and each method call must be identified by a consumer project
+/// identity. Use this rule to allow/disallow unregistered calls. Example of an
+/// API that wants to allow unregistered calls for entire service. usage: rules:
+/// - selector: "*" allow_unregistered_calls: true Example of a method that
+/// wants to allow unregistered calls. usage: rules: - selector:
+/// "google.example.library.v1.LibraryService.CreateBook"
+/// allow_unregistered_calls: true
class UsageRule {
- /// If true, the selected method allows unregistered calls, e.g. calls
- /// that don't identify any user or application.
+ /// If true, the selected method allows unregistered calls, e.g. calls that
+ /// don't identify any user or application.
core.bool allowUnregisteredCalls;
/// Selects the methods to which this rule applies. Use '*' to indicate all
- /// methods in all APIs.
- ///
- /// Refer to selector for syntax details.
+ /// methods in all APIs. Refer to selector for syntax details.
core.String selector;
/// If true, the selected method should skip service control and the control
- /// plane features, such as quota and billing, will not be available.
- /// This flag is used by Google Cloud Endpoints to bypass checks for internal
+ /// plane features, such as quota and billing, will not be available. This
+ /// flag is used by Google Cloud Endpoints to bypass checks for internal
/// methods, such as service health check methods.
core.bool skipServiceControl;
