generated new packages
diff --git a/generated/googleapis/lib/serviceusage/v1.dart b/generated/googleapis/lib/serviceusage/v1.dart
index a3af5fc..bbd78c9 100644
--- a/generated/googleapis/lib/serviceusage/v1.dart
+++ b/generated/googleapis/lib/serviceusage/v1.dart
@@ -212,14 +212,14 @@
///
/// Request parameters:
///
+ /// [pageSize] - The standard list page size.
+ ///
/// [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 +231,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.int pageSize,
+ core.String filter,
core.String name,
core.String pageToken,
- core.int pageSize,
core.String $fields}) {
var _url = null;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
@@ -243,6 +243,9 @@
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
+ if (pageSize != null) {
+ _queryParams["pageSize"] = ["${pageSize}"];
+ }
if (filter != null) {
_queryParams["filter"] = [filter];
}
@@ -252,9 +255,6 @@
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
- if (pageSize != null) {
- _queryParams["pageSize"] = ["${pageSize}"];
- }
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
@@ -281,8 +281,6 @@
/// any service fails, then the entire batch fails, and no state changes
/// occur.
///
- /// Operation<response: BatchEnableServicesResponse>
- ///
/// [request] - The metadata request object.
///
/// Request parameters:
@@ -347,8 +345,6 @@
/// currently enabled. Callers will receive a `FAILED_PRECONDITION` status if
/// the target service is not currently enabled.
///
- /// Operation<response: DisableServiceResponse>
- ///
/// [request] - The metadata request object.
///
/// Request parameters:
@@ -405,8 +401,6 @@
/// Enable a service so that it can be used with a project.
///
- /// Operation<response: EnableServiceResponse>
- ///
/// [request] - The metadata request object.
///
/// Request parameters:
@@ -530,6 +524,9 @@
/// where `123` is the project number (not project ID).
/// 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.
@@ -538,9 +535,6 @@
/// 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`.
- ///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
@@ -552,9 +546,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 = null;
var _queryParams = new core.Map<core.String, core.List<core.String>>();
@@ -566,15 +560,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];
}
@@ -727,7 +721,7 @@
/// bookstore_web.apps.googleusercontent.com
core.String audiences;
- /// Redirect URL if JWT token is required but no present or is expired.
+ /// Redirect URL if JWT token is required but not present or is expired.
/// Implement authorizationUrl of securityDefinitions in OpenAPI spec.
core.String authorizationUrl;
@@ -1002,62 +996,6 @@
}
}
-/// Authorization rule for API services.
-///
-/// It specifies the permission(s) required for an API element for the overall
-/// API request to succeed. It is typically used to mark request message fields
-/// that contain the name of the resource and indicates the permissions that
-/// will be checked on that resource.
-///
-/// For example:
-///
-/// package google.storage.v1;
-///
-/// message CopyObjectRequest {
-/// string source = 1 [
-/// (google.api.authz).permissions = "storage.objects.get"];
-///
-/// string destination = 2 [
-/// (google.api.authz).permissions =
-/// "storage.objects.create,storage.objects.update"];
-/// }
-class AuthorizationRule {
- /// The required permissions. The acceptable values vary depend on the
- /// authorization system used. For Google APIs, it should be a comma-separated
- /// Google IAM permission values. When multiple permissions are listed, the
- /// semantics is not defined by the system. Additional documentation must
- /// be provided manually.
- core.String permissions;
-
- /// Selects the API elements to which this rule applies.
- ///
- /// Refer to selector for syntax details.
- core.String selector;
-
- AuthorizationRule();
-
- AuthorizationRule.fromJson(core.Map _json) {
- if (_json.containsKey("permissions")) {
- permissions = _json["permissions"];
- }
- if (_json.containsKey("selector")) {
- selector = _json["selector"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json =
- new core.Map<core.String, core.Object>();
- if (permissions != null) {
- _json["permissions"] = permissions;
- }
- if (selector != null) {
- _json["selector"] = selector;
- }
- return _json;
- }
-}
-
/// `Backend` defines the backend configuration for a service.
class Backend {
/// A list of API backend rules that apply to individual API methods.
@@ -1095,10 +1033,66 @@
/// seconds.
core.double deadline;
+ /// The JWT audience is used when generating a JWT id token for the backend.
+ core.String jwtAudience;
+
/// Minimum deadline in seconds needed for this method. Calls having deadline
/// value lower than this will be rejected.
core.double minDeadline;
+ /// The number of seconds to wait for the completion of a long running
+ /// operation. The default is no deadline.
+ core.double operationDeadline;
+
+ ///
+ /// 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:
+ /// https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe
+ ///
+ /// 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:
+ /// https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST
+ core.String pathTranslation;
+
/// Selects the methods to which this rule applies.
///
/// Refer to selector for syntax details.
@@ -1113,9 +1107,18 @@
if (_json.containsKey("deadline")) {
deadline = _json["deadline"].toDouble();
}
+ if (_json.containsKey("jwtAudience")) {
+ jwtAudience = _json["jwtAudience"];
+ }
if (_json.containsKey("minDeadline")) {
minDeadline = _json["minDeadline"].toDouble();
}
+ if (_json.containsKey("operationDeadline")) {
+ operationDeadline = _json["operationDeadline"].toDouble();
+ }
+ if (_json.containsKey("pathTranslation")) {
+ pathTranslation = _json["pathTranslation"];
+ }
if (_json.containsKey("selector")) {
selector = _json["selector"];
}
@@ -1130,9 +1133,18 @@
if (deadline != null) {
_json["deadline"] = deadline;
}
+ if (jwtAudience != null) {
+ _json["jwtAudience"] = jwtAudience;
+ }
if (minDeadline != null) {
_json["minDeadline"] = minDeadline;
}
+ if (operationDeadline != null) {
+ _json["operationDeadline"] = operationDeadline;
+ }
+ if (pathTranslation != null) {
+ _json["pathTranslation"] = pathTranslation;
+ }
if (selector != null) {
_json["selector"] = selector;
}
@@ -2363,8 +2375,10 @@
/// Monitoring configuration.
Monitoring monitoring;
- /// The DNS address at which this service is available,
- /// e.g. `calendar.googleapis.com`.
+ /// 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.
@@ -2838,97 +2852,96 @@
}
}
-/// `HttpRule` defines the mapping of an RPC method to one or more HTTP
-/// REST API methods. The mapping specifies how different portions of the RPC
-/// request message are mapped to URL path, URL query parameters, and
-/// HTTP request body. The mapping is typically specified as an
-/// `google.api.http` annotation on the RPC method,
-/// see "google/api/annotations.proto" for details.
+/// # gRPC Transcoding
///
-/// The mapping consists of a field specifying the path template and
-/// method kind. The path template can refer to fields in the request
-/// message, as in the example below which describes a REST GET
-/// operation on a resource collection of messages:
+/// 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/messages/{message_id}/{sub.subfield}";
+/// option (google.api.http) = {
+/// get: "/v1/{name=messages / * }"
+/// };
/// }
/// }
/// message GetMessageRequest {
-/// message SubMessage {
-/// string subfield = 1;
-/// }
-/// string message_id = 1; // mapped to the URL
-/// SubMessage sub = 2; // `sub.subfield` is url-mapped
+/// string name = 1; // Mapped to URL path.
/// }
/// message Message {
-/// string text = 1; // content of the resource
+/// string text = 1; // The resource content.
/// }
///
-/// The same http annotation can alternatively be expressed inside the
-/// `GRPC API Configuration` YAML file.
+/// This enables an HTTP REST to gRPC mapping as below:
///
-/// http:
-/// rules:
-/// - selector: <proto_package_name>.Messaging.GetMessage
-/// get: /v1/messages/{message_id}/{sub.subfield}
-///
-/// This definition enables an automatic, bidrectional mapping of HTTP
-/// JSON to RPC. Example:
-///
-/// HTTP | RPC
+/// HTTP | gRPC
/// -----|-----
-/// `GET /v1/messages/123456/foo` | `GetMessage(message_id: "123456" sub:
-/// SubMessage(subfield: "foo"))`
+/// `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
///
-/// In general, not only fields but also field paths can be referenced
-/// from a path pattern. Fields mapped to the path pattern cannot be
-/// repeated and must have a primitive (non-message) type.
-///
-/// Any fields in the request message which are not bound by the path
-/// pattern automatically become (optional) HTTP query
-/// parameters. Assume the following definition of the request message:
-///
+/// 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}";
+/// option (google.api.http) = {
+/// get:"/v1/messages/{message_id}"
+/// };
/// }
/// }
/// message GetMessageRequest {
/// message SubMessage {
/// string subfield = 1;
/// }
-/// string message_id = 1; // mapped to the URL
-/// int64 revision = 2; // becomes a parameter
-/// SubMessage sub = 3; // `sub.subfield` becomes a parameter
+/// 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 | RPC
+/// 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 HTTP parameters must have a
-/// primitive type or a repeated primitive type. Message types are not
-/// allowed. In the case of a repeated type, the parameter can be
-/// repeated in the URL, as in `...?param=A¶m=B`.
+/// 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 method kinds which allow a request body, the `body` field
+/// 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) = {
-/// put: "/v1/messages/{message_id}"
+/// patch: "/v1/messages/{message_id}"
/// body: "message"
/// };
/// }
@@ -2938,14 +2951,13 @@
/// 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 | RPC
+/// HTTP | gRPC
/// -----|-----
-/// `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
+/// `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
@@ -2956,7 +2968,7 @@
/// service Messaging {
/// rpc UpdateMessage(Message) returns (Message) {
/// option (google.api.http) = {
-/// put: "/v1/messages/{message_id}"
+/// patch: "/v1/messages/{message_id}"
/// body: "*"
/// };
/// }
@@ -2969,14 +2981,14 @@
///
/// The following HTTP JSON to RPC mapping is enabled:
///
-/// HTTP | RPC
+/// HTTP | gRPC
/// -----|-----
-/// `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
+/// `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 of
+/// 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.
///
@@ -2998,33 +3010,31 @@
/// string user_id = 2;
/// }
///
+/// This enables the following two alternative HTTP JSON to RPC mappings:
///
-/// This enables the following two alternative HTTP JSON to RPC
-/// mappings:
-///
-/// HTTP | RPC
+/// 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
+/// ## Rules for HTTP mapping
///
-/// The rules for mapping HTTP path, query parameters, and body fields
-/// to the request message are as follows:
+/// 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.
///
-/// 1. The `body` field specifies either `*` or a field path, or is
-/// omitted. If omitted, it indicates there is no HTTP request body.
-/// 2. Leaf fields (recursive expansion of nested messages in the
-/// request) can be classified into three types:
-/// (a) Matched in the URL template.
-/// (b) Covered by body (if body is `*`, everything except (a) fields;
-/// else everything under the body field)
-/// (c) All other fields.
-/// 3. URL query parameters found in the HTTP request are mapped to (c) fields.
-/// 4. Any body sent with an HTTP request can contain only (b) fields.
-///
-/// The syntax of the path template is as follows:
+/// ### Path template syntax
///
/// Template = "/" Segments [ Verb ] ;
/// Segments = Segment { "/" Segment } ;
@@ -3033,9 +3043,9 @@
/// FieldPath = IDENT { "." IDENT } ;
/// Verb = ":" LITERAL ;
///
-/// The syntax `*` matches a single path segment. The syntax `**` matches zero
-/// or more path segments, which must be the last part of the path except the
-/// `Verb`. The syntax `LITERAL` matches literal text in the path.
+/// 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
@@ -3043,43 +3053,91 @@
/// 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, all
-/// characters
-/// except `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the
-/// Discovery Document as `{var}`.
+/// `"{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 one or more path segments, such as `"{var=foo / * }"`
-/// or `"{var=**}"`, when such a variable is expanded into a URL path, all
-/// characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables
-/// show up in the Discovery Document 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
+/// Document](https://developers.google.com/discovery/v1/reference/apis)
+/// as `{+var}`.
///
-/// NOTE: While the single segment variable matches the semantics of
-/// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2
-/// Simple String Expansion, the multi segment variable **does not** match
-/// RFC 6570 Reserved Expansion. The reason is that the Reserved Expansion
+/// ## 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
+/// 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
+/// 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
+/// 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.
+/// to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
+/// for multi segment variables.
///
-/// NOTE: the field paths in variables and in the `body` must not refer to
-/// repeated fields or map fields.
+/// 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).
core.List<HttpRule> additionalBindings;
- /// Specifies the permission(s) required for an API element for the overall
- /// API request to succeed. It is typically used to mark request message
- /// fields
- /// that contain the name of the resource and indicates the permissions that
- /// will be checked on that resource.
- core.List<AuthorizationRule> authorizations;
-
- /// The name of the request field whose value is mapped to the HTTP body, or
- /// `*` for mapping all fields not captured by the path pattern to the HTTP
- /// body. NOTE: the referred field must not be a repeated field and must be
- /// present at the top-level of request message type.
+ /// 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
@@ -3088,78 +3146,31 @@
/// for services that provide content to Web (HTML) clients.
CustomHttpPattern custom;
- /// Used for deleting a resource.
+ /// Maps to HTTP DELETE. Used for deleting a resource.
core.String delete;
- /// Used for listing and getting information about resources.
+ /// Maps to HTTP GET. Used for listing and getting information about
+ /// resources.
core.String get;
- /// Use this only for Scotty Requests. Do not use this for bytestream methods.
- /// For media support, add instead [][google.bytestream.RestByteStream] as an
- /// API to your configuration.
- MediaDownload mediaDownload;
-
- /// Use this only for Scotty Requests. Do not use this for media support using
- /// Bytestream, add instead
- /// [][google.bytestream.RestByteStream] as an API to your
- /// configuration for Bytestream methods.
- MediaUpload mediaUpload;
-
- /// Used for updating a resource.
+ /// Maps to HTTP PATCH. Used for updating a resource.
core.String patch;
- /// Used for creating a resource.
+ /// Maps to HTTP POST. Used for creating a resource or performing an action.
core.String post;
- /// Used for updating a resource.
+ /// Maps to HTTP PUT. Used for replacing a resource.
core.String put;
/// Optional. The name of the response field whose value is mapped to the HTTP
- /// body of response. Other response fields are ignored. When
- /// not set, the response message will be used as HTTP body of response.
+ /// 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;
- /// DO NOT USE. This is an experimental field.
- ///
- /// Optional. The REST collection name is by default derived from the URL
- /// pattern. If specified, this field overrides the default collection name.
- /// Example:
- ///
- /// rpc AddressesAggregatedList(AddressesAggregatedListRequest)
- /// returns (AddressesAggregatedListResponse) {
- /// option (google.api.http) = {
- /// get: "/v1/projects/{project_id}/aggregated/addresses"
- /// rest_collection: "projects.addresses"
- /// };
- /// }
- ///
- /// This method has the automatically derived collection name
- /// "projects.aggregated". Because, semantically, this rpc is actually an
- /// operation on the "projects.addresses" collection, the `rest_collection`
- /// field is configured to override the derived collection name.
- core.String restCollection;
-
- /// DO NOT USE. This is an experimental field.
- ///
- /// Optional. The rest method name is by default derived from the URL
- /// pattern. If specified, this field overrides the default method name.
- /// Example:
- ///
- /// rpc CreateResource(CreateResourceRequest)
- /// returns (CreateResourceResponse) {
- /// option (google.api.http) = {
- /// post: "/v1/resources",
- /// body: "resource",
- /// rest_method_name: "insert"
- /// };
- /// }
- ///
- /// This method has the automatically derived rest method name
- /// "create", but for backwards compatibility with apiary, it is specified as
- /// insert.
- core.String restMethodName;
-
- /// Selects methods to which this rule applies.
+ /// Selects a method to which this rule applies.
///
/// Refer to selector for syntax details.
core.String selector;
@@ -3172,12 +3183,6 @@
.map<HttpRule>((value) => new HttpRule.fromJson(value))
.toList();
}
- if (_json.containsKey("authorizations")) {
- authorizations = (_json["authorizations"] as core.List)
- .map<AuthorizationRule>(
- (value) => new AuthorizationRule.fromJson(value))
- .toList();
- }
if (_json.containsKey("body")) {
body = _json["body"];
}
@@ -3190,12 +3195,6 @@
if (_json.containsKey("get")) {
get = _json["get"];
}
- if (_json.containsKey("mediaDownload")) {
- mediaDownload = new MediaDownload.fromJson(_json["mediaDownload"]);
- }
- if (_json.containsKey("mediaUpload")) {
- mediaUpload = new MediaUpload.fromJson(_json["mediaUpload"]);
- }
if (_json.containsKey("patch")) {
patch = _json["patch"];
}
@@ -3208,12 +3207,6 @@
if (_json.containsKey("responseBody")) {
responseBody = _json["responseBody"];
}
- if (_json.containsKey("restCollection")) {
- restCollection = _json["restCollection"];
- }
- if (_json.containsKey("restMethodName")) {
- restMethodName = _json["restMethodName"];
- }
if (_json.containsKey("selector")) {
selector = _json["selector"];
}
@@ -3226,10 +3219,6 @@
_json["additionalBindings"] =
additionalBindings.map((value) => (value).toJson()).toList();
}
- if (authorizations != null) {
- _json["authorizations"] =
- authorizations.map((value) => (value).toJson()).toList();
- }
if (body != null) {
_json["body"] = body;
}
@@ -3242,12 +3231,6 @@
if (get != null) {
_json["get"] = get;
}
- if (mediaDownload != null) {
- _json["mediaDownload"] = (mediaDownload).toJson();
- }
- if (mediaUpload != null) {
- _json["mediaUpload"] = (mediaUpload).toJson();
- }
if (patch != null) {
_json["patch"] = patch;
}
@@ -3260,12 +3243,6 @@
if (responseBody != null) {
_json["responseBody"] = responseBody;
}
- if (restCollection != null) {
- _json["restCollection"] = restCollection;
- }
- if (restMethodName != null) {
- _json["restMethodName"] = restMethodName;
- }
if (selector != null) {
_json["selector"] = selector;
}
@@ -3566,177 +3543,6 @@
}
}
-/// Defines the Media configuration for a service in case of a download.
-/// Use this only for Scotty Requests. Do not use this for media support using
-/// Bytestream, add instead [][google.bytestream.RestByteStream] as an API to
-/// your configuration for Bytestream methods.
-class MediaDownload {
- /// A boolean that determines whether a notification for the completion of a
- /// download should be sent to the backend.
- core.bool completeNotification;
-
- /// DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
- ///
- /// Specify name of the download service if one is used for download.
- core.String downloadService;
-
- /// Name of the Scotty dropzone to use for the current API.
- core.String dropzone;
-
- /// Whether download is enabled.
- core.bool enabled;
-
- /// Optional maximum acceptable size for direct download.
- /// The size is specified in bytes.
- core.String maxDirectDownloadSize;
-
- /// A boolean that determines if direct download from ESF should be used for
- /// download of this media.
- core.bool useDirectDownload;
-
- MediaDownload();
-
- MediaDownload.fromJson(core.Map _json) {
- if (_json.containsKey("completeNotification")) {
- completeNotification = _json["completeNotification"];
- }
- if (_json.containsKey("downloadService")) {
- downloadService = _json["downloadService"];
- }
- if (_json.containsKey("dropzone")) {
- dropzone = _json["dropzone"];
- }
- if (_json.containsKey("enabled")) {
- enabled = _json["enabled"];
- }
- if (_json.containsKey("maxDirectDownloadSize")) {
- maxDirectDownloadSize = _json["maxDirectDownloadSize"];
- }
- if (_json.containsKey("useDirectDownload")) {
- useDirectDownload = _json["useDirectDownload"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json =
- new core.Map<core.String, core.Object>();
- if (completeNotification != null) {
- _json["completeNotification"] = completeNotification;
- }
- if (downloadService != null) {
- _json["downloadService"] = downloadService;
- }
- if (dropzone != null) {
- _json["dropzone"] = dropzone;
- }
- if (enabled != null) {
- _json["enabled"] = enabled;
- }
- if (maxDirectDownloadSize != null) {
- _json["maxDirectDownloadSize"] = maxDirectDownloadSize;
- }
- if (useDirectDownload != null) {
- _json["useDirectDownload"] = useDirectDownload;
- }
- return _json;
- }
-}
-
-/// Defines the Media configuration for a service in case of an upload.
-/// Use this only for Scotty Requests. Do not use this for media support using
-/// Bytestream, add instead [][google.bytestream.RestByteStream] as an API to
-/// your configuration for Bytestream methods.
-class MediaUpload {
- /// A boolean that determines whether a notification for the completion of an
- /// upload should be sent to the backend. These notifications will not be seen
- /// by the client and will not consume quota.
- core.bool completeNotification;
-
- /// Name of the Scotty dropzone to use for the current API.
- core.String dropzone;
-
- /// Whether upload is enabled.
- core.bool enabled;
-
- /// Optional maximum acceptable size for an upload.
- /// The size is specified in bytes.
- core.String maxSize;
-
- /// An array of mimetype patterns. Esf will only accept uploads that match one
- /// of the given patterns.
- core.List<core.String> mimeTypes;
-
- /// Whether to receive a notification for progress changes of media upload.
- core.bool progressNotification;
-
- /// Whether to receive a notification on the start of media upload.
- core.bool startNotification;
-
- /// DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
- ///
- /// Specify name of the upload service if one is used for upload.
- core.String uploadService;
-
- MediaUpload();
-
- MediaUpload.fromJson(core.Map _json) {
- if (_json.containsKey("completeNotification")) {
- completeNotification = _json["completeNotification"];
- }
- if (_json.containsKey("dropzone")) {
- dropzone = _json["dropzone"];
- }
- if (_json.containsKey("enabled")) {
- enabled = _json["enabled"];
- }
- if (_json.containsKey("maxSize")) {
- maxSize = _json["maxSize"];
- }
- if (_json.containsKey("mimeTypes")) {
- mimeTypes = (_json["mimeTypes"] as core.List).cast<core.String>();
- }
- if (_json.containsKey("progressNotification")) {
- progressNotification = _json["progressNotification"];
- }
- if (_json.containsKey("startNotification")) {
- startNotification = _json["startNotification"];
- }
- if (_json.containsKey("uploadService")) {
- uploadService = _json["uploadService"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json =
- new core.Map<core.String, core.Object>();
- if (completeNotification != null) {
- _json["completeNotification"] = completeNotification;
- }
- if (dropzone != null) {
- _json["dropzone"] = dropzone;
- }
- if (enabled != null) {
- _json["enabled"] = enabled;
- }
- if (maxSize != null) {
- _json["maxSize"] = maxSize;
- }
- if (mimeTypes != null) {
- _json["mimeTypes"] = mimeTypes;
- }
- if (progressNotification != null) {
- _json["progressNotification"] = progressNotification;
- }
- if (startNotification != null) {
- _json["startNotification"] = startNotification;
- }
- if (uploadService != null) {
- _json["uploadService"] = uploadService;
- }
- return _json;
- }
-}
-
/// Method represents a method of an API interface.
class Method {
/// The simple name of this method.
@@ -4372,15 +4178,19 @@
/// - library.googleapis.com/book/overdue_count
class Monitoring {
/// Monitoring configurations for sending metrics to the consumer project.
- /// There can be multiple consumer destinations, each one must have a
- /// different monitored resource type. A metric can be used in at most
- /// one consumer destination.
+ /// There can be multiple consumer destinations. A monitored resouce 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
+ /// in the Monitoring configuration.
core.List<MonitoringDestination> consumerDestinations;
/// Monitoring configurations for sending metrics to the producer project.
- /// There can be multiple producer destinations, each one must have a
- /// different monitored resource type. A metric can be used in at most
- /// one producer destination.
+ /// There can be multiple producer destinations. A monitored resouce 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
+ /// in the Monitoring configuration.
core.List<MonitoringDestination> producerDestinations;
Monitoring();
@@ -4418,8 +4228,8 @@
/// Configuration of a specific monitoring destination (the producer project
/// or the consumer project).
class MonitoringDestination {
- /// Names of the metrics to report to this monitoring destination.
- /// Each name 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
@@ -4718,6 +4528,7 @@
/// An example quota configuration in yaml format:
///
/// quota:
+/// limits:
///
/// - name: apiWriteQpsPerProject
/// metric: library.googleapis.com/write_calls
