| Index: generated/googleapis/lib/cloudresourcemanager/v1.dart
|
| diff --git a/generated/googleapis/lib/cloudresourcemanager/v1.dart b/generated/googleapis/lib/cloudresourcemanager/v1.dart
|
| index b85e5e79c5051ec16e3d404f23c620d3d52bcb5c..d845f7a357039ea4bbfe628494f53908d8f8f86a 100644
|
| --- a/generated/googleapis/lib/cloudresourcemanager/v1.dart
|
| +++ b/generated/googleapis/lib/cloudresourcemanager/v1.dart
|
| @@ -44,14 +44,14 @@ class OperationsResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * 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.
|
| *
|
| * Request parameters:
|
| *
|
| * [name] - The name of the operation resource.
|
| - * Value must have pattern "^operations/.*$".
|
| + * Value must have pattern "^operations/.+$".
|
| *
|
| * Completes with a [Operation].
|
| *
|
| @@ -101,7 +101,7 @@ class OrganizationsResourceApi {
|
| *
|
| * [name] - The resource name of the Organization to fetch, e.g.
|
| * "organizations/1234".
|
| - * Value must have pattern "^organizations/[^/]*$".
|
| + * Value must have pattern "^organizations/[^/]+$".
|
| *
|
| * Completes with a [Organization].
|
| *
|
| @@ -145,9 +145,10 @@ class OrganizationsResourceApi {
|
| * 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 "^organizations/[^/]*$".
|
| + * requested.
|
| + * `resource` is usually specified as a path. For example, a Project
|
| + * resource is specified as `projects/{project}`.
|
| + * Value must have pattern "^organizations/[^/]+$".
|
| *
|
| * Completes with a [Policy].
|
| *
|
| @@ -236,9 +237,10 @@ class OrganizationsResourceApi {
|
| * 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 "^organizations/[^/]*$".
|
| + * specified.
|
| + * `resource` is usually specified as a path. For example, a Project
|
| + * resource is specified as `projects/{project}`.
|
| + * Value must have pattern "^organizations/[^/]+$".
|
| *
|
| * Completes with a [Policy].
|
| *
|
| @@ -276,18 +278,19 @@ class OrganizationsResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns permissions that a caller has on the specified Organization. The
|
| - * `resource` field should be the organization's resource name, e.g.
|
| - * "organizations/123".
|
| + * Returns permissions that a caller has on the specified Organization.
|
| + * The `resource` field should be the organization's resource name,
|
| + * e.g. "organizations/123".
|
| *
|
| * [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 "^organizations/[^/]*$".
|
| + * requested.
|
| + * `resource` is usually specified as a path. For example, a Project
|
| + * resource is specified as `projects/{project}`.
|
| + * Value must have pattern "^organizations/[^/]+$".
|
| *
|
| * Completes with a [TestIamPermissionsResponse].
|
| *
|
| @@ -334,13 +337,14 @@ class ProjectsResourceApi {
|
| _requester = client;
|
|
|
| /**
|
| - * Request that a new Project be created. The result is an Operation which can
|
| - * be used to track the creation process. It is automatically deleted after a
|
| - * few hours, so there is no need to call DeleteOperation. Our SLO permits
|
| - * Project creation to take up to 30 seconds at the 90th percentile. As of
|
| - * 2016-08-29, we are observing 6 seconds 50th percentile latency. 95th
|
| - * percentile latency is around 11 seconds. We recommend polling at the 5th
|
| - * second with an exponential backoff.
|
| + * Request that a new Project be created. The result is an Operation which
|
| + * can be used to track the creation process. It is automatically deleted
|
| + * after a few hours, so there is no need to call DeleteOperation.
|
| + *
|
| + * Our SLO permits Project creation to take up to 30 seconds at the 90th
|
| + * percentile. As of 2016-08-29, we are observing 6 seconds 50th percentile
|
| + * latency. 95th percentile latency is around 11 seconds. We recommend
|
| + * polling at the 5th second with an exponential backoff.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| @@ -379,22 +383,36 @@ class ProjectsResourceApi {
|
| }
|
|
|
| /**
|
| - * Marks the Project identified by the specified `project_id` (for example,
|
| - * `my-project-123`) for deletion. This method will only affect the Project if
|
| - * the following criteria are met: + The Project does not have a billing
|
| - * account associated with it. + The Project has a lifecycle state of ACTIVE.
|
| - * This method changes the Project's lifecycle state from ACTIVE to
|
| - * DELETE_REQUESTED. The deletion starts at an unspecified time, at which
|
| - * point the Project is no longer accessible. Until the deletion completes,
|
| - * you can check the lifecycle state checked by retrieving the Project with
|
| - * GetProject, and the Project remains visible to ListProjects. However, you
|
| - * cannot update the project. After the deletion completes, the Project is not
|
| - * retrievable by the GetProject and ListProjects methods. The caller must
|
| - * have modify permissions for this Project.
|
| + * Marks the Project identified by the specified
|
| + * `project_id` (for example, `my-project-123`) for deletion.
|
| + * This method will only affect the Project if the following criteria are met:
|
| + *
|
| + * + The Project does not have a billing account associated with it.
|
| + * + The Project has a lifecycle state of
|
| + * ACTIVE.
|
| + *
|
| + * This method changes the Project's lifecycle state from
|
| + * ACTIVE
|
| + * to DELETE_REQUESTED.
|
| + * The deletion starts at an unspecified time,
|
| + * at which point the Project is no longer accessible.
|
| + *
|
| + * Until the deletion completes, you can check the lifecycle state
|
| + * checked by retrieving the Project with GetProject,
|
| + * and the Project remains visible to ListProjects.
|
| + * However, you cannot update the project.
|
| + *
|
| + * After the deletion completes, the Project is not retrievable by
|
| + * the GetProject and
|
| + * ListProjects methods.
|
| + *
|
| + * The caller must have modify permissions for this Project.
|
| *
|
| * Request parameters:
|
| *
|
| - * [projectId] - The Project ID (for example, `foo-bar-123`). Required.
|
| + * [projectId] - The Project ID (for example, `foo-bar-123`).
|
| + *
|
| + * Required.
|
| *
|
| * Completes with a [Empty].
|
| *
|
| @@ -429,13 +447,16 @@ class ProjectsResourceApi {
|
| }
|
|
|
| /**
|
| - * Retrieves the Project identified by the specified `project_id` (for
|
| - * example, `my-project-123`). The caller must have read permissions for this
|
| - * Project.
|
| + * Retrieves the Project identified by the specified
|
| + * `project_id` (for example, `my-project-123`).
|
| + *
|
| + * The caller must have read permissions for this Project.
|
| *
|
| * Request parameters:
|
| *
|
| - * [projectId] - The Project ID (for example, `my-project-123`). Required.
|
| + * [projectId] - The Project ID (for example, `my-project-123`).
|
| + *
|
| + * Required.
|
| *
|
| * Completes with a [Project].
|
| *
|
| @@ -470,16 +491,66 @@ class ProjectsResourceApi {
|
| }
|
|
|
| /**
|
| - * Returns the IAM access control policy for the specified Project. Permission
|
| - * is denied if the policy or the resource does not exist.
|
| + * Gets a list of ancestors in the resource hierarchy for the Project
|
| + * identified by the specified `project_id` (for example, `my-project-123`).
|
| + *
|
| + * The caller must have read permissions for this Project.
|
| + *
|
| + * [request] - The metadata request object.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [projectId] - The Project ID (for example, `my-project-123`).
|
| + *
|
| + * Required.
|
| + *
|
| + * Completes with a [GetAncestryResponse].
|
| + *
|
| + * 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.
|
| + */
|
| + async.Future<GetAncestryResponse> getAncestry(GetAncestryRequest request, core.String projectId) {
|
| + var _url = null;
|
| + var _queryParams = new core.Map();
|
| + var _uploadMedia = null;
|
| + var _uploadOptions = null;
|
| + var _downloadOptions = commons.DownloadOptions.Metadata;
|
| + var _body = null;
|
| +
|
| + if (request != null) {
|
| + _body = convert.JSON.encode((request).toJson());
|
| + }
|
| + if (projectId == null) {
|
| + throw new core.ArgumentError("Parameter projectId is required.");
|
| + }
|
| +
|
| + _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + ':getAncestry';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GetAncestryResponse.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Returns the IAM access control policy for the specified Project.
|
| + * Permission is denied if the policy or the resource does not exist.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| * 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}`.
|
| + * requested.
|
| + * `resource` is usually specified as a path. For example, a Project
|
| + * resource is specified as `projects/{project}`.
|
| *
|
| * Completes with a [Policy].
|
| *
|
| @@ -517,29 +588,46 @@ class ProjectsResourceApi {
|
| }
|
|
|
| /**
|
| - * Lists Projects that are visible to the user and satisfy the specified
|
| - * filter. This method returns Projects in an unspecified order. New Projects
|
| - * do not necessarily appear at the end of the list.
|
| + * Lists Projects that are visible to the user and satisfy the
|
| + * specified filter. This method returns Projects in an unspecified order.
|
| + * New Projects do not necessarily appear at the end of the list.
|
| *
|
| * Request parameters:
|
| *
|
| + * [pageSize] - The maximum number of Projects to return in the response.
|
| + * The server can return fewer Projects than requested.
|
| + * If unspecified, server picks an appropriate default.
|
| + *
|
| + * Optional.
|
| + *
|
| + * [filter] - An expression for filtering the results of the request. Filter
|
| + * rules are
|
| + * case insensitive. The fields eligible for filtering are:
|
| + *
|
| + * + `name`
|
| + * + `id`
|
| + * + <code>labels.<em>key</em></code> where *key* is the name of a label
|
| + *
|
| + * Some examples of using labels as filters:
|
| + *
|
| + * |Filter|Description|
|
| + * |------|-----------|
|
| + * |name:*|The project has a name.|
|
| + * |name:Howl|The project's name is `Howl` or `howl`.|
|
| + * |name:HOWL|Equivalent to above.|
|
| + * |NAME:howl|Equivalent to above.|
|
| + * |labels.color:*|The project has the label `color`.|
|
| + * |labels.color:red|The project's label `color` has the value `red`.|
|
| + * |labels.color:red label.size:big|The project's label `color` has the
|
| + * value `red` and its label `size` has the value `big`.
|
| + *
|
| + * Optional.
|
| + *
|
| * [pageToken] - A pagination token returned from a previous call to
|
| - * ListProjects that indicates from where listing should continue. Optional.
|
| - *
|
| - * [pageSize] - The maximum number of Projects to return in the response. The
|
| - * server can return fewer Projects than requested. If unspecified, server
|
| - * picks an appropriate default. Optional.
|
| - *
|
| - * [filter] - An expression for filtering the results of the request. Filter
|
| - * rules are case insensitive. The fields eligible for filtering are: + `name`
|
| - * + `id` + labels.key where *key* is the name of a label Some examples of
|
| - * using labels as filters: |Filter|Description| |------|-----------|
|
| - * |name:*|The project has a name.| |name:Howl|The project's name is `Howl` or
|
| - * `howl`.| |name:HOWL|Equivalent to above.| |NAME:howl|Equivalent to above.|
|
| - * |labels.color:*|The project has the label `color`.| |labels.color:red|The
|
| - * project's label `color` has the value `red`.|
|
| - * |labels.color:red label.size:big|The project's label `color` has the value
|
| - * `red` and its label `size` has the value `big`. Optional.
|
| + * ListProjects
|
| + * that indicates from where listing should continue.
|
| + *
|
| + * Optional.
|
| *
|
| * Completes with a [ListProjectsResponse].
|
| *
|
| @@ -549,7 +637,7 @@ class ProjectsResourceApi {
|
| * If the used [http.Client] completes with an error when making a REST call,
|
| * this method will complete with the same error.
|
| */
|
| - async.Future<ListProjectsResponse> list({core.String pageToken, core.int pageSize, core.String filter}) {
|
| + async.Future<ListProjectsResponse> list({core.int pageSize, core.String filter, core.String pageToken}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -557,15 +645,15 @@ class ProjectsResourceApi {
|
| var _downloadOptions = commons.DownloadOptions.Metadata;
|
| var _body = null;
|
|
|
| - if (pageToken != null) {
|
| - _queryParams["pageToken"] = [pageToken];
|
| - }
|
| if (pageSize != null) {
|
| _queryParams["pageSize"] = ["${pageSize}"];
|
| }
|
| if (filter != null) {
|
| _queryParams["filter"] = [filter];
|
| }
|
| + if (pageToken != null) {
|
| + _queryParams["pageToken"] = [pageToken];
|
| + }
|
|
|
| _url = 'v1/projects';
|
|
|
| @@ -580,27 +668,41 @@ class ProjectsResourceApi {
|
| }
|
|
|
| /**
|
| - * Sets the IAM access control policy for the specified Project. Replaces any
|
| - * existing policy. The following constraints apply when using
|
| - * `setIamPolicy()`: + Project does not support `allUsers` and
|
| - * `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The
|
| - * owner role can be granted only to `user` and `serviceAccount`. + Service
|
| - * accounts can be made owners of a project directly without any restrictions.
|
| - * However, to be added as an owner, a user must be invited via Cloud Platform
|
| - * console and must accept the invitation. + A user cannot be granted the
|
| - * owner role using `setIamPolicy()`. The user must be granted the owner role
|
| - * using the Cloud Platform Console and must explicitly accept the invitation.
|
| + * Sets the IAM access control policy for the specified Project. Replaces
|
| + * any existing policy.
|
| + *
|
| + * The following constraints apply when using `setIamPolicy()`:
|
| + *
|
| + * + Project does not support `allUsers` and `allAuthenticatedUsers` as
|
| + * `members` in a `Binding` of a `Policy`.
|
| + *
|
| + * + The owner role can be granted only to `user` and `serviceAccount`.
|
| + *
|
| + * + Service accounts can be made owners of a project directly
|
| + * without any restrictions. However, to be added as an owner, a user must be
|
| + * invited via Cloud Platform console and must accept the invitation.
|
| + *
|
| + * + A user cannot be granted the owner role using `setIamPolicy()`. The user
|
| + * must be granted the owner role using the Cloud Platform Console and must
|
| + * explicitly accept the invitation.
|
| + *
|
| * + Invitations to grant the owner role cannot be sent using
|
| - * `setIamPolicy()`; they must be sent only using the Cloud Platform Console.
|
| + * `setIamPolicy()`;
|
| + * they must be sent only using the Cloud Platform Console.
|
| + *
|
| * + Membership changes that leave the project without any owners that have
|
| - * accepted the Terms of Service (ToS) will be rejected. + There must be at
|
| - * least one owner who has accepted the Terms of Service (ToS) agreement in
|
| - * the policy. Calling `setIamPolicy()` to to remove the last ToS-accepted
|
| - * owner from the policy will fail. This restriction also applies to legacy
|
| - * projects that no longer have owners who have accepted the ToS. Edits to IAM
|
| - * policies will be rejected until the lack of a ToS-accepting owner is
|
| - * rectified. + Calling this method requires enabling the App Engine Admin
|
| - * API. Note: Removing service accounts from policies or changing their roles
|
| + * accepted the Terms of Service (ToS) will be rejected.
|
| + *
|
| + * + There must be at least one owner who has accepted the Terms of
|
| + * Service (ToS) agreement in the policy. Calling `setIamPolicy()` to
|
| + * to remove the last ToS-accepted owner from the policy will fail. This
|
| + * restriction also applies to legacy projects that no longer have owners
|
| + * who have accepted the ToS. Edits to IAM policies will be rejected until
|
| + * the lack of a ToS-accepting owner is rectified.
|
| + *
|
| + * + Calling this method requires enabling the App Engine Admin API.
|
| + *
|
| + * Note: Removing service accounts from policies or changing their roles
|
| * can render services completely inoperable. It is important to understand
|
| * how the service account is being used before removing or updating its
|
| * roles.
|
| @@ -610,8 +712,9 @@ class ProjectsResourceApi {
|
| * 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}`.
|
| + * specified.
|
| + * `resource` is usually specified as a path. For example, a Project
|
| + * resource is specified as `projects/{project}`.
|
| *
|
| * Completes with a [Policy].
|
| *
|
| @@ -656,8 +759,9 @@ class ProjectsResourceApi {
|
| * 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}`.
|
| + * requested.
|
| + * `resource` is usually specified as a path. For example, a Project
|
| + * resource is specified as `projects/{project}`.
|
| *
|
| * Completes with a [TestIamPermissionsResponse].
|
| *
|
| @@ -695,17 +799,21 @@ class ProjectsResourceApi {
|
| }
|
|
|
| /**
|
| - * Restores the Project identified by the specified `project_id` (for example,
|
| - * `my-project-123`). You can only use this method for a Project that has a
|
| - * lifecycle state of DELETE_REQUESTED. After deletion starts, the Project
|
| - * cannot be restored. The caller must have modify permissions for this
|
| - * Project.
|
| + * Restores the Project identified by the specified
|
| + * `project_id` (for example, `my-project-123`).
|
| + * You can only use this method for a Project that has a lifecycle state of
|
| + * DELETE_REQUESTED.
|
| + * After deletion starts, the Project cannot be restored.
|
| + *
|
| + * The caller must have modify permissions for this Project.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| * Request parameters:
|
| *
|
| - * [projectId] - The project ID (for example, `foo-bar-123`). Required.
|
| + * [projectId] - The project ID (for example, `foo-bar-123`).
|
| + *
|
| + * Required.
|
| *
|
| * Completes with a [Empty].
|
| *
|
| @@ -744,14 +852,17 @@ class ProjectsResourceApi {
|
|
|
| /**
|
| * Updates the attributes of the Project identified by the specified
|
| - * `project_id` (for example, `my-project-123`). The caller must have modify
|
| - * permissions for this Project.
|
| + * `project_id` (for example, `my-project-123`).
|
| + *
|
| + * The caller must have modify permissions for this Project.
|
| *
|
| * [request] - The metadata request object.
|
| *
|
| * Request parameters:
|
| *
|
| - * [projectId] - The project ID (for example, `my-project-123`). Required.
|
| + * [projectId] - The project ID (for example, `my-project-123`).
|
| + *
|
| + * Required.
|
| *
|
| * Completes with a [Project].
|
| *
|
| @@ -792,27 +903,58 @@ class ProjectsResourceApi {
|
|
|
|
|
|
|
| +/** Identifying information for a single ancestor of a project. */
|
| +class Ancestor {
|
| + /** Resource id of the ancestor. */
|
| + ResourceId resourceId;
|
| +
|
| + Ancestor();
|
| +
|
| + Ancestor.fromJson(core.Map _json) {
|
| + if (_json.containsKey("resourceId")) {
|
| + resourceId = new ResourceId.fromJson(_json["resourceId"]);
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (resourceId != null) {
|
| + _json["resourceId"] = (resourceId).toJson();
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| /** Associates `members` with a `role`. */
|
| 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;
|
|
|
| @@ -841,10 +983,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 {
|
|
|
| @@ -862,8 +1008,8 @@ class Empty {
|
| /** Metadata describing a long running folder operation */
|
| class FolderOperation {
|
| /**
|
| - * The resource name of the folder or organization we are either creating the
|
| - * folder under or moving the folder to.
|
| + * The resource name of the folder or organization we are either creating
|
| + * the folder under or moving the folder to.
|
| */
|
| core.String destinationParent;
|
| /** The display name of the folder. */
|
| @@ -871,14 +1017,14 @@ class FolderOperation {
|
| /**
|
| * The type of this operation.
|
| * Possible string values are:
|
| - * - "OPERATION_TYPE_UNSPECIFIED" : A OPERATION_TYPE_UNSPECIFIED.
|
| - * - "CREATE" : A CREATE.
|
| - * - "MOVE" : A MOVE.
|
| + * - "OPERATION_TYPE_UNSPECIFIED" : Operation type not specified.
|
| + * - "CREATE" : A create folder operation.
|
| + * - "MOVE" : A move folder operation.
|
| */
|
| core.String operationType;
|
| /**
|
| - * The resource name of the folder's parent. Only applicable when the
|
| - * operation_type is MOVE.
|
| + * The resource name of the folder's parent.
|
| + * Only applicable when the operation_type is MOVE.
|
| */
|
| core.String sourceParent;
|
|
|
| @@ -922,15 +1068,24 @@ class FolderOperationError {
|
| /**
|
| * The type of operation error experienced.
|
| * Possible string values are:
|
| - * - "ERROR_TYPE_UNSPECIFIED" : A ERROR_TYPE_UNSPECIFIED.
|
| - * - "FOLDER_HEIGHT_VIOLATION" : A FOLDER_HEIGHT_VIOLATION.
|
| - * - "MAX_CHILD_FOLDERS_VIOLATION" : A MAX_CHILD_FOLDERS_VIOLATION.
|
| - * - "FOLDER_NAME_UNIQUENESS_VIOLATION" : A FOLDER_NAME_UNIQUENESS_VIOLATION.
|
| - * - "RESOURCE_DELETED" : A RESOURCE_DELETED.
|
| - * - "PARENT_DELETED" : A PARENT_DELETED.
|
| - * - "CYCLE_INTRODUCED_ERROR" : A CYCLE_INTRODUCED_ERROR.
|
| - * - "FOLDER_ALREADY_BEING_MOVED" : A FOLDER_ALREADY_BEING_MOVED.
|
| - * - "FOLDER_TO_DELETE_NON_EMPTY" : A FOLDER_TO_DELETE_NON_EMPTY.
|
| + * - "ERROR_TYPE_UNSPECIFIED" : The error type was unrecognized or
|
| + * unspecified.
|
| + * - "FOLDER_HEIGHT_VIOLATION" : The attempted action would violate the max
|
| + * folder depth constraint.
|
| + * - "MAX_CHILD_FOLDERS_VIOLATION" : The attempted action would violate the
|
| + * max child folders constraint.
|
| + * - "FOLDER_NAME_UNIQUENESS_VIOLATION" : The attempted action would violate
|
| + * the locally-unique folder
|
| + * display_name constraint.
|
| + * - "RESOURCE_DELETED" : The resource being moved has been deleted.
|
| + * - "PARENT_DELETED" : The resource a folder was being added to has been
|
| + * deleted.
|
| + * - "CYCLE_INTRODUCED_ERROR" : The attempted action would introduce cycle in
|
| + * resource path.
|
| + * - "FOLDER_ALREADY_BEING_MOVED" : The attempted action would move a folder
|
| + * that is already being moved.
|
| + * - "FOLDER_TO_DELETE_NON_EMPTY" : The folder the caller is trying to delete
|
| + * contains active resources.
|
| */
|
| core.String errorMessageId;
|
|
|
| @@ -951,6 +1106,50 @@ class FolderOperationError {
|
| }
|
| }
|
|
|
| +/**
|
| + * The request sent to the
|
| + * GetAncestry
|
| + * method.
|
| + */
|
| +class GetAncestryRequest {
|
| +
|
| + GetAncestryRequest();
|
| +
|
| + GetAncestryRequest.fromJson(core.Map _json) {
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Response from the GetAncestry method. */
|
| +class GetAncestryResponse {
|
| + /**
|
| + * Ancestors are ordered from bottom to top of the resource hierarchy. The
|
| + * first ancestor is the project itself, followed by the project's parent,
|
| + * etc.
|
| + */
|
| + core.List<Ancestor> ancestor;
|
| +
|
| + GetAncestryResponse();
|
| +
|
| + GetAncestryResponse.fromJson(core.Map _json) {
|
| + if (_json.containsKey("ancestor")) {
|
| + ancestor = _json["ancestor"].map((value) => new Ancestor.fromJson(value)).toList();
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (ancestor != null) {
|
| + _json["ancestor"] = ancestor.map((value) => (value).toJson()).toList();
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| /** Request message for `GetIamPolicy` method. */
|
| class GetIamPolicyRequest {
|
|
|
| @@ -966,24 +1165,32 @@ class GetIamPolicyRequest {
|
| }
|
|
|
| /**
|
| - * A page of the response received from the ListProjects method. A paginated
|
| - * response where more pages are available has `next_page_token` set. This token
|
| - * can be used in a subsequent request to retrieve the next request page.
|
| + * A page of the response received from the
|
| + * ListProjects
|
| + * method.
|
| + *
|
| + * A paginated response where more pages are available has
|
| + * `next_page_token` set. This token can be used in a subsequent request to
|
| + * retrieve the next request page.
|
| */
|
| class ListProjectsResponse {
|
| /**
|
| - * Pagination token. If the result set is too large to fit in a single
|
| - * response, this token is returned. It encodes the position of the current
|
| - * result cursor. Feeding this value into a new list request with the
|
| - * `page_token` parameter gives the next page of the results. When
|
| - * `next_page_token` is not filled in, there is no next page and the list
|
| - * returned is the last page in the result set. Pagination tokens have a
|
| - * limited lifetime.
|
| + * Pagination token.
|
| + *
|
| + * If the result set is too large to fit in a single response, this token
|
| + * is returned. It encodes the position of the current result cursor.
|
| + * Feeding this value into a new list request with the `page_token` parameter
|
| + * gives the next page of the results.
|
| + *
|
| + * When `next_page_token` is not filled in, there is no next page and
|
| + * the list returned is the last page in the result set.
|
| + *
|
| + * Pagination tokens have a limited lifetime.
|
| */
|
| core.String nextPageToken;
|
| /**
|
| - * The list of Projects that matched the list filter. This list can be
|
| - * paginated.
|
| + * The list of Projects that matched the list filter. This list can
|
| + * be paginated.
|
| */
|
| core.List<Project> projects;
|
|
|
| @@ -1016,17 +1223,17 @@ class ListProjectsResponse {
|
| */
|
| 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. */
|
| + /** The error result of the operation in case of failure or cancellation. */
|
| Status error;
|
| /**
|
| - * 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
|
| + * 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
|
| * long-running operation should document the metadata type, if any.
|
| *
|
| * The values for Object must be JSON objects. It can consist of `num`,
|
| @@ -1035,18 +1242,19 @@ class Operation {
|
| 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 `name`
|
| - * should have the format of `operations/some/unique/name`.
|
| + * originally returns it. If you use the default HTTP mapping, the
|
| + * `name` should have the format of `operations/some/unique/name`.
|
| */
|
| 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.
|
| @@ -1095,8 +1303,8 @@ class Operation {
|
| }
|
|
|
| /**
|
| - * The root node in the resource hierarchy to which a particular entity's (e.g.,
|
| - * company) resources belong.
|
| + * The root node in the resource hierarchy to which a particular entity's
|
| + * (e.g., company) resources belong.
|
| */
|
| class Organization {
|
| /**
|
| @@ -1107,16 +1315,19 @@ class Organization {
|
| /**
|
| * A friendly string to be used to refer to the Organization in the UI.
|
| * Assigned by the server, set to the firm name of the Google For Work
|
| - * customer that owns this organization. @OutputOnly
|
| + * customer that owns this organization.
|
| + * @OutputOnly
|
| */
|
| core.String displayName;
|
| /**
|
| * The organization's current lifecycle state. Assigned by the server.
|
| * @OutputOnly
|
| * Possible string values are:
|
| - * - "LIFECYCLE_STATE_UNSPECIFIED" : A LIFECYCLE_STATE_UNSPECIFIED.
|
| - * - "ACTIVE" : A ACTIVE.
|
| - * - "DELETE_REQUESTED" : A DELETE_REQUESTED.
|
| + * - "LIFECYCLE_STATE_UNSPECIFIED" : Unspecified state. This is only useful
|
| + * for distinguishing unset values.
|
| + * - "ACTIVE" : The normal and active state.
|
| + * - "DELETE_REQUESTED" : The organization has been marked for deletion by the
|
| + * user.
|
| */
|
| core.String lifecycleState;
|
| /**
|
| @@ -1126,8 +1337,9 @@ class Organization {
|
| */
|
| core.String name;
|
| /**
|
| - * The owner of this Organization. The owner should be specified on creation.
|
| - * Once set, it cannot be changed. This field is required.
|
| + * The owner of this Organization. The owner should be specified on
|
| + * creation. Once set, it cannot be changed.
|
| + * This field is required.
|
| */
|
| OrganizationOwner owner;
|
|
|
| @@ -1200,33 +1412,54 @@ class OrganizationOwner {
|
| }
|
|
|
| /**
|
| - * 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.
|
| */
|
| @@ -1271,52 +1504,90 @@ class Policy {
|
| }
|
|
|
| /**
|
| - * A Project is a high-level Google Cloud Platform entity. It is a container for
|
| - * ACLs, APIs, AppEngine Apps, VMs, and other Google Cloud Platform resources.
|
| + * A Project is a high-level Google Cloud Platform entity. It is a
|
| + * container for ACLs, APIs, AppEngine Apps, VMs, and other
|
| + * Google Cloud Platform resources.
|
| */
|
| class Project {
|
| - /** Creation time. Read-only. */
|
| + /**
|
| + * Creation time.
|
| + *
|
| + * Read-only.
|
| + */
|
| core.String createTime;
|
| /**
|
| - * The labels associated with this Project. Label keys must be between 1 and
|
| - * 63 characters long and must conform to the following regular expression:
|
| - * \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63
|
| - * characters long and must conform to the regular expression
|
| - * (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels can be
|
| - * associated with a given resource. Clients should store labels in a
|
| - * representation such as JSON that does not depend on specific characters
|
| - * being disallowed. Example: "environment" : "dev" Read-write.
|
| + * The labels associated with this Project.
|
| + *
|
| + * Label keys must be between 1 and 63 characters long and must conform
|
| + * to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
|
| + *
|
| + * Label values must be between 0 and 63 characters long and must conform
|
| + * to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
|
| + *
|
| + * No more than 256 labels can be associated with a given resource.
|
| + *
|
| + * Clients should store labels in a representation such as JSON that does not
|
| + * depend on specific characters being disallowed.
|
| + *
|
| + * Example: <code>"environment" : "dev"</code>
|
| + *
|
| + * Read-write.
|
| */
|
| core.Map<core.String, core.String> labels;
|
| /**
|
| - * The Project lifecycle state. Read-only.
|
| + * The Project lifecycle state.
|
| + *
|
| + * Read-only.
|
| * Possible string values are:
|
| - * - "LIFECYCLE_STATE_UNSPECIFIED" : A LIFECYCLE_STATE_UNSPECIFIED.
|
| - * - "ACTIVE" : A ACTIVE.
|
| - * - "DELETE_REQUESTED" : A DELETE_REQUESTED.
|
| - * - "DELETE_IN_PROGRESS" : A DELETE_IN_PROGRESS.
|
| + * - "LIFECYCLE_STATE_UNSPECIFIED" : Unspecified state. This is only
|
| + * used/useful for distinguishing
|
| + * unset values.
|
| + * - "ACTIVE" : The normal and active state.
|
| + * - "DELETE_REQUESTED" : The project has been marked for deletion by the user
|
| + * (by invoking
|
| + * DeleteProject)
|
| + * or by the system (Google Cloud Platform).
|
| + * This can generally be reversed by invoking UndeleteProject.
|
| + * - "DELETE_IN_PROGRESS" : This lifecycle state is no longer used and not
|
| + * returned by the API.
|
| */
|
| core.String lifecycleState;
|
| /**
|
| - * The user-assigned display name of the Project. It must be 4 to 30
|
| - * characters. Allowed characters are: lowercase and uppercase letters,
|
| - * numbers, hyphen, single-quote, double-quote, space, and exclamation point.
|
| - * Example: My Project Read-write.
|
| + * The user-assigned display name of the Project.
|
| + * It must be 4 to 30 characters.
|
| + * Allowed characters are: lowercase and uppercase letters, numbers,
|
| + * hyphen, single-quote, double-quote, space, and exclamation point.
|
| + *
|
| + * Example: <code>My Project</code>
|
| + *
|
| + * Read-write.
|
| */
|
| core.String name;
|
| /**
|
| - * An optional reference to a parent Resource. The only supported parent type
|
| - * is "organization". Once set, the parent cannot be modified. Read-write.
|
| + * An optional reference to a parent Resource.
|
| + *
|
| + * The only supported parent type is "organization". Once set, the parent
|
| + * cannot be modified.
|
| + *
|
| + * Read-write.
|
| */
|
| ResourceId parent;
|
| /**
|
| - * The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase
|
| - * letters, digits, or hyphens. It must start with a letter. Trailing hyphens
|
| - * are prohibited. Example: tokyo-rain-123 Read-only after creation.
|
| + * The unique, user-assigned ID of the Project.
|
| + * It must be 6 to 30 lowercase letters, digits, or hyphens.
|
| + * It must start with a letter.
|
| + * Trailing hyphens are prohibited.
|
| + *
|
| + * Example: <code>tokyo-rain-123</code>
|
| + *
|
| + * Read-only after creation.
|
| */
|
| core.String projectId;
|
| /**
|
| - * The number uniquely identifying the project. Example: 415104041262
|
| + * The number uniquely identifying the project.
|
| + *
|
| + * Example: <code>415104041262</code>
|
| + *
|
| * Read-only.
|
| */
|
| core.String projectNumber;
|
| @@ -1423,8 +1694,8 @@ class ProjectCreationStatus {
|
| /**
|
| * A container to reference an id for any resource type. A `resource` in Google
|
| * Cloud Platform is a generic term for something you (a developer) may want to
|
| - * interact with through one of our API's. Some examples are an AppEngine app, a
|
| - * Compute Engine instance, a Cloud SQL database, and so on.
|
| + * interact with through one of our API's. Some examples are an AppEngine app,
|
| + * a Compute Engine instance, a Cloud SQL database, and so on.
|
| */
|
| class ResourceId {
|
| /**
|
| @@ -1433,8 +1704,8 @@ class ResourceId {
|
| */
|
| core.String id;
|
| /**
|
| - * Required field representing the resource type this id is for. At present,
|
| - * the only valid type is "organization".
|
| + * Required field representing the resource type this id is for.
|
| + * At present, the only valid type is "organization".
|
| */
|
| core.String type;
|
|
|
| @@ -1464,24 +1735,31 @@ class ResourceId {
|
| /** The request sent to the `SearchOrganizations` method. */
|
| class SearchOrganizationsRequest {
|
| /**
|
| - * An optional query string used to filter the Organizations to return in the
|
| - * response. Filter rules are case-insensitive. Organizations may be filtered
|
| - * by `owner.directoryCustomerId` or by `domain`, where the domain is a Google
|
| - * for Work domain, for example: |Filter|Description| |------|-----------|
|
| + * An optional query string used to filter the Organizations to return in
|
| + * the response. Filter rules are case-insensitive.
|
| + *
|
| + *
|
| + * Organizations may be filtered by `owner.directoryCustomerId` or by
|
| + * `domain`, where the domain is a Google for Work domain, for example:
|
| + *
|
| + * |Filter|Description|
|
| + * |------|-----------|
|
| * |owner.directorycustomerid:123456789|Organizations with
|
| * `owner.directory_customer_id` equal to `123456789`.|
|
| * |domain:google.com|Organizations corresponding to the domain `google.com`.|
|
| + *
|
| * This field is optional.
|
| */
|
| core.String filter;
|
| /**
|
| - * The maximum number of Organizations to return in the response. This field
|
| - * is optional.
|
| + * The maximum number of Organizations to return in the response.
|
| + * This field is optional.
|
| */
|
| core.int pageSize;
|
| /**
|
| * A pagination token returned from a previous call to `SearchOrganizations`
|
| - * that indicates from where listing should continue. This field is optional.
|
| + * that indicates from where listing should continue.
|
| + * This field is optional.
|
| */
|
| core.String pageToken;
|
|
|
| @@ -1557,8 +1835,9 @@ class SearchOrganizationsResponse {
|
| 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;
|
|
|
| @@ -1581,45 +1860,66 @@ class SetIamPolicyRequest {
|
|
|
| /**
|
| * 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). The error model is designed to be: -
|
| - * Simple to use and understand for most users - Flexible enough to meet
|
| - * unexpected needs # Overview The `Status` message contains three pieces of
|
| - * data: error code, error message, and error details. The error code should be
|
| - * an enum value of google.rpc.Code, but it may accept additional error codes if
|
| - * needed. The error message should be a developer-facing English message that
|
| - * helps developers *understand* and *resolve* the error. If a localized
|
| - * user-facing error message is needed, put the localized message in the error
|
| - * details or localize it in the client. The optional error details may contain
|
| - * arbitrary information about the error. There is a predefined set of error
|
| - * detail types in the package `google.rpc` which can be used for common error
|
| - * conditions. # Language mapping The `Status` message is the logical
|
| - * representation of the error model, but it is not necessarily the actual wire
|
| - * format. When the `Status` message is exposed in different client libraries
|
| - * and different wire protocols, it can be mapped differently. For example, it
|
| - * will likely be mapped to some exceptions in Java, but more likely mapped to
|
| - * some error codes in C. # Other uses The error model and the `Status` message
|
| - * can be used in a variety of environments, either with or without APIs, to
|
| - * provide a consistent developer experience across different environments.
|
| - * Example uses of this error model include: - Partial errors. If a service
|
| - * needs to return partial errors to the client, it may embed the `Status` in
|
| - * the normal response to indicate the partial errors. - Workflow errors. A
|
| - * typical workflow has multiple steps. Each step may have a `Status` message
|
| - * for error reporting purpose. - Batch operations. If a client uses batch
|
| - * request and batch response, the `Status` message should be used directly
|
| - * inside batch response, one for each error sub-response. - Asynchronous
|
| - * operations. If an API call embeds asynchronous operation results in its
|
| - * response, the status of those operations should be represented directly using
|
| - * the `Status` message. - Logging. If some API errors are stored in logs, the
|
| - * message `Status` could be used directly after any stripping needed for
|
| - * security/privacy reasons.
|
| + * different
|
| + * programming environments, including REST APIs and RPC APIs. It is used by
|
| + * [gRPC](https://github.com/grpc). The error model is designed to be:
|
| + *
|
| + * - Simple to use and understand for most users
|
| + * - Flexible enough to meet unexpected needs
|
| + *
|
| + * # Overview
|
| + *
|
| + * The `Status` message contains three pieces of data: error code, error
|
| + * message,
|
| + * and error details. The error code should be an enum value of
|
| + * google.rpc.Code, but it may accept additional error codes if needed. The
|
| + * error message should be a developer-facing English message that helps
|
| + * developers *understand* and *resolve* the error. If a localized user-facing
|
| + * error message is needed, put the localized message in the error details or
|
| + * localize it in the client. The optional error details may contain arbitrary
|
| + * information about the error. There is a predefined set of error detail types
|
| + * in the package `google.rpc` which can be used for common error conditions.
|
| + *
|
| + * # Language mapping
|
| + *
|
| + * The `Status` message is the logical representation of the error model, but it
|
| + * is not necessarily the actual wire format. When the `Status` message is
|
| + * exposed in different client libraries and different wire protocols, it can be
|
| + * mapped differently. For example, it will likely be mapped to some exceptions
|
| + * in Java, but more likely mapped to some error codes in C.
|
| + *
|
| + * # Other uses
|
| + *
|
| + * The error model and the `Status` message can be used in a variety of
|
| + * environments, either with or without APIs, to provide a
|
| + * consistent developer experience across different environments.
|
| + *
|
| + * Example uses of this error model include:
|
| + *
|
| + * - Partial errors. If a service needs to return partial errors to the client,
|
| + * it may embed the `Status` in the normal response to indicate the partial
|
| + * errors.
|
| + *
|
| + * - Workflow errors. A typical workflow has multiple steps. Each step may
|
| + * have a `Status` message for error reporting purpose.
|
| + *
|
| + * - Batch operations. If a client uses batch request and batch response, the
|
| + * `Status` message should be used directly inside batch response, one for
|
| + * each error sub-response.
|
| + *
|
| + * - Asynchronous operations. If an API call embeds asynchronous operation
|
| + * results in its response, the status of those operations should be
|
| + * represented directly using the `Status` message.
|
| + *
|
| + * - Logging. If some API errors are stored in logs, the message `Status` could
|
| + * be used directly after any stripping needed for security/privacy reasons.
|
| */
|
| 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 will be a common set
|
| - * of message types for APIs to use.
|
| + * A list of messages that carry the error details. There will be a
|
| + * common set of message types for APIs to use.
|
| *
|
| * The values for Object must be JSON objects. It can consist of `num`,
|
| * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| @@ -1666,8 +1966,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;
|
|
|
| @@ -1713,7 +2013,10 @@ class TestIamPermissionsResponse {
|
| }
|
| }
|
|
|
| -/** The request sent to the UndeleteProject method. */
|
| +/**
|
| + * The request sent to the UndeleteProject
|
| + * method.
|
| + */
|
| class UndeleteProjectRequest {
|
|
|
| UndeleteProjectRequest();
|
|
|