Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1)

Unified Diff: generated/googleapis/lib/pubsub/v1.dart

Issue 2649893002: Api-roll 44: 2017-01-23 (Closed)
Patch Set: Created 3 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « generated/googleapis/lib/playmoviespartner/v1.dart ('k') | generated/googleapis/lib/servicecontrol/v1.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: generated/googleapis/lib/pubsub/v1.dart
diff --git a/generated/googleapis/lib/pubsub/v1.dart b/generated/googleapis/lib/pubsub/v1.dart
index 9e89bb9fbd091c7e5db41773496dcef95e5173a8..cd2f691a85ac45aaf7b8314845bb2dfde9e3132f 100644
--- a/generated/googleapis/lib/pubsub/v1.dart
+++ b/generated/googleapis/lib/pubsub/v1.dart
@@ -53,15 +53,17 @@ class ProjectsSnapshotsResourceApi {
_requester = client;
/**
- * Gets the access control policy for a resource. Returns an empty policy if
- * the resource exists and does not have a policy set.
+ * 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. For example, a
- * Project resource is specified as `projects/{project}`.
- * Value must have pattern "^projects/[^/] * / snapshots/[^/]*$".
+ * requested.
+ * `resource` is usually specified as a path. For example, a Project
+ * resource is specified as `projects/{project}`.
+ * Value must have pattern "^projects/[^/]+/snapshots/[^/]+$".
*
* Completes with a [Policy].
*
@@ -104,9 +106,10 @@ class ProjectsSnapshotsResourceApi {
* Request parameters:
*
* [resource] - REQUIRED: The resource for which the policy is being
- * specified. `resource` is usually specified as a path. For example, a
- * Project resource is specified as `projects/{project}`.
- * Value must have pattern "^projects/[^/] * / snapshots/[^/]*$".
+ * specified.
+ * `resource` is usually specified as a path. For example, a Project
+ * resource is specified as `projects/{project}`.
+ * Value must have pattern "^projects/[^/]+/snapshots/[^/]+$".
*
* Completes with a [Policy].
*
@@ -145,15 +148,18 @@ class ProjectsSnapshotsResourceApi {
/**
* Returns permissions that a caller has on the specified resource.
+ * If the resource does not exist, this will return an empty set of
+ * permissions, not a NOT_FOUND error.
*
* [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. For example, a
- * Project resource is specified as `projects/{project}`.
- * Value must have pattern "^projects/[^/] * / snapshots/[^/]*$".
+ * requested.
+ * `resource` is usually specified as a path. For example, a Project
+ * resource is specified as `projects/{project}`.
+ * Value must have pattern "^projects/[^/]+/snapshots/[^/]+$".
*
* Completes with a [TestIamPermissionsResponse].
*
@@ -202,16 +208,19 @@ class ProjectsSubscriptionsResourceApi {
/**
* Acknowledges the messages associated with the `ack_ids` in the
* `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
- * from the subscription. Acknowledging a message whose ack deadline has
- * expired may succeed, but such a message may be redelivered later.
- * Acknowledging a message more than once will not result in an error.
+ * from the subscription.
+ *
+ * Acknowledging a message whose ack deadline has expired may succeed,
+ * but such a message may be redelivered later. Acknowledging a message more
+ * than once will not result in an error.
*
* [request] - The metadata request object.
*
* Request parameters:
*
* [subscription] - The subscription whose message is being acknowledged.
- * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
+ * Format is `projects/{project}/subscriptions/{sub}`.
+ * Value must have pattern "^projects/[^/]+/subscriptions/[^/]+$".
*
* Completes with a [Empty].
*
@@ -249,11 +258,17 @@ class ProjectsSubscriptionsResourceApi {
}
/**
- * 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. Note that for REST API requests, you must specify a name.
+ * 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, conforming
+ * to the
+ * [resource name
+ * format](https://cloud.google.com/pubsub/docs/overview#names).
+ * The generated name is populated in the returned Subscription object.
+ * Note that for REST API requests, you must specify a name in the request.
*
* [request] - The metadata request object.
*
@@ -265,7 +280,7 @@ class ProjectsSubscriptionsResourceApi {
* (`[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"`.
- * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
+ * Value must have pattern "^projects/[^/]+/subscriptions/[^/]+$".
*
* Completes with a [Subscription].
*
@@ -306,13 +321,14 @@ class ProjectsSubscriptionsResourceApi {
* Deletes an existing subscription. All messages retained in the subscription
* are immediately dropped. Calls to `Pull` after deletion will return
* `NOT_FOUND`. After a subscription is deleted, a new one may be created with
- * the same name, but the new one has no association with the old subscription
- * or its topic unless the same topic is specified.
+ * the same name, but the new one has no association with the old
+ * subscription or its topic unless the same topic is specified.
*
* Request parameters:
*
* [subscription] - The subscription to delete.
- * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
+ * Format is `projects/{project}/subscriptions/{sub}`.
+ * Value must have pattern "^projects/[^/]+/subscriptions/[^/]+$".
*
* Completes with a [Empty].
*
@@ -352,7 +368,8 @@ class ProjectsSubscriptionsResourceApi {
* Request parameters:
*
* [subscription] - The name of the subscription to get.
- * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
+ * Format is `projects/{project}/subscriptions/{sub}`.
+ * Value must have pattern "^projects/[^/]+/subscriptions/[^/]+$".
*
* Completes with a [Subscription].
*
@@ -387,15 +404,17 @@ class ProjectsSubscriptionsResourceApi {
}
/**
- * Gets the access control policy for a resource. Returns an empty policy if
- * the resource exists and does not have a policy set.
+ * 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. For example, a
- * Project resource is specified as `projects/{project}`.
- * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
+ * 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].
*
@@ -435,13 +454,15 @@ class ProjectsSubscriptionsResourceApi {
* Request parameters:
*
* [project] - The name of the cloud project that subscriptions belong to.
- * Value must have pattern "^projects/[^/]*$".
+ * Format is `projects/{project}`.
+ * Value must have pattern "^projects/[^/]+$".
*
* [pageSize] - Maximum number of subscriptions to return.
*
* [pageToken] - The value returned by the last `ListSubscriptionsResponse`;
- * indicates that this is a continuation of a prior `ListSubscriptions` call,
- * and that the system should return the next page of data.
+ * indicates that
+ * this is a continuation of a prior `ListSubscriptions` call, and that the
+ * system should return the next page of data.
*
* Completes with a [ListSubscriptionsResponse].
*
@@ -482,18 +503,19 @@ class ProjectsSubscriptionsResourceApi {
}
/**
- * 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. Note that this does not modify the subscription-level
- * `ackDeadlineSeconds` used for subsequent messages.
+ * 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. 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/[^/]*$".
+ * Format is `projects/{project}/subscriptions/{sub}`.
+ * Value must have pattern "^projects/[^/]+/subscriptions/[^/]+$".
*
* Completes with a [Empty].
*
@@ -531,9 +553,10 @@ class ProjectsSubscriptionsResourceApi {
}
/**
- * Modifies the `PushConfig` for a specified subscription. This may be used to
- * change a push subscription to a pull one (signified by an empty
- * `PushConfig`) or vice versa, or change the endpoint URL and other
+ * Modifies the `PushConfig` for a specified subscription.
+ *
+ * This may be used to change a push subscription to a pull one (signified by
+ * an empty `PushConfig`) or vice versa, or change the endpoint URL and other
* attributes of a push subscription. Messages will accumulate for delivery
* continuously through the call regardless of changes to the `PushConfig`.
*
@@ -542,7 +565,8 @@ class ProjectsSubscriptionsResourceApi {
* Request parameters:
*
* [subscription] - The name of the subscription.
- * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
+ * Format is `projects/{project}/subscriptions/{sub}`.
+ * Value must have pattern "^projects/[^/]+/subscriptions/[^/]+$".
*
* Completes with a [Empty].
*
@@ -590,7 +614,8 @@ class ProjectsSubscriptionsResourceApi {
* Request parameters:
*
* [subscription] - The subscription from which messages should be pulled.
- * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
+ * Format is `projects/{project}/subscriptions/{sub}`.
+ * Value must have pattern "^projects/[^/]+/subscriptions/[^/]+$".
*
* Completes with a [PullResponse].
*
@@ -636,9 +661,10 @@ class ProjectsSubscriptionsResourceApi {
* Request parameters:
*
* [resource] - REQUIRED: The resource for which the policy is being
- * specified. `resource` is usually specified as a path. For example, a
- * Project resource is specified as `projects/{project}`.
- * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
+ * 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].
*
@@ -677,15 +703,18 @@ class ProjectsSubscriptionsResourceApi {
/**
* Returns permissions that a caller has on the specified resource.
+ * If the resource does not exist, this will return an empty set of
+ * permissions, not a NOT_FOUND error.
*
* [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. For example, a
- * Project resource is specified as `projects/{project}`.
- * Value must have pattern "^projects/[^/] * / subscriptions/[^/]*$".
+ * 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].
*
@@ -743,10 +772,10 @@ class ProjectsTopicsResourceApi {
* [name] - The name of the topic. It must have the format
* `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.
- * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
+ * underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+ * signs (`%`). It must be between 3 and 255 characters in length, and it
+ * must not start with `"goog"`.
+ * Value must have pattern "^projects/[^/]+/topics/[^/]+$".
*
* Completes with a [Topic].
*
@@ -793,7 +822,8 @@ class ProjectsTopicsResourceApi {
* Request parameters:
*
* [topic] - Name of the topic to delete.
- * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
+ * Format is `projects/{project}/topics/{topic}`.
+ * Value must have pattern "^projects/[^/]+/topics/[^/]+$".
*
* Completes with a [Empty].
*
@@ -833,7 +863,8 @@ class ProjectsTopicsResourceApi {
* Request parameters:
*
* [topic] - The name of the topic to get.
- * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
+ * Format is `projects/{project}/topics/{topic}`.
+ * Value must have pattern "^projects/[^/]+/topics/[^/]+$".
*
* Completes with a [Topic].
*
@@ -868,15 +899,17 @@ class ProjectsTopicsResourceApi {
}
/**
- * Gets the access control policy for a resource. Returns an empty policy if
- * the resource exists and does not have a policy set.
+ * 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. For example, a
- * Project resource is specified as `projects/{project}`.
- * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
+ * 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].
*
@@ -916,13 +949,15 @@ class ProjectsTopicsResourceApi {
* Request parameters:
*
* [project] - The name of the cloud project that topics belong to.
- * Value must have pattern "^projects/[^/]*$".
+ * Format is `projects/{project}`.
+ * Value must have pattern "^projects/[^/]+$".
*
* [pageSize] - Maximum number of topics to return.
*
* [pageToken] - The value returned by the last `ListTopicsResponse`;
- * indicates that this is a continuation of a prior `ListTopics` call, and
- * that the system should return the next page of data.
+ * indicates that this is
+ * a continuation of a prior `ListTopics` call, and that the system should
+ * return the next page of data.
*
* Completes with a [ListTopicsResponse].
*
@@ -965,14 +1000,15 @@ class ProjectsTopicsResourceApi {
/**
* Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic
* does not exist. The message payload must not be empty; it must contain
- * either a non-empty data field, or at least one attribute.
+ * either a non-empty data field, or at least one attribute.
*
* [request] - The metadata request object.
*
* Request parameters:
*
* [topic] - The messages in the request will be published on this topic.
- * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
+ * Format is `projects/{project}/topics/{topic}`.
+ * Value must have pattern "^projects/[^/]+/topics/[^/]+$".
*
* Completes with a [PublishResponse].
*
@@ -1018,9 +1054,10 @@ class ProjectsTopicsResourceApi {
* Request parameters:
*
* [resource] - REQUIRED: The resource for which the policy is being
- * specified. `resource` is usually specified as a path. For example, a
- * Project resource is specified as `projects/{project}`.
- * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
+ * 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].
*
@@ -1059,15 +1096,18 @@ class ProjectsTopicsResourceApi {
/**
* Returns permissions that a caller has on the specified resource.
+ * If the resource does not exist, this will return an empty set of
+ * permissions, not a NOT_FOUND error.
*
* [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. For example, a
- * Project resource is specified as `projects/{project}`.
- * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
+ * 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].
*
@@ -1119,14 +1159,15 @@ class ProjectsTopicsSubscriptionsResourceApi {
* Request parameters:
*
* [topic] - The name of the topic that subscriptions are attached to.
- * Value must have pattern "^projects/[^/] * / topics/[^/]*$".
+ * Format is `projects/{project}/topics/{topic}`.
+ * Value must have pattern "^projects/[^/]+/topics/[^/]+$".
*
* [pageSize] - Maximum number of subscription names to return.
*
* [pageToken] - The value returned by the last
- * `ListTopicSubscriptionsResponse`; indicates that this is a continuation of
- * a prior `ListTopicSubscriptions` call, and that the system should return
- * the next page of data.
+ * `ListTopicSubscriptionsResponse`; indicates
+ * that this is a continuation of a prior `ListTopicSubscriptions` call, and
+ * that the system should return the next page of data.
*
* Completes with a [ListTopicSubscriptionsResponse].
*
@@ -1199,23 +1240,32 @@ class AcknowledgeRequest {
class Binding {
/**
* Specifies the identities requesting access for a Cloud Platform resource.
- * `members` can have the following values: * `allUsers`: A special identifier
- * that represents anyone who is on the internet; with or without a Google
- * account. * `allAuthenticatedUsers`: A special identifier that represents
- * anyone who is authenticated with a Google account or a service account. *
- * `user:{emailid}`: An email address that represents a specific Google
- * account. For example, `alice@gmail.com` or `joe@example.com`. *
- * `serviceAccount:{emailid}`: An email address that represents a service
- * account. For example, `my-other-app@appspot.gserviceaccount.com`. *
- * `group:{emailid}`: An email address that represents a Google group. For
- * example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain
- * name that represents all the users of that domain. For example,
- * `google.com` or `example.com`.
+ * `members` can have the following values:
+ *
+ * * `allUsers`: A special identifier that represents anyone who is
+ * on the internet; with or without a Google account.
+ *
+ * * `allAuthenticatedUsers`: A special identifier that represents anyone
+ * who is authenticated with a Google account or a service account.
+ *
+ * * `user:{emailid}`: An email address that represents a specific Google
+ * account. For example, `alice@gmail.com` or `joe@example.com`.
+ *
+ *
+ * * `serviceAccount:{emailid}`: An email address that represents a service
+ * account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ *
+ * * `group:{emailid}`: An email address that represents a Google group.
+ * For example, `admins@example.com`.
+ *
+ * * `domain:{domain}`: A Google Apps domain name that represents all the
+ * users of that domain. For example, `google.com` or `example.com`.
*/
core.List<core.String> members;
/**
- * Role that is assigned to `members`. For example, `roles/viewer`,
- * `roles/editor`, or `roles/owner`. Required
+ * Role that is assigned to `members`.
+ * For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ * Required
*/
core.String role;
@@ -1244,10 +1294,14 @@ class Binding {
/**
* 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 `{}`.
+ * 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 `{}`.
*/
class Empty {
@@ -1265,9 +1319,9 @@ class Empty {
/** Response for the `ListSubscriptions` method. */
class ListSubscriptionsResponse {
/**
- * If not empty, indicates that there may be more subscriptions that match the
- * request; this value should be passed in a new `ListSubscriptionsRequest` to
- * get more subscriptions.
+ * If not empty, indicates that there may be more subscriptions that match
+ * the request; this value should be passed in a new
+ * `ListSubscriptionsRequest` to get more subscriptions.
*/
core.String nextPageToken;
/** The subscriptions that match the request. */
@@ -1299,8 +1353,8 @@ class ListSubscriptionsResponse {
/** Response for the `ListTopicSubscriptions` method. */
class ListTopicSubscriptionsResponse {
/**
- * If not empty, indicates that there may be more subscriptions that match the
- * request; this value should be passed in a new
+ * If not empty, indicates that there may be more subscriptions that match
+ * the request; this value should be passed in a new
* `ListTopicSubscriptionsRequest` to get more subscriptions.
*/
core.String nextPageToken;
@@ -1366,11 +1420,13 @@ class ListTopicsResponse {
/** Request for the ModifyAckDeadline method. */
class ModifyAckDeadlineRequest {
/**
- * The new ack deadline with respect to the time this request was sent to the
- * Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack
- * deadline will expire 10 seconds after the `ModifyAckDeadline` call was
- * made. Specifying zero may immediately make the message available for
+ * The new ack deadline with respect to the time this request was sent to
+ * the Pub/Sub system. For example, if the value is 10, the new
+ * ack deadline will expire 10 seconds after the `ModifyAckDeadline` call
+ * was made. Specifying zero may immediately make the message available for
* another pull request.
+ * The minimum deadline you can specify is 0 seconds.
+ * The maximum deadline you can specify is 600 seconds (10 minutes).
*/
core.int ackDeadlineSeconds;
/** List of acknowledgment IDs. */
@@ -1402,10 +1458,12 @@ class ModifyAckDeadlineRequest {
/** Request for the ModifyPushConfig method. */
class ModifyPushConfigRequest {
/**
- * The push configuration for future deliveries. An empty `pushConfig`
- * indicates that the Pub/Sub system should stop pushing messages from the
- * given subscription and allow messages to be pulled and acknowledged -
- * effectively pausing the subscription if `Pull` is not called.
+ * The push configuration for future deliveries.
+ *
+ * An empty `pushConfig` indicates that the Pub/Sub system should
+ * stop pushing messages from the given subscription and allow
+ * messages to be pulled and acknowledged - effectively pausing
+ * the subscription if `Pull` is not called.
*/
PushConfig pushConfig;
@@ -1427,33 +1485,54 @@ class ModifyPushConfigRequest {
}
/**
- * Defines an Identity and Access Management (IAM) policy. It is used to specify
- * access control policies for Cloud Platform resources. A `Policy` consists of
- * a list of `bindings`. A `Binding` binds a list of `members` to a `role`,
- * where the members can be user accounts, Google groups, Google domains, and
- * service accounts. A `role` is a named list of permissions defined by IAM.
- * **Example** { "bindings": [ { "role": "roles/owner", "members": [
- * "user:mike@example.com", "group:admins@example.com", "domain:google.com",
- * "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role":
- * "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description
- * of IAM and its features, see the [IAM developer's
- * guide](https://cloud.google.com/iam).
+ * Defines an Identity and Access Management (IAM) policy. It is used to
+ * specify access control policies for Cloud Platform resources.
+ *
+ *
+ * A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+ * `members` to a `role`, where the members can be user accounts, Google groups,
+ * Google domains, and service accounts. A `role` is a named list of permissions
+ * defined by IAM.
+ *
+ * **Example**
+ *
+ * {
+ * "bindings": [
+ * {
+ * "role": "roles/owner",
+ * "members": [
+ * "user:mike@example.com",
+ * "group:admins@example.com",
+ * "domain:google.com",
+ * "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+ * ]
+ * },
+ * {
+ * "role": "roles/viewer",
+ * "members": ["user:sean@example.com"]
+ * }
+ * ]
+ * }
+ *
+ * For a description of IAM and its features, see the
+ * [IAM developer's guide](https://cloud.google.com/iam).
*/
class Policy {
/**
- * Associates a list of `members` to a `role`. Multiple `bindings` must not be
- * specified for the same `role`. `bindings` with no members will result in an
- * error.
+ * Associates a list of `members` to a `role`.
+ * Multiple `bindings` must not be specified for the same `role`.
+ * `bindings` with no members will result in an error.
*/
core.List<Binding> bindings;
/**
- * `etag` is used for optimistic concurrency control as a way to help prevent
- * simultaneous updates of a policy from overwriting each other. It is
- * strongly suggested that systems make use of the `etag` in the
+ * `etag` is used for optimistic concurrency control as a way to help
+ * prevent simultaneous updates of a policy from overwriting each other.
+ * It is strongly suggested that systems make use of the `etag` in the
* read-modify-write cycle to perform policy updates in order to avoid race
* conditions: An `etag` is returned in the response to `getIamPolicy`, and
* systems are expected to put that etag in the request to `setIamPolicy` to
* ensure that their change will be applied to the same version of the policy.
+ *
* If no `etag` is provided in the call to `setIamPolicy`, then the existing
* policy is overwritten blindly.
*/
@@ -1522,8 +1601,9 @@ class PublishRequest {
/** Response for the `Publish` method. */
class PublishResponse {
/**
- * The server-assigned ID of each published message, in the same order as the
- * messages in the request. IDs are guaranteed to be unique within the topic.
+ * The server-assigned ID of each published message, in the same order as
+ * the messages in the request. IDs are guaranteed to be unique within
+ * the topic.
*/
core.List<core.String> messageIds;
@@ -1545,16 +1625,13 @@ class PublishResponse {
}
/**
- * 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.
+ * 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](https://tools.ietf.org/html/rfc4648).
- */
+ /** The message payload. */
core.String data;
core.List<core.int> get dataAsBytes {
return convert.BASE64.decode(data);
@@ -1572,8 +1649,8 @@ class PubsubMessage {
core.String messageId;
/**
* The time at which the message was published, populated by the server when
- * it receives the `Publish` call. It must not be populated by the publisher
- * in a `Publish` call.
+ * it receives the `Publish` call. It must not be populated by the
+ * publisher in a `Publish` call.
*/
core.String publishTime;
@@ -1620,11 +1697,12 @@ class PullRequest {
*/
core.int maxMessages;
/**
- * If this is specified as true the system will respond immediately even if it
- * is not able to return a message in the `Pull` response. Otherwise the
- * system is allowed to wait until at least one message is available rather
- * than returning no messages. The client may cancel the request if it does
- * not wish to wait any longer for the response.
+ * If this field set to true, the system will respond immediately even if
+ * it there are no messages available to return in the `Pull` response.
+ * Otherwise, the system may wait (for a bounded amount of time) until at
+ * least one message is available, rather than returning no messages. The
+ * client may cancel the request if it does not wish to wait any longer for
+ * the response.
*/
core.bool returnImmediately;
@@ -1681,25 +1759,33 @@ class PullResponse {
/** Configuration for a push delivery endpoint. */
class PushConfig {
/**
- * Endpoint configuration attributes. Every endpoint has a set of API
- * supported attributes that can be used to control different aspects of the
- * message delivery. The currently supported attribute is `x-goog-version`,
- * which you can use to change the format of the push message. This attribute
- * indicates the version of the data expected by the endpoint. This controls
- * the shape of the envelope (i.e. its fields and metadata). The endpoint
- * version is based on the version of the Pub/Sub API. If not present during
- * the `CreateSubscription` call, it will default to the version of the API
- * used to make such call. If not present during a `ModifyPushConfig` call,
- * its value will not be changed. `GetSubscription` calls will always return a
- * valid version, even if the subscription was created without this attribute.
- * The possible values for this attribute are: * `v1beta1`: uses the push
- * format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the
- * push format defined in the v1 Pub/Sub API.
+ * Endpoint configuration attributes.
+ *
+ * Every endpoint has a set of API supported attributes that can be used to
+ * control different aspects of the message delivery.
+ *
+ * The currently supported attribute is `x-goog-version`, which you can
+ * use to change the format of the push message. This attribute
+ * indicates the version of the data expected by the endpoint. This
+ * controls the shape of the envelope (i.e. its fields and metadata).
+ * The endpoint version is based on the version of the Pub/Sub
+ * API.
+ *
+ * If not present during the `CreateSubscription` call, it will default to
+ * the version of the API used to make such call. If not present during a
+ * `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
+ * calls will always return a valid version, even if the subscription was
+ * created without this attribute.
+ *
+ * The possible values for this attribute are:
+ *
+ * * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
+ * * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
*/
core.Map<core.String, core.String> attributes;
/**
- * A URL locating the endpoint to which messages should be pushed. For
- * example, a Webhook endpoint might use "https://example.com/push".
+ * A URL locating the endpoint to which messages should be pushed.
+ * For example, a Webhook endpoint might use "https://example.com/push".
*/
core.String pushEndpoint;
@@ -1760,8 +1846,9 @@ class ReceivedMessage {
class SetIamPolicyRequest {
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size of
- * the policy is limited to a few 10s of KB. An empty policy is a valid policy
- * but certain Cloud Platform services (such as Projects) might reject them.
+ * the policy is limited to a few 10s of KB. An empty policy is a
+ * valid policy but certain Cloud Platform services (such as Projects)
+ * might reject them.
*/
Policy policy;
@@ -1785,18 +1872,25 @@ class SetIamPolicyRequest {
/** 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. 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.
+ * 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.
+ * The minimum custom deadline you can specify is 10 seconds.
+ * The maximum custom deadline you can specify is 600 seconds (10 minutes).
+ * If this parameter is 0, a default value of 10 seconds is used.
+ *
+ * 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.
*/
core.int ackDeadlineSeconds;
/**
@@ -1809,13 +1903,14 @@ class Subscription {
*/
core.String name;
/**
- * If push delivery is used with this subscription, this field is used to
- * configure it. An empty `pushConfig` signifies that the subscriber will pull
- * and ack messages using API methods.
+ * If push delivery is used with this subscription, this field is
+ * used to configure it. An empty `pushConfig` signifies that the subscriber
+ * will pull and ack messages using API methods.
*/
PushConfig pushConfig;
/**
* The name of the topic from which this subscription is receiving messages.
+ * Format is `projects/{project}/topics/{topic}`.
* The value of this field will be `_deleted-topic_` if the topic has been
* deleted.
*/
@@ -1861,8 +1956,8 @@ 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](https://cloud.google.com/iam/docs/overview#permissions).
+ * information see
+ * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
core.List<core.String> permissions;
@@ -1914,9 +2009,9 @@ class Topic {
* The name of the topic. It must have the format
* `"projects/{project}/topics/{topic}"`. `{topic}` 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"`.
+ * underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
+ * signs (`%`). It must be between 3 and 255 characters in length, and it
+ * must not start with `"goog"`.
*/
core.String name;
« no previous file with comments | « generated/googleapis/lib/playmoviespartner/v1.dart ('k') | generated/googleapis/lib/servicecontrol/v1.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698