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

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

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 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/clouddebugger/v2.dart ('k') | generated/googleapis/lib/cloudkms/v1.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: generated/googleapis/lib/cloudfunctions/v1.dart
diff --git a/generated/googleapis/lib/cloudfunctions/v1.dart b/generated/googleapis/lib/cloudfunctions/v1.dart
index a259bfbd8554318dd68166aa99d8fbcf3ac7b40b..2167186c4c346d5e1785d540f80715feb66fe606 100644
--- a/generated/googleapis/lib/cloudfunctions/v1.dart
+++ b/generated/googleapis/lib/cloudfunctions/v1.dart
@@ -9,54 +9,52 @@ import 'dart:convert' as convert;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
-export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
- ApiRequestError, DetailedApiRequestError;
+export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
+ show ApiRequestError, DetailedApiRequestError;
const core.String USER_AGENT = 'dart-api-client cloudfunctions/v1';
-/**
- * API for managing lightweight user-provided functions executed in response to
- * events.
- */
+/// API for managing lightweight user-provided functions executed in response
+/// to events.
class CloudfunctionsApi {
- /** View and manage your data across Google Cloud Platform services */
- static const CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform";
-
+ /// View and manage your data across Google Cloud Platform services
+ static const CloudPlatformScope =
+ "https://www.googleapis.com/auth/cloud-platform";
final commons.ApiRequester _requester;
OperationsResourceApi get operations => new OperationsResourceApi(_requester);
ProjectsResourceApi get projects => new ProjectsResourceApi(_requester);
- CloudfunctionsApi(http.Client client, {core.String rootUrl: "https://cloudfunctions.googleapis.com/", core.String servicePath: ""}) :
- _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
+ CloudfunctionsApi(http.Client client,
+ {core.String rootUrl: "https://cloudfunctions.googleapis.com/",
+ core.String servicePath: ""})
+ : _requester =
+ new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
}
-
class OperationsResourceApi {
final commons.ApiRequester _requester;
- OperationsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * 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/[^/]+$".
- *
- * Completes with a [Operation].
- *
- * 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.
- */
+ OperationsResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// 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/[^/]+$".
+ ///
+ /// Completes with a [Operation].
+ ///
+ /// 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<Operation> get(core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -71,47 +69,49 @@ class OperationsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Operation.fromJson(data));
}
- /**
- * Lists operations that match the specified filter in the request. If the
- * server doesn't support this method, it returns `UNIMPLEMENTED`.
- *
- * NOTE: the `name` binding allows API services to override the binding
- * to use different resource name schemes, such as `users / * /operations`. To
- * override the binding, API services can add a binding such as
- * `"/v1/{name=users / * }/operations"` to their service configuration.
- * For backwards compatibility, the default name includes the operations
- * collection id, however overriding users must ensure the name binding
- * is the parent resource, without the operations collection id.
- *
- * Request parameters:
- *
- * [pageToken] - The standard list page token.
- *
- * [name] - The name of the operation's parent resource.
- *
- * [pageSize] - The standard list page size.
- *
- * [filter] - The standard list filter.
- *
- * Completes with a [ListOperationsResponse].
- *
- * 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<ListOperationsResponse> list({core.String pageToken, core.String name, core.int pageSize, core.String filter}) {
+ /// Lists operations that match the specified filter in the request. If the
+ /// server doesn't support this method, it returns `UNIMPLEMENTED`.
+ ///
+ /// NOTE: the `name` binding allows API services to override the binding
+ /// to use different resource name schemes, such as `users / * /operations`.
+ /// To
+ /// override the binding, API services can add a binding such as
+ /// `"/v1/{name=users / * }/operations"` to their service configuration.
+ /// For backwards compatibility, the default name includes the operations
+ /// collection id, however overriding users must ensure the name binding
+ /// is the parent resource, without the operations collection id.
+ ///
+ /// Request parameters:
+ ///
+ /// [pageToken] - The standard list page token.
+ ///
+ /// [name] - The name of the operation's parent resource.
+ ///
+ /// [pageSize] - The standard list page size.
+ ///
+ /// [filter] - The standard list filter.
+ ///
+ /// Completes with a [ListOperationsResponse].
+ ///
+ /// 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<ListOperationsResponse> list(
+ {core.String pageToken,
+ core.String name,
+ core.int pageSize,
+ core.String filter}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -134,58 +134,53 @@ class OperationsResourceApi {
_url = 'v1/operations';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new ListOperationsResponse.fromJson(data));
}
-
}
-
class ProjectsResourceApi {
final commons.ApiRequester _requester;
- ProjectsLocationsResourceApi get locations => new ProjectsLocationsResourceApi(_requester);
+ ProjectsLocationsResourceApi get locations =>
+ new ProjectsLocationsResourceApi(_requester);
- ProjectsResourceApi(commons.ApiRequester client) :
- _requester = client;
+ ProjectsResourceApi(commons.ApiRequester client) : _requester = client;
}
-
class ProjectsLocationsResourceApi {
final commons.ApiRequester _requester;
- ProjectsLocationsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Lists information about the supported locations for this service.
- *
- * Request parameters:
- *
- * [name] - The resource that owns the locations collection, if applicable.
- * Value must have pattern "^projects/[^/]+$".
- *
- * [filter] - The standard list filter.
- *
- * [pageToken] - The standard list page token.
- *
- * [pageSize] - The standard list page size.
- *
- * Completes with a [ListLocationsResponse].
- *
- * 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<ListLocationsResponse> list(core.String name, {core.String filter, core.String pageToken, core.int pageSize}) {
+ ProjectsLocationsResourceApi(commons.ApiRequester client)
+ : _requester = client;
+
+ /// Lists information about the supported locations for this service.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - The resource that owns the locations collection, if applicable.
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// [pageToken] - The standard list page token.
+ ///
+ /// [pageSize] - The standard list page size.
+ ///
+ /// [filter] - The standard list filter.
+ ///
+ /// Completes with a [ListLocationsResponse].
+ ///
+ /// 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<ListLocationsResponse> list(core.String name,
+ {core.String pageToken, core.int pageSize, core.String filter}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -196,44 +191,44 @@ class ProjectsLocationsResourceApi {
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
- if (filter != null) {
- _queryParams["filter"] = [filter];
- }
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
+ if (filter != null) {
+ _queryParams["filter"] = [filter];
+ }
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + '/locations';
+ _url =
+ 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + '/locations';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new ListLocationsResponse.fromJson(data));
}
-
}
-
-
-/** The response message for Locations.ListLocations. */
+/// The response message for Locations.ListLocations.
class ListLocationsResponse {
- /** A list of locations that matches the specified filter in the request. */
+ /// A list of locations that matches the specified filter in the request.
core.List<Location> locations;
- /** The standard List next-page token. */
+
+ /// The standard List next-page token.
core.String nextPageToken;
ListLocationsResponse();
ListLocationsResponse.fromJson(core.Map _json) {
if (_json.containsKey("locations")) {
- locations = _json["locations"].map((value) => new Location.fromJson(value)).toList();
+ locations = _json["locations"]
+ .map((value) => new Location.fromJson(value))
+ .toList();
}
if (_json.containsKey("nextPageToken")) {
nextPageToken = _json["nextPageToken"];
@@ -241,7 +236,8 @@ class ListLocationsResponse {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (locations != null) {
_json["locations"] = locations.map((value) => (value).toJson()).toList();
}
@@ -252,11 +248,12 @@ class ListLocationsResponse {
}
}
-/** The response message for Operations.ListOperations. */
+/// The response message for Operations.ListOperations.
class ListOperationsResponse {
- /** The standard List next-page token. */
+ /// The standard List next-page token.
core.String nextPageToken;
- /** A list of operations that matches the specified filter in the request. */
+
+ /// A list of operations that matches the specified filter in the request.
core.List<Operation> operations;
ListOperationsResponse();
@@ -266,44 +263,46 @@ class ListOperationsResponse {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("operations")) {
- operations = _json["operations"].map((value) => new Operation.fromJson(value)).toList();
+ operations = _json["operations"]
+ .map((value) => new Operation.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
if (operations != null) {
- _json["operations"] = operations.map((value) => (value).toJson()).toList();
+ _json["operations"] =
+ operations.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/** A resource that represents Google Cloud Platform location. */
+/// A resource that represents Google Cloud Platform location.
class Location {
- /**
- * Cross-service attributes for the location. For example
- *
- * {"cloud.googleapis.com/region": "us-east1"}
- */
+ /// Cross-service attributes for the location. For example
+ ///
+ /// {"cloud.googleapis.com/region": "us-east1"}
core.Map<core.String, core.String> labels;
- /** The canonical id for this location. For example: `"us-east1"`. */
+
+ /// The canonical id for this location. For example: `"us-east1"`.
core.String locationId;
- /**
- * Service-specific metadata. For example the available capacity at the given
- * location.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// Service-specific metadata. For example the available capacity at the
+ /// given
+ /// location.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> metadata;
- /**
- * Resource name for the location, which may vary between implementations.
- * For example: `"projects/example-project/locations/us-east1"`
- */
+
+ /// Resource name for the location, which may vary between implementations.
+ /// For example: `"projects/example-project/locations/us-east1"`
core.String name;
Location();
@@ -324,7 +323,8 @@ class Location {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (labels != null) {
_json["labels"] = labels;
}
@@ -341,48 +341,44 @@ class Location {
}
}
-/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
- */
+/// This resource represents a long-running operation that is the result of a
+/// network API call.
class Operation {
- /**
- * If the value is `false`, it means the operation is still in progress.
- * If true, the operation is completed, and either `error` or `response` is
- * available.
- */
+ /// If the value is `false`, it means the operation is still in progress.
+ /// If `true`, the operation is completed, and either `error` or `response`
+ /// is
+ /// available.
core.bool done;
- /** The error result of the operation in case of failure or cancellation. */
+
+ /// 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
- * long-running operation should document the metadata type, if any.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// 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`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
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`.
- */
+
+ /// 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`.
core.String name;
- /**
- * 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`.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// 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`.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> response;
Operation();
@@ -406,7 +402,8 @@ class Operation {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (done != null) {
_json["done"] = done;
}
@@ -426,28 +423,24 @@ class Operation {
}
}
-/** Metadata describing an Operation */
+/// Metadata describing an Operation
class OperationMetadataV1Beta2 {
- /**
- * The original request that started the operation.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+ /// The original request that started the operation.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> request;
- /**
- * Target of the operation - for example
- * projects/project-1/locations/region-1/functions/function-1
- */
+
+ /// Target of the operation - for example
+ /// projects/project-1/locations/region-1/functions/function-1
core.String target;
- /**
- * Type of operation.
- * Possible string values are:
- * - "OPERATION_UNSPECIFIED" : Unknown operation type.
- * - "CREATE_FUNCTION" : Triggered by CreateFunction call
- * - "UPDATE_FUNCTION" : Triggered by UpdateFunction call
- * - "DELETE_FUNCTION" : Triggered by DeleteFunction call.
- */
+
+ /// Type of operation.
+ /// Possible string values are:
+ /// - "OPERATION_UNSPECIFIED" : Unknown operation type.
+ /// - "CREATE_FUNCTION" : Triggered by CreateFunction call
+ /// - "UPDATE_FUNCTION" : Triggered by UpdateFunction call
+ /// - "DELETE_FUNCTION" : Triggered by DeleteFunction call.
core.String type;
OperationMetadataV1Beta2();
@@ -465,7 +458,8 @@ class OperationMetadataV1Beta2 {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (request != null) {
_json["request"] = request;
}
@@ -479,78 +473,81 @@ class OperationMetadataV1Beta2 {
}
}
-/**
- * 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` that 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.
- *
- * - 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.
- */
+/// 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` that 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.
+///
+/// - 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. */
+ /// The status code, which should be an enum value of google.rpc.Code.
core.int code;
- /**
- * A list of messages that carry the error details. There is a common set of
- * 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.
- */
+
+ /// A list of messages that carry the error details. There is a common set
+ /// of
+ /// message types for APIs to use.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.List<core.Map<core.String, core.Object>> details;
- /**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
- */
+
+ /// A developer-facing error message, which should be in English. Any
+ /// user-facing error message should be localized and sent in the
+ /// google.rpc.Status.details field, or localized by the client.
core.String message;
Status();
@@ -568,7 +565,8 @@ class Status {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (code != null) {
_json["code"] = code;
}
« no previous file with comments | « generated/googleapis/lib/clouddebugger/v2.dart ('k') | generated/googleapis/lib/cloudkms/v1.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698