Api-roll 42: 2016-11-08

generated/googleapis_beta/lib/pubsub/v1beta2.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis_beta.pubsub.v1beta2;
 
 import 'dart:core' as core;
 import 'dart:async' as async;
 import 'dart:convert' as convert;
 
 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
 import 'package:http/http.dart' as http;
@@ skipping 87 matching lines @@
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Empty.fromJson(data));
   }
 
   /**
    * Creates a subscription to a given topic. If the subscription already
    * exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist,
    * returns `NOT_FOUND`. If the name is not provided in the request, the server
    * will assign a random name for this subscription on the same project as the
-   * topic.
+   * topic. Note that for REST API requests, you must specify a name.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [name] - The name of the subscription. It must have the format
    * `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
    * start with a letter, and contain only letters (`[A-Za-z]`), numbers
    * (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
    * plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
@@ skipping 113 matching lines @@
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Subscription.fromJson(data));
   }
 
   /**
-   * Gets the access control policy for a `resource`. Returns an empty policy if
+   * Gets the access control policy for a resource. Returns an empty policy if
    * the resource exists and does not have a policy set.
    *
    * Request parameters:
    *
    * [resource] - REQUIRED: The resource for which the policy is being
-   * requested. `resource` is usually specified as a path, such as `projects / *
-   * project * / zones / * zone * / disks / * disk*`. The format for the path
-   * specified in this value is resource specific and is specified in the
-   * `getIamPolicy` documentation.
+   * requested. `resource` is usually specified as a path. For example, a
+   * Project resource is specified as `projects/{project}`.
    * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
    *
    * Completes with a [Policy].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
@@ skipping 70 matching lines @@
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new ListSubscriptionsResponse.fromJson(data));
   }
 
   /**
    * Modifies the ack deadline for a specific message. This method is useful to
    * indicate that more time is needed to process a message by the subscriber,
    * or to make the message available for redelivery if the processing was
-   * interrupted.
+   * interrupted. Note that this does not modify the subscription-level
+   * `ackDeadlineSeconds` used for subsequent messages.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [subscription] - The name of the subscription.
    * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
    *
    * Completes with a [Empty].
    *
@@ skipping 129 matching lines @@
 
   /**
    * Sets the access control policy on the specified resource. Replaces any
    * existing policy.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [resource] - REQUIRED: The resource for which the policy is being
-   * specified. `resource` is usually specified as a path, such as `projects / *
-   * project * / zones / * zone * / disks / * disk*`. The format for the path
-   * specified in this value is resource specific and is specified in the
-   * `setIamPolicy` documentation.
+   * specified. `resource` is usually specified as a path. For example, a
+   * Project resource is specified as `projects/{project}`.
    * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
    *
    * Completes with a [Policy].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
@@ skipping 25 matching lines @@
   }
 
   /**
    * Returns permissions that a caller has on the specified resource.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [resource] - REQUIRED: The resource for which the policy detail is being
-   * requested. `resource` is usually specified as a path, such as `projects / *
-   * project * / zones / * zone * / disks / * disk*`. The format for the path
-   * specified in this value is resource specific and is specified in the
-   * `testIamPermissions` documentation.
+   * requested. `resource` is usually specified as a path. For example, a
+   * Project resource is specified as `projects/{project}`.
    * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
    *
    * Completes with a [TestIamPermissionsResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
@@ skipping 163 matching lines @@
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Topic.fromJson(data));
   }
 
   /**
-   * Gets the access control policy for a `resource`. Returns an empty policy if
+   * Gets the access control policy for a resource. Returns an empty policy if
    * the resource exists and does not have a policy set.
    *
    * Request parameters:
    *
    * [resource] - REQUIRED: The resource for which the policy is being
-   * requested. `resource` is usually specified as a path, such as `projects / *
-   * project * / zones / * zone * / disks / * disk*`. The format for the path
-   * specified in this value is resource specific and is specified in the
-   * `getIamPolicy` documentation.
+   * requested. `resource` is usually specified as a path. For example, a
+   * Project resource is specified as `projects/{project}`.
    * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
    *
    * Completes with a [Policy].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
@@ skipping 122 matching lines @@
 
   /**
    * Sets the access control policy on the specified resource. Replaces any
    * existing policy.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [resource] - REQUIRED: The resource for which the policy is being
-   * specified. `resource` is usually specified as a path, such as `projects / *
-   * project * / zones / * zone * / disks / * disk*`. The format for the path
-   * specified in this value is resource specific and is specified in the
-   * `setIamPolicy` documentation.
+   * specified. `resource` is usually specified as a path. For example, a
+   * Project resource is specified as `projects/{project}`.
    * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
    *
    * Completes with a [Policy].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
@@ skipping 25 matching lines @@
   }
 
   /**
    * Returns permissions that a caller has on the specified resource.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [resource] - REQUIRED: The resource for which the policy detail is being
-   * requested. `resource` is usually specified as a path, such as `projects / *
-   * project * / zones / * zone * / disks / * disk*`. The format for the path
-   * specified in this value is resource specific and is specified in the
-   * `testIamPermissions` documentation.
+   * requested. `resource` is usually specified as a path. For example, a
+   * Project resource is specified as `projects/{project}`.
    * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
    *
    * Completes with a [TestIamPermissionsResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http.Client] completes with an error when making a REST call,
    * this method will complete with the same error.
    */
@@ skipping 477 matching lines @@
 
 /**
  * A message data and its attributes. The message payload must not be empty; it
  * must contain either a non-empty data field, or at least one attribute.
  */
 class PubsubMessage {
   /** Optional attributes for this message. */
   core.Map<core.String, core.String> attributes;
   /**
    * The message payload. For JSON requests, the value of this field must be
-   * base64-encoded.
+   * [base64-encoded](https://tools.ietf.org/html/rfc4648).
    */
   core.String data;
   core.List<core.int> get dataAsBytes {
     return convert.BASE64.decode(data);
   }
 
   void set dataAsBytes(core.List<core.int> _bytes) {
     data = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
   }
   /**
@@ skipping 218 matching lines @@
 /** A subscription resource. */
 class Subscription {
   /**
    * This value is the maximum time after a subscriber receives a message before
    * the subscriber should acknowledge the message. After message delivery but
    * before the ack deadline expires and before the message is acknowledged, it
    * is an outstanding message and will not be delivered again during that time
    * (on a best-effort basis). For pull subscriptions, this value is used as the
    * initial value for the ack deadline. To override this value for a given
    * message, call `ModifyAckDeadline` with the corresponding `ack_id` if using
-   * pull. For push delivery, this value is also used to set the request timeout
-   * for the call to the push endpoint. If the subscriber never acknowledges the
-   * message, the Pub/Sub system will eventually redeliver the message. If this
-   * parameter is not set, the default value of 10 seconds is used.
+   * pull. The maximum custom deadline you can specify is 600 seconds (10
+   * minutes). For push delivery, this value is also used to set the request
+   * timeout for the call to the push endpoint. If the subscriber never
+   * acknowledges the message, the Pub/Sub system will eventually redeliver the
+   * message. If this parameter is 0, a default value of 10 seconds is used.
    */
   core.int ackDeadlineSeconds;
   /**
    * The name of the subscription. It must have the format
    * `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
    * start with a letter, and contain only letters (`[A-Za-z]`), numbers
    * (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
    * plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
    * in length, and it must not start with `"goog"`.
    */
@@ skipping 44 matching lines @@
     }
     return _json;
   }
 }
 
 /** Request message for `TestIamPermissions` method. */
 class TestIamPermissionsRequest {
   /**
    * The set of permissions to check for the `resource`. Permissions with
    * wildcards (such as '*' or 'storage.*') are not allowed. For more
-   * information see IAM Overview.
+   * information see [IAM
+   * Overview](https://cloud.google.com/iam/docs/overview#permissions).
    */
   core.List<core.String> permissions;
 
   TestIamPermissionsRequest();
 
   TestIamPermissionsRequest.fromJson(core.Map _json) {
     if (_json.containsKey("permissions")) {
       permissions = _json["permissions"];
     }
   }
@@ skipping 53 matching lines @@
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (name != null) {
       _json["name"] = name;
     }
     return _json;
   }
 }