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

Unified Diff: generated/googleapis/lib/cloudbuild/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/cloudbilling/v1.dart ('k') | generated/googleapis/lib/clouddebugger/v2.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: generated/googleapis/lib/cloudbuild/v1.dart
diff --git a/generated/googleapis/lib/cloudbuild/v1.dart b/generated/googleapis/lib/cloudbuild/v1.dart
index ada1703c7d3e31a31d1ed8ee2f51dd790a1fae8d..88705b60099feff07656b9ee64c1fd258ea2a150 100644
--- a/generated/googleapis/lib/cloudbuild/v1.dart
+++ b/generated/googleapis/lib/cloudbuild/v1.dart
@@ -9,60 +9,59 @@ 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 cloudbuild/v1';
-/** Builds container images in the cloud. */
+/// Builds container images in the cloud.
class CloudbuildApi {
- /** 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);
- CloudbuildApi(http.Client client, {core.String rootUrl: "https://cloudbuild.googleapis.com/", core.String servicePath: ""}) :
- _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
+ CloudbuildApi(http.Client client,
+ {core.String rootUrl: "https://cloudbuild.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;
-
- /**
- * Starts asynchronous cancellation on a long-running operation. The server
- * makes a best effort to cancel the operation, but success is not
- * guaranteed. If the server doesn't support this method, it returns
- * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
- * Operations.GetOperation or
- * other methods to check whether the cancellation succeeded or whether the
- * operation completed despite cancellation. On successful cancellation,
- * the operation is not deleted; instead, it becomes an operation with
- * an Operation.error value with a google.rpc.Status.code of 1,
- * corresponding to `Code.CANCELLED`.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [name] - The name of the operation resource to be cancelled.
- * Value must have pattern "^operations/.+$".
- *
- * Completes with a [Empty].
- *
- * 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;
+
+ /// Starts asynchronous cancellation on a long-running operation. The server
+ /// makes a best effort to cancel the operation, but success is not
+ /// guaranteed. If the server doesn't support this method, it returns
+ /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use
+ /// Operations.GetOperation or
+ /// other methods to check whether the cancellation succeeded or whether the
+ /// operation completed despite cancellation. On successful cancellation,
+ /// the operation is not deleted; instead, it becomes an operation with
+ /// an Operation.error value with a google.rpc.Status.code of 1,
+ /// corresponding to `Code.CANCELLED`.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - The name of the operation resource to be cancelled.
+ /// Value must have pattern "^operations/.+$".
+ ///
+ /// Completes with a [Empty].
+ ///
+ /// 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<Empty> cancel(CancelOperationRequest request, core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -80,34 +79,32 @@ class OperationsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':cancel';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Empty.fromJson(data));
}
- /**
- * 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.
- */
+ /// 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();
@@ -122,48 +119,47 @@ 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:
- *
- * [name] - The name of the operation's parent resource.
- * Value must have pattern "^operations$".
- *
- * [filter] - The standard list filter.
- *
- * [pageToken] - The standard list page token.
- *
- * [pageSize] - The standard list page size.
- *
- * 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 name, {core.String filter, core.String pageToken, core.int pageSize}) {
+ /// 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:
+ ///
+ /// [name] - The name of the operation's parent resource.
+ /// Value must have pattern "^operations$".
+ ///
+ /// [pageToken] - The standard list page token.
+ ///
+ /// [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 name,
+ {core.String pageToken, core.int pageSize, core.String filter}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -174,68 +170,63 @@ class OperationsResourceApi {
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');
- 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;
- ProjectsBuildsResourceApi get builds => new ProjectsBuildsResourceApi(_requester);
- ProjectsTriggersResourceApi get triggers => new ProjectsTriggersResourceApi(_requester);
+ ProjectsBuildsResourceApi get builds =>
+ new ProjectsBuildsResourceApi(_requester);
+ ProjectsTriggersResourceApi get triggers =>
+ new ProjectsTriggersResourceApi(_requester);
- ProjectsResourceApi(commons.ApiRequester client) :
- _requester = client;
+ ProjectsResourceApi(commons.ApiRequester client) : _requester = client;
}
-
class ProjectsBuildsResourceApi {
final commons.ApiRequester _requester;
- ProjectsBuildsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Cancels a requested build in progress.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [projectId] - ID of the project.
- *
- * [id] - ID of the build.
- *
- * Completes with a [Build].
- *
- * 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<Build> cancel(CancelBuildRequest request, core.String projectId, core.String id) {
+ ProjectsBuildsResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Cancels a requested build in progress.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [projectId] - ID of the project.
+ ///
+ /// [id] - ID of the build.
+ ///
+ /// Completes with a [Build].
+ ///
+ /// 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<Build> cancel(
+ CancelBuildRequest request, core.String projectId, core.String id) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -253,39 +244,40 @@ class ProjectsBuildsResourceApi {
throw new core.ArgumentError("Parameter id is required.");
}
- _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + '/builds/' + commons.Escaper.ecapeVariable('$id') + ':cancel';
+ _url = 'v1/projects/' +
+ commons.Escaper.ecapeVariable('$projectId') +
+ '/builds/' +
+ commons.Escaper.ecapeVariable('$id') +
+ ':cancel';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Build.fromJson(data));
}
- /**
- * Starts a build with the specified configuration.
- *
- * The long-running Operation returned by this method will include the ID of
- * the build, which can be passed to GetBuild to determine its status (e.g.,
- * success or failure).
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [projectId] - ID of the project.
- *
- * 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.
- */
+ /// Starts a build with the specified configuration.
+ ///
+ /// The long-running Operation returned by this method will include the ID of
+ /// the build, which can be passed to GetBuild to determine its status (e.g.,
+ /// success or failure).
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [projectId] - ID of the project.
+ ///
+ /// 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> create(Build request, core.String projectId) {
var _url = null;
var _queryParams = new core.Map();
@@ -301,38 +293,37 @@ class ProjectsBuildsResourceApi {
throw new core.ArgumentError("Parameter projectId is required.");
}
- _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + '/builds';
+ _url = 'v1/projects/' +
+ commons.Escaper.ecapeVariable('$projectId') +
+ '/builds';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Operation.fromJson(data));
}
- /**
- * Returns information about a previously requested build.
- *
- * The Build that is returned includes its status (e.g., success or failure,
- * or in-progress), and timing information.
- *
- * Request parameters:
- *
- * [projectId] - ID of the project.
- *
- * [id] - ID of the build.
- *
- * Completes with a [Build].
- *
- * 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.
- */
+ /// Returns information about a previously requested build.
+ ///
+ /// The Build that is returned includes its status (e.g., success or failure,
+ /// or in-progress), and timing information.
+ ///
+ /// Request parameters:
+ ///
+ /// [projectId] - ID of the project.
+ ///
+ /// [id] - ID of the build.
+ ///
+ /// Completes with a [Build].
+ ///
+ /// 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<Build> get(core.String projectId, core.String id) {
var _url = null;
var _queryParams = new core.Map();
@@ -348,43 +339,45 @@ class ProjectsBuildsResourceApi {
throw new core.ArgumentError("Parameter id is required.");
}
- _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + '/builds/' + commons.Escaper.ecapeVariable('$id');
+ _url = 'v1/projects/' +
+ commons.Escaper.ecapeVariable('$projectId') +
+ '/builds/' +
+ commons.Escaper.ecapeVariable('$id');
- 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 Build.fromJson(data));
}
- /**
- * Lists previously requested builds.
- *
- * Previously requested builds may still be in-progress, or may have finished
- * successfully or unsuccessfully.
- *
- * Request parameters:
- *
- * [projectId] - ID of the project.
- *
- * [pageToken] - Token to provide to skip to a particular spot in the list.
- *
- * [pageSize] - Number of results to return in the list.
- *
- * [filter] - The raw filter text to constrain the results.
- *
- * Completes with a [ListBuildsResponse].
- *
- * 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<ListBuildsResponse> list(core.String projectId, {core.String pageToken, core.int pageSize, core.String filter}) {
+ /// Lists previously requested builds.
+ ///
+ /// Previously requested builds may still be in-progress, or may have
+ /// finished
+ /// successfully or unsuccessfully.
+ ///
+ /// Request parameters:
+ ///
+ /// [projectId] - ID of the project.
+ ///
+ /// [pageToken] - Token to provide to skip to a particular spot in the list.
+ ///
+ /// [pageSize] - Number of results to return in the list.
+ ///
+ /// [filter] - The raw filter text to constrain the results.
+ ///
+ /// Completes with a [ListBuildsResponse].
+ ///
+ /// 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<ListBuildsResponse> list(core.String projectId,
+ {core.String pageToken, core.int pageSize, core.String filter}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -405,47 +398,45 @@ class ProjectsBuildsResourceApi {
_queryParams["filter"] = [filter];
}
- _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + '/builds';
+ _url = 'v1/projects/' +
+ commons.Escaper.ecapeVariable('$projectId') +
+ '/builds';
- 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 ListBuildsResponse.fromJson(data));
}
-
}
-
class ProjectsTriggersResourceApi {
final commons.ApiRequester _requester;
- ProjectsTriggersResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Creates a new BuildTrigger.
- *
- * This API is experimental.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [projectId] - ID of the project for which to configure automatic builds.
- *
- * Completes with a [BuildTrigger].
- *
- * 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<BuildTrigger> create(BuildTrigger request, core.String projectId) {
+ ProjectsTriggersResourceApi(commons.ApiRequester client)
+ : _requester = client;
+
+ /// Creates a new BuildTrigger.
+ ///
+ /// This API is experimental.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [projectId] - ID of the project for which to configure automatic builds.
+ ///
+ /// Completes with a [BuildTrigger].
+ ///
+ /// 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<BuildTrigger> create(
+ BuildTrigger request, core.String projectId) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -460,37 +451,36 @@ class ProjectsTriggersResourceApi {
throw new core.ArgumentError("Parameter projectId is required.");
}
- _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + '/triggers';
+ _url = 'v1/projects/' +
+ commons.Escaper.ecapeVariable('$projectId') +
+ '/triggers';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new BuildTrigger.fromJson(data));
}
- /**
- * Deletes an BuildTrigger by its project ID and trigger ID.
- *
- * This API is experimental.
- *
- * Request parameters:
- *
- * [projectId] - ID of the project that owns the trigger.
- *
- * [triggerId] - ID of the BuildTrigger to delete.
- *
- * Completes with a [Empty].
- *
- * 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.
- */
+ /// Deletes an BuildTrigger by its project ID and trigger ID.
+ ///
+ /// This API is experimental.
+ ///
+ /// Request parameters:
+ ///
+ /// [projectId] - ID of the project that owns the trigger.
+ ///
+ /// [triggerId] - ID of the BuildTrigger to delete.
+ ///
+ /// Completes with a [Empty].
+ ///
+ /// 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<Empty> delete(core.String projectId, core.String triggerId) {
var _url = null;
var _queryParams = new core.Map();
@@ -506,37 +496,37 @@ class ProjectsTriggersResourceApi {
throw new core.ArgumentError("Parameter triggerId is required.");
}
- _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + '/triggers/' + commons.Escaper.ecapeVariable('$triggerId');
+ _url = 'v1/projects/' +
+ commons.Escaper.ecapeVariable('$projectId') +
+ '/triggers/' +
+ commons.Escaper.ecapeVariable('$triggerId');
- var _response = _requester.request(_url,
- "DELETE",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "DELETE",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Empty.fromJson(data));
}
- /**
- * Gets information about a BuildTrigger.
- *
- * This API is experimental.
- *
- * Request parameters:
- *
- * [projectId] - ID of the project that owns the trigger.
- *
- * [triggerId] - ID of the BuildTrigger to get.
- *
- * Completes with a [BuildTrigger].
- *
- * 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.
- */
+ /// Gets information about a BuildTrigger.
+ ///
+ /// This API is experimental.
+ ///
+ /// Request parameters:
+ ///
+ /// [projectId] - ID of the project that owns the trigger.
+ ///
+ /// [triggerId] - ID of the BuildTrigger to get.
+ ///
+ /// Completes with a [BuildTrigger].
+ ///
+ /// 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<BuildTrigger> get(core.String projectId, core.String triggerId) {
var _url = null;
var _queryParams = new core.Map();
@@ -552,35 +542,35 @@ class ProjectsTriggersResourceApi {
throw new core.ArgumentError("Parameter triggerId is required.");
}
- _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + '/triggers/' + commons.Escaper.ecapeVariable('$triggerId');
+ _url = 'v1/projects/' +
+ commons.Escaper.ecapeVariable('$projectId') +
+ '/triggers/' +
+ commons.Escaper.ecapeVariable('$triggerId');
- 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 BuildTrigger.fromJson(data));
}
- /**
- * Lists existing BuildTrigger.
- *
- * This API is experimental.
- *
- * Request parameters:
- *
- * [projectId] - ID of the project for which to list BuildTriggers.
- *
- * Completes with a [ListBuildTriggersResponse].
- *
- * 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.
- */
+ /// Lists existing BuildTrigger.
+ ///
+ /// This API is experimental.
+ ///
+ /// Request parameters:
+ ///
+ /// [projectId] - ID of the project for which to list BuildTriggers.
+ ///
+ /// Completes with a [ListBuildTriggersResponse].
+ ///
+ /// 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<ListBuildTriggersResponse> list(core.String projectId) {
var _url = null;
var _queryParams = new core.Map();
@@ -593,40 +583,41 @@ class ProjectsTriggersResourceApi {
throw new core.ArgumentError("Parameter projectId is required.");
}
- _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + '/triggers';
+ _url = 'v1/projects/' +
+ commons.Escaper.ecapeVariable('$projectId') +
+ '/triggers';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
- return _response.then((data) => new ListBuildTriggersResponse.fromJson(data));
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response
+ .then((data) => new ListBuildTriggersResponse.fromJson(data));
}
- /**
- * Updates an BuildTrigger by its project ID and trigger ID.
- *
- * This API is experimental.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [projectId] - ID of the project that owns the trigger.
- *
- * [triggerId] - ID of the BuildTrigger to update.
- *
- * Completes with a [BuildTrigger].
- *
- * 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<BuildTrigger> patch(BuildTrigger request, core.String projectId, core.String triggerId) {
+ /// Updates an BuildTrigger by its project ID and trigger ID.
+ ///
+ /// This API is experimental.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [projectId] - ID of the project that owns the trigger.
+ ///
+ /// [triggerId] - ID of the BuildTrigger to update.
+ ///
+ /// Completes with a [BuildTrigger].
+ ///
+ /// 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<BuildTrigger> patch(
+ BuildTrigger request, core.String projectId, core.String triggerId) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -644,147 +635,137 @@ class ProjectsTriggersResourceApi {
throw new core.ArgumentError("Parameter triggerId is required.");
}
- _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + '/triggers/' + commons.Escaper.ecapeVariable('$triggerId');
+ _url = 'v1/projects/' +
+ commons.Escaper.ecapeVariable('$projectId') +
+ '/triggers/' +
+ commons.Escaper.ecapeVariable('$triggerId');
- var _response = _requester.request(_url,
- "PATCH",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "PATCH",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new BuildTrigger.fromJson(data));
}
-
}
-
-
-/**
- * A build resource in the Container Builder API.
- *
- * At a high level, a Build describes where to find source code, how to build
- * it (for example, the builder image to run on the source), and what tag to
- * apply to the built image when it is pushed to Google Container Registry.
- *
- * Fields can include the following variables which will be expanded when the
- * build is created:
- *
- * - $PROJECT_ID: the project ID of the build.
- * - $BUILD_ID: the autogenerated ID of the build.
- * - $REPO_NAME: the source repository name specified by RepoSource.
- * - $BRANCH_NAME: the branch name specified by RepoSource.
- * - $TAG_NAME: the tag name specified by RepoSource.
- * - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
- * resolved from the specified branch or tag.
- */
+/// A build resource in the Container Builder API.
+///
+/// At a high level, a Build describes where to find source code, how to build
+/// it (for example, the builder image to run on the source), and what tag to
+/// apply to the built image when it is pushed to Google Container Registry.
+///
+/// Fields can include the following variables which will be expanded when the
+/// build is created:
+///
+/// - $PROJECT_ID: the project ID of the build.
+/// - $BUILD_ID: the autogenerated ID of the build.
+/// - $REPO_NAME: the source repository name specified by RepoSource.
+/// - $BRANCH_NAME: the branch name specified by RepoSource.
+/// - $TAG_NAME: the tag name specified by RepoSource.
+/// - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
+/// resolved from the specified branch or tag.
class Build {
- /**
- * The ID of the BuildTrigger that triggered this build, if it was
- * triggered automatically.
- * @OutputOnly
- */
+ /// The ID of the BuildTrigger that triggered this build, if it was
+ /// triggered automatically.
+ /// @OutputOnly
core.String buildTriggerId;
- /**
- * Time at which the request to create the build was received.
- * @OutputOnly
- */
+
+ /// Time at which the request to create the build was received.
+ /// @OutputOnly
core.String createTime;
- /**
- * Time at which execution of the build was finished.
- *
- * The difference between finish_time and start_time is the duration of the
- * build's execution.
- * @OutputOnly
- */
+
+ /// Time at which execution of the build was finished.
+ ///
+ /// The difference between finish_time and start_time is the duration of the
+ /// build's execution.
+ /// @OutputOnly
core.String finishTime;
- /**
- * Unique identifier of the build.
- * @OutputOnly
- */
+
+ /// Unique identifier of the build.
+ /// @OutputOnly
core.String id;
- /**
- * A list of images to be pushed upon the successful completion of all build
- * steps.
- *
- * The images will be pushed using the builder service account's credentials.
- *
- * The digests of the pushed images will be stored in the Build resource's
- * results field.
- *
- * If any of the images fail to be pushed, the build is marked FAILURE.
- */
+
+ /// A list of images to be pushed upon the successful completion of all build
+ /// steps.
+ ///
+ /// The images will be pushed using the builder service account's
+ /// credentials.
+ ///
+ /// The digests of the pushed images will be stored in the Build resource's
+ /// results field.
+ ///
+ /// If any of the images fail to be pushed, the build is marked FAILURE.
core.List<core.String> images;
- /**
- * URL to logs for this build in Google Cloud Logging.
- * @OutputOnly
- */
+
+ /// URL to logs for this build in Google Cloud Logging.
+ /// @OutputOnly
core.String logUrl;
- /**
- * Google Cloud Storage bucket where logs should be written (see
- * [Bucket Name
- * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
- * Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.
- */
+
+ /// Google Cloud Storage bucket where logs should be written (see
+ /// [Bucket Name
+ /// Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ /// Logs file names will be of the format
+ /// `${logs_bucket}/log-${build_id}.txt`.
core.String logsBucket;
- /** Special options for this build. */
+
+ /// Special options for this build.
BuildOptions options;
- /**
- * ID of the project.
- * @OutputOnly.
- */
+
+ /// ID of the project.
+ /// @OutputOnly.
core.String projectId;
- /**
- * Results of the build.
- * @OutputOnly
- */
+
+ /// Results of the build.
+ /// @OutputOnly
Results results;
- /** Secrets to decrypt using Cloud KMS. */
+
+ /// Secrets to decrypt using Cloud KMS.
core.List<Secret> secrets;
- /** Describes where to find the source files to build. */
+
+ /// Describes where to find the source files to build.
Source source;
- /**
- * A permanent fixed identifier for source.
- * @OutputOnly
- */
+
+ /// A permanent fixed identifier for source.
+ /// @OutputOnly
SourceProvenance sourceProvenance;
- /**
- * Time at which execution of the build was started.
- * @OutputOnly
- */
+
+ /// Time at which execution of the build was started.
+ /// @OutputOnly
core.String startTime;
- /**
- * Status of the build.
- * @OutputOnly
- * Possible string values are:
- * - "STATUS_UNKNOWN" : Status of the build is unknown.
- * - "QUEUED" : Build is queued; work has not yet begun.
- * - "WORKING" : Build is being executed.
- * - "SUCCESS" : Build finished successfully.
- * - "FAILURE" : Build failed to complete successfully.
- * - "INTERNAL_ERROR" : Build failed due to an internal cause.
- * - "TIMEOUT" : Build took longer than was allowed.
- * - "CANCELLED" : Build was canceled by a user.
- */
+
+ /// Status of the build.
+ /// @OutputOnly
+ /// Possible string values are:
+ /// - "STATUS_UNKNOWN" : Status of the build is unknown.
+ /// - "QUEUED" : Build is queued; work has not yet begun.
+ /// - "WORKING" : Build is being executed.
+ /// - "SUCCESS" : Build finished successfully.
+ /// - "FAILURE" : Build failed to complete successfully.
+ /// - "INTERNAL_ERROR" : Build failed due to an internal cause.
+ /// - "TIMEOUT" : Build took longer than was allowed.
+ /// - "CANCELLED" : Build was canceled by a user.
core.String status;
- /**
- * Customer-readable message about the current status.
- * @OutputOnly
- */
+
+ /// Customer-readable message about the current status.
+ /// @OutputOnly
core.String statusDetail;
- /** Describes the operations to be performed on the workspace. */
+
+ /// Describes the operations to be performed on the workspace.
core.List<BuildStep> steps;
- /** Substitutions data for Build resource. */
+
+ /// Substitutions data for Build resource.
core.Map<core.String, core.String> substitutions;
- /** Tags for annotation of a Build. These are not docker tags. */
+
+ /// Tags for annotation of a Build. These are not docker tags.
core.List<core.String> tags;
- /**
- * Amount of time that this build should be allowed to run, to second
- * granularity. If this amount of time elapses, work on the build will cease
- * and the build status will be TIMEOUT.
- *
- * Default time is ten minutes.
- */
+
+ /// Amount of time that this build should be allowed to run, to second
+ /// granularity. If this amount of time elapses, work on the build will cease
+ /// and the build status will be TIMEOUT.
+ ///
+ /// Default time is ten minutes.
core.String timeout;
Build();
@@ -821,13 +802,15 @@ class Build {
results = new Results.fromJson(_json["results"]);
}
if (_json.containsKey("secrets")) {
- secrets = _json["secrets"].map((value) => new Secret.fromJson(value)).toList();
+ secrets =
+ _json["secrets"].map((value) => new Secret.fromJson(value)).toList();
}
if (_json.containsKey("source")) {
source = new Source.fromJson(_json["source"]);
}
if (_json.containsKey("sourceProvenance")) {
- sourceProvenance = new SourceProvenance.fromJson(_json["sourceProvenance"]);
+ sourceProvenance =
+ new SourceProvenance.fromJson(_json["sourceProvenance"]);
}
if (_json.containsKey("startTime")) {
startTime = _json["startTime"];
@@ -839,7 +822,8 @@ class Build {
statusDetail = _json["statusDetail"];
}
if (_json.containsKey("steps")) {
- steps = _json["steps"].map((value) => new BuildStep.fromJson(value)).toList();
+ steps =
+ _json["steps"].map((value) => new BuildStep.fromJson(value)).toList();
}
if (_json.containsKey("substitutions")) {
substitutions = _json["substitutions"];
@@ -853,7 +837,8 @@ class Build {
}
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 (buildTriggerId != null) {
_json["buildTriggerId"] = buildTriggerId;
}
@@ -918,9 +903,9 @@ class Build {
}
}
-/** Metadata for build operations. */
+/// Metadata for build operations.
class BuildOperationMetadata {
- /** The build that the operation is tracking. */
+ /// The build that the operation is tracking.
Build build;
BuildOperationMetadata();
@@ -932,7 +917,8 @@ class BuildOperationMetadata {
}
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 (build != null) {
_json["build"] = (build).toJson();
}
@@ -940,25 +926,23 @@ class BuildOperationMetadata {
}
}
-/** Optional arguments to enable specific features of builds. */
+/// Optional arguments to enable specific features of builds.
class BuildOptions {
- /**
- * Requested verifiability options.
- * Possible string values are:
- * - "NOT_VERIFIED" : Not a verifiable build. (default)
- * - "VERIFIED" : Verified build.
- */
+ /// Requested verifiability options.
+ /// Possible string values are:
+ /// - "NOT_VERIFIED" : Not a verifiable build. (default)
+ /// - "VERIFIED" : Verified build.
core.String requestedVerifyOption;
- /** Requested hash for SourceProvenance. */
+
+ /// Requested hash for SourceProvenance.
core.List<core.String> sourceProvenanceHash;
- /**
- * SubstitutionOption to allow unmatch substitutions.
- * Possible string values are:
- * - "MUST_MATCH" : Fails the build if error in substitutions checks, like
- * missing
- * a substitution in the template or in the map.
- * - "ALLOW_LOOSE" : Do not fail the build if error in substitutions checks.
- */
+
+ /// SubstitutionOption to allow unmatch substitutions.
+ /// Possible string values are:
+ /// - "MUST_MATCH" : Fails the build if error in substitutions checks, like
+ /// missing
+ /// a substitution in the template or in the map.
+ /// - "ALLOW_LOOSE" : Do not fail the build if error in substitutions checks.
core.String substitutionOption;
BuildOptions();
@@ -976,7 +960,8 @@ class BuildOptions {
}
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 (requestedVerifyOption != null) {
_json["requestedVerifyOption"] = requestedVerifyOption;
}
@@ -990,81 +975,79 @@ class BuildOptions {
}
}
-/** BuildStep describes a step to perform in the build pipeline. */
+/// BuildStep describes a step to perform in the build pipeline.
class BuildStep {
- /**
- * A list of arguments that will be presented to the step when it is started.
- *
- * If the image used to run the step's container has an entrypoint, these args
- * will be used as arguments to that entrypoint. If the image does not define
- * an entrypoint, the first element in args will be used as the entrypoint,
- * and the remainder will be used as arguments.
- */
+ /// A list of arguments that will be presented to the step when it is
+ /// started.
+ ///
+ /// If the image used to run the step's container has an entrypoint, these
+ /// args
+ /// will be used as arguments to that entrypoint. If the image does not
+ /// define
+ /// an entrypoint, the first element in args will be used as the entrypoint,
+ /// and the remainder will be used as arguments.
core.List<core.String> args;
- /**
- * Working directory (relative to project source root) to use when running
- * this operation's container.
- */
+
+ /// Working directory (relative to project source root) to use when running
+ /// this operation's container.
core.String dir;
- /**
- * Optional entrypoint to be used instead of the build step image's default
- * If unset, the image's default will be used.
- */
+
+ /// Optional entrypoint to be used instead of the build step image's default
+ /// If unset, the image's default will be used.
core.String entrypoint;
- /**
- * A list of environment variable definitions to be used when running a step.
- *
- * The elements are of the form "KEY=VALUE" for the environment variable "KEY"
- * being given the value "VALUE".
- */
+
+ /// A list of environment variable definitions to be used when running a
+ /// step.
+ ///
+ /// The elements are of the form "KEY=VALUE" for the environment variable
+ /// "KEY"
+ /// being given the value "VALUE".
core.List<core.String> env;
- /**
- * Optional unique identifier for this build step, used in wait_for to
- * reference this build step as a dependency.
- */
+
+ /// Optional unique identifier for this build step, used in wait_for to
+ /// reference this build step as a dependency.
core.String id;
- /**
- * The name of the container image that will run this particular build step.
- *
- * If the image is already available in the host's Docker daemon's cache, it
- * will be run directly. If not, the host will attempt to pull the image
- * first, using the builder service account's credentials if necessary.
- *
- * The Docker daemon's cache will already have the latest versions of all of
- * the officially supported build steps
- * ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
- * The Docker daemon will also have cached many of the layers for some popular
- * images, like "ubuntu", "debian", but they will be refreshed at the time you
- * attempt to use them.
- *
- * If you built an image in a previous build step, it will be stored in the
- * host's Docker daemon's cache and is available to use as the name for a
- * later build step.
- */
+
+ /// The name of the container image that will run this particular build step.
+ ///
+ /// If the image is already available in the host's Docker daemon's cache, it
+ /// will be run directly. If not, the host will attempt to pull the image
+ /// first, using the builder service account's credentials if necessary.
+ ///
+ /// The Docker daemon's cache will already have the latest versions of all of
+ /// the officially supported build steps
+ /// ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
+ /// The Docker daemon will also have cached many of the layers for some
+ /// popular
+ /// images, like "ubuntu", "debian", but they will be refreshed at the time
+ /// you
+ /// attempt to use them.
+ ///
+ /// If you built an image in a previous build step, it will be stored in the
+ /// host's Docker daemon's cache and is available to use as the name for a
+ /// later build step.
core.String name;
- /**
- * A list of environment variables which are encrypted using a Cloud KMS
- * crypto key. These values must be specified in the build's secrets.
- */
+
+ /// A list of environment variables which are encrypted using a Cloud KMS
+ /// crypto key. These values must be specified in the build's secrets.
core.List<core.String> secretEnv;
- /**
- * List of volumes to mount into the build step.
- *
- * Each volume will be created as an empty volume prior to execution of the
- * build step. Upon completion of the build, volumes and their contents will
- * be discarded.
- *
- * Using a named volume in only one step is not valid as it is indicative
- * of a mis-configured build request.
- */
+
+ /// List of volumes to mount into the build step.
+ ///
+ /// Each volume will be created as an empty volume prior to execution of the
+ /// build step. Upon completion of the build, volumes and their contents will
+ /// be discarded.
+ ///
+ /// Using a named volume in only one step is not valid as it is indicative
+ /// of a mis-configured build request.
core.List<Volume> volumes;
- /**
- * The ID(s) of the step(s) that this build step depends on.
- * This build step will not start until all the build steps in wait_for
- * have completed successfully. If wait_for is empty, this build step will
- * start when all previous build steps in the Build.Steps list have completed
- * successfully.
- */
+
+ /// The ID(s) of the step(s) that this build step depends on.
+ /// This build step will not start until all the build steps in wait_for
+ /// have completed successfully. If wait_for is empty, this build step will
+ /// start when all previous build steps in the Build.Steps list have
+ /// completed
+ /// successfully.
core.List<core.String> waitFor;
BuildStep();
@@ -1092,7 +1075,8 @@ class BuildStep {
secretEnv = _json["secretEnv"];
}
if (_json.containsKey("volumes")) {
- volumes = _json["volumes"].map((value) => new Volume.fromJson(value)).toList();
+ volumes =
+ _json["volumes"].map((value) => new Volume.fromJson(value)).toList();
}
if (_json.containsKey("waitFor")) {
waitFor = _json["waitFor"];
@@ -1100,7 +1084,8 @@ class BuildStep {
}
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 (args != null) {
_json["args"] = args;
}
@@ -1132,43 +1117,41 @@ class BuildStep {
}
}
-/**
- * Configuration for an automated build in response to source repository
- * changes.
- */
+/// Configuration for an automated build in response to source repository
+/// changes.
class BuildTrigger {
- /** Contents of the build template. */
+ /// Contents of the build template.
Build build;
- /**
- * Time when the trigger was created.
- *
- * @OutputOnly
- */
+
+ /// Time when the trigger was created.
+ ///
+ /// @OutputOnly
core.String createTime;
- /** Human-readable description of this trigger. */
+
+ /// Human-readable description of this trigger.
core.String description;
- /** If true, the trigger will never result in a build. */
+
+ /// If true, the trigger will never result in a build.
core.bool disabled;
- /**
- * Path, from the source root, to a file whose contents is used for the
- * template.
- */
+
+ /// Path, from the source root, to a file whose contents is used for the
+ /// template.
core.String filename;
- /**
- * Unique identifier of the trigger.
- *
- * @OutputOnly
- */
+
+ /// Unique identifier of the trigger.
+ ///
+ /// @OutputOnly
core.String id;
- /** Substitutions data for Build resource. */
+
+ /// Substitutions data for Build resource.
core.Map<core.String, core.String> substitutions;
- /**
- * Template describing the types of source changes to trigger a build.
- *
- * Branch and tag names in trigger templates are interpreted as regular
- * expressions. Any branch or tag change that matches that regular expression
- * will trigger a build.
- */
+
+ /// Template describing the types of source changes to trigger a build.
+ ///
+ /// Branch and tag names in trigger templates are interpreted as regular
+ /// expressions. Any branch or tag change that matches that regular
+ /// expression
+ /// will trigger a build.
RepoSource triggerTemplate;
BuildTrigger();
@@ -1201,7 +1184,8 @@ class BuildTrigger {
}
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 (build != null) {
_json["build"] = (build).toJson();
}
@@ -1230,14 +1214,13 @@ class BuildTrigger {
}
}
-/** BuiltImage describes an image built by the pipeline. */
+/// BuiltImage describes an image built by the pipeline.
class BuiltImage {
- /** Docker Registry 2.0 digest. */
+ /// Docker Registry 2.0 digest.
core.String digest;
- /**
- * Name used to push the container image to Google Container Registry, as
- * presented to `docker push`.
- */
+
+ /// Name used to push the container image to Google Container Registry, as
+ /// presented to `docker push`.
core.String name;
BuiltImage();
@@ -1252,7 +1235,8 @@ class BuiltImage {
}
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 (digest != null) {
_json["digest"] = digest;
}
@@ -1263,76 +1247,71 @@ class BuiltImage {
}
}
-/** Request to cancel an ongoing build. */
+/// Request to cancel an ongoing build.
class CancelBuildRequest {
-
CancelBuildRequest();
- CancelBuildRequest.fromJson(core.Map _json) {
- }
+ CancelBuildRequest.fromJson(core.Map _json) {}
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>();
return _json;
}
}
-/** The request message for Operations.CancelOperation. */
+/// The request message for Operations.CancelOperation.
class CancelOperationRequest {
-
CancelOperationRequest();
- CancelOperationRequest.fromJson(core.Map _json) {
- }
+ CancelOperationRequest.fromJson(core.Map _json) {}
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>();
return _json;
}
}
-/**
- * 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 `{}`.
- */
+/// 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 `{}`.
class Empty {
-
Empty();
- Empty.fromJson(core.Map _json) {
- }
+ Empty.fromJson(core.Map _json) {}
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>();
return _json;
}
}
-/**
- * Container message for hashes of byte content of files, used in
- * SourceProvenance messages to verify integrity of source input to the build.
- */
+/// Container message for hashes of byte content of files, used in
+/// SourceProvenance messages to verify integrity of source input to the build.
class FileHashes {
- /** Collection of file hashes. */
+ /// Collection of file hashes.
core.List<Hash> fileHash;
FileHashes();
FileHashes.fromJson(core.Map _json) {
if (_json.containsKey("fileHash")) {
- fileHash = _json["fileHash"].map((value) => new Hash.fromJson(value)).toList();
+ fileHash =
+ _json["fileHash"].map((value) => new Hash.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 (fileHash != null) {
_json["fileHash"] = fileHash.map((value) => (value).toJson()).toList();
}
@@ -1340,23 +1319,23 @@ class FileHashes {
}
}
-/** Container message for hash values. */
+/// Container message for hash values.
class Hash {
- /**
- * The type of hash that was performed.
- * Possible string values are:
- * - "NONE" : No hash requested.
- * - "SHA256" : Use a sha256 hash.
- */
+ /// The type of hash that was performed.
+ /// Possible string values are:
+ /// - "NONE" : No hash requested.
+ /// - "SHA256" : Use a sha256 hash.
core.String type;
- /** The hash value. */
+
+ /// The hash value.
core.String value;
core.List<core.int> get valueAsBytes {
return convert.BASE64.decode(value);
}
void set valueAsBytes(core.List<core.int> _bytes) {
- value = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
+ value =
+ convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
Hash();
@@ -1371,7 +1350,8 @@ class Hash {
}
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 (type != null) {
_json["type"] = type;
}
@@ -1382,21 +1362,24 @@ class Hash {
}
}
-/** Response containing existing BuildTriggers. */
+/// Response containing existing BuildTriggers.
class ListBuildTriggersResponse {
- /** BuildTriggers for the project, sorted by create_time descending. */
+ /// BuildTriggers for the project, sorted by create_time descending.
core.List<BuildTrigger> triggers;
ListBuildTriggersResponse();
ListBuildTriggersResponse.fromJson(core.Map _json) {
if (_json.containsKey("triggers")) {
- triggers = _json["triggers"].map((value) => new BuildTrigger.fromJson(value)).toList();
+ triggers = _json["triggers"]
+ .map((value) => new BuildTrigger.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 (triggers != null) {
_json["triggers"] = triggers.map((value) => (value).toJson()).toList();
}
@@ -1404,18 +1387,20 @@ class ListBuildTriggersResponse {
}
}
-/** Response including listed builds. */
+/// Response including listed builds.
class ListBuildsResponse {
- /** Builds will be sorted by create_time, descending. */
+ /// Builds will be sorted by create_time, descending.
core.List<Build> builds;
- /** Token to receive the next page of results. */
+
+ /// Token to receive the next page of results.
core.String nextPageToken;
ListBuildsResponse();
ListBuildsResponse.fromJson(core.Map _json) {
if (_json.containsKey("builds")) {
- builds = _json["builds"].map((value) => new Build.fromJson(value)).toList();
+ builds =
+ _json["builds"].map((value) => new Build.fromJson(value)).toList();
}
if (_json.containsKey("nextPageToken")) {
nextPageToken = _json["nextPageToken"];
@@ -1423,7 +1408,8 @@ class ListBuildsResponse {
}
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 (builds != null) {
_json["builds"] = builds.map((value) => (value).toJson()).toList();
}
@@ -1434,11 +1420,12 @@ class ListBuildsResponse {
}
}
-/** 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();
@@ -1448,64 +1435,64 @@ 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;
}
}
-/**
- * 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();
@@ -1529,7 +1516,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;
}
@@ -1549,23 +1537,24 @@ class Operation {
}
}
-/**
- * RepoSource describes the location of the source in a Google Cloud Source
- * Repository.
- */
+/// RepoSource describes the location of the source in a Google Cloud Source
+/// Repository.
class RepoSource {
- /** Name of the branch to build. */
+ /// Name of the branch to build.
core.String branchName;
- /** Explicit commit SHA to build. */
+
+ /// Explicit commit SHA to build.
core.String commitSha;
- /**
- * ID of the project that owns the repo. If omitted, the project ID requesting
- * the build is assumed.
- */
+
+ /// ID of the project that owns the repo. If omitted, the project ID
+ /// requesting
+ /// the build is assumed.
core.String projectId;
- /** Name of the repo. If omitted, the name "default" is assumed. */
+
+ /// Name of the repo. If omitted, the name "default" is assumed.
core.String repoName;
- /** Name of the tag to build. */
+
+ /// Name of the tag to build.
core.String tagName;
RepoSource();
@@ -1589,7 +1578,8 @@ class RepoSource {
}
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 (branchName != null) {
_json["branchName"] = branchName;
}
@@ -1609,13 +1599,12 @@ class RepoSource {
}
}
-/** Results describes the artifacts created by the build pipeline. */
+/// Results describes the artifacts created by the build pipeline.
class Results {
- /**
- * List of build step digests, in order corresponding to build step indices.
- */
+ /// List of build step digests, in order corresponding to build step indices.
core.List<core.String> buildStepImages;
- /** Images that were built as a part of the build. */
+
+ /// Images that were built as a part of the build.
core.List<BuiltImage> images;
Results();
@@ -1625,12 +1614,15 @@ class Results {
buildStepImages = _json["buildStepImages"];
}
if (_json.containsKey("images")) {
- images = _json["images"].map((value) => new BuiltImage.fromJson(value)).toList();
+ images = _json["images"]
+ .map((value) => new BuiltImage.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 (buildStepImages != null) {
_json["buildStepImages"] = buildStepImages;
}
@@ -1641,21 +1633,19 @@ class Results {
}
}
-/**
- * Secret pairs a set of secret environment variables containing encrypted
- * values with the Cloud KMS key to use to decrypt the value.
- */
+/// Secret pairs a set of secret environment variables containing encrypted
+/// values with the Cloud KMS key to use to decrypt the value.
class Secret {
- /** Cloud KMS key name to use to decrypt these envs. */
+ /// Cloud KMS key name to use to decrypt these envs.
core.String kmsKeyName;
- /**
- * Map of environment variable name to its encrypted value.
- *
- * Secret environment variables must be unique across all of a build's
- * secrets, and must be used by at least one build step. Values can be at most
- * 1 KB in size. There can be at most ten secret values across all of a
- * build's secrets.
- */
+
+ /// Map of environment variable name to its encrypted value.
+ ///
+ /// Secret environment variables must be unique across all of a build's
+ /// secrets, and must be used by at least one build step. Values can be at
+ /// most
+ /// 1 KB in size. There can be at most ten secret values across all of a
+ /// build's secrets.
core.Map<core.String, core.String> secretEnv;
Secret();
@@ -1670,7 +1660,8 @@ class Secret {
}
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 (kmsKeyName != null) {
_json["kmsKeyName"] = kmsKeyName;
}
@@ -1681,17 +1672,14 @@ class Secret {
}
}
-/**
- * Source describes the location of the source in a supported storage
- * service.
- */
+/// Source describes the location of the source in a supported storage
+/// service.
class Source {
- /** If provided, get source from this location in a Cloud Repo. */
+ /// If provided, get source from this location in a Cloud Repo.
RepoSource repoSource;
- /**
- * If provided, get the source from this location in in Google Cloud
- * Storage.
- */
+
+ /// If provided, get the source from this location in in Google Cloud
+ /// Storage.
StorageSource storageSource;
Source();
@@ -1706,7 +1694,8 @@ class Source {
}
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 (repoSource != null) {
_json["repoSource"] = (repoSource).toJson();
}
@@ -1717,53 +1706,56 @@ class Source {
}
}
-/**
- * Provenance of the source. Ways to find the original source, or verify that
- * some source was used for this build.
- */
+/// Provenance of the source. Ways to find the original source, or verify that
+/// some source was used for this build.
class SourceProvenance {
- /**
- * Hash(es) of the build source, which can be used to verify that the original
- * source integrity was maintained in the build. Note that FileHashes will
- * only be populated if BuildOptions has requested a SourceProvenanceHash.
- *
- * The keys to this map are file paths used as build source and the values
- * contain the hash values for those files.
- *
- * If the build source came in a single package such as a gzipped tarfile
- * (.tar.gz), the FileHash will be for the single path to that file.
- * @OutputOnly
- */
+ /// Hash(es) of the build source, which can be used to verify that the
+ /// original
+ /// source integrity was maintained in the build. Note that FileHashes will
+ /// only be populated if BuildOptions has requested a SourceProvenanceHash.
+ ///
+ /// The keys to this map are file paths used as build source and the values
+ /// contain the hash values for those files.
+ ///
+ /// If the build source came in a single package such as a gzipped tarfile
+ /// (.tar.gz), the FileHash will be for the single path to that file.
+ /// @OutputOnly
core.Map<core.String, FileHashes> fileHashes;
- /**
- * A copy of the build's source.repo_source, if exists, with any
- * revisions resolved.
- */
+
+ /// A copy of the build's source.repo_source, if exists, with any
+ /// revisions resolved.
RepoSource resolvedRepoSource;
- /**
- * A copy of the build's source.storage_source, if exists, with any
- * generations resolved.
- */
+
+ /// A copy of the build's source.storage_source, if exists, with any
+ /// generations resolved.
StorageSource resolvedStorageSource;
SourceProvenance();
SourceProvenance.fromJson(core.Map _json) {
if (_json.containsKey("fileHashes")) {
- fileHashes = commons.mapMap<core.Map<core.String, core.Object>, FileHashes>(_json["fileHashes"], (core.Map<core.String, core.Object> item) => new FileHashes.fromJson(item));
+ fileHashes =
+ commons.mapMap<core.Map<core.String, core.Object>, FileHashes>(
+ _json["fileHashes"],
+ (core.Map<core.String, core.Object> item) =>
+ new FileHashes.fromJson(item));
}
if (_json.containsKey("resolvedRepoSource")) {
resolvedRepoSource = new RepoSource.fromJson(_json["resolvedRepoSource"]);
}
if (_json.containsKey("resolvedStorageSource")) {
- resolvedStorageSource = new StorageSource.fromJson(_json["resolvedStorageSource"]);
+ resolvedStorageSource =
+ new StorageSource.fromJson(_json["resolvedStorageSource"]);
}
}
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 (fileHashes != null) {
- _json["fileHashes"] = commons.mapMap<FileHashes, core.Map<core.String, core.Object>>(fileHashes, (FileHashes item) => (item).toJson());
+ _json["fileHashes"] =
+ commons.mapMap<FileHashes, core.Map<core.String, core.Object>>(
+ fileHashes, (FileHashes item) => (item).toJson());
}
if (resolvedRepoSource != null) {
_json["resolvedRepoSource"] = (resolvedRepoSource).toJson();
@@ -1775,78 +1767,81 @@ class SourceProvenance {
}
}
-/**
- * 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();
@@ -1864,7 +1859,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;
}
@@ -1878,28 +1874,22 @@ class Status {
}
}
-/**
- * StorageSource describes the location of the source in an archive file in
- * Google Cloud Storage.
- */
+/// StorageSource describes the location of the source in an archive file in
+/// Google Cloud Storage.
class StorageSource {
- /**
- * Google Cloud Storage bucket containing source (see
- * [Bucket Name
- * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
- */
+ /// Google Cloud Storage bucket containing source (see
+ /// [Bucket Name
+ /// Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
core.String bucket;
- /**
- * Google Cloud Storage generation for the object. If the generation is
- * omitted, the latest generation will be used.
- */
+
+ /// Google Cloud Storage generation for the object. If the generation is
+ /// omitted, the latest generation will be used.
core.String generation;
- /**
- * Google Cloud Storage object containing source.
- *
- * This object must be a gzipped archive file (.tar.gz) containing source to
- * build.
- */
+
+ /// Google Cloud Storage object containing source.
+ ///
+ /// This object must be a gzipped archive file (.tar.gz) containing source to
+ /// build.
core.String object;
StorageSource();
@@ -1917,7 +1907,8 @@ class StorageSource {
}
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 (bucket != null) {
_json["bucket"] = bucket;
}
@@ -1931,24 +1922,21 @@ class StorageSource {
}
}
-/**
- * Volume describes a Docker container volume which is mounted into build steps
- * in order to persist files across build step execution.
- */
+/// Volume describes a Docker container volume which is mounted into build
+/// steps
+/// in order to persist files across build step execution.
class Volume {
- /**
- * Name of the volume to mount.
- *
- * Volume names must be unique per build step and must be valid names for
- * Docker volumes. Each named volume must be used by at least two build steps.
- */
+ /// Name of the volume to mount.
+ ///
+ /// Volume names must be unique per build step and must be valid names for
+ /// Docker volumes. Each named volume must be used by at least two build
+ /// steps.
core.String name;
- /**
- * Path at which to mount the volume.
- *
- * Paths must be absolute and cannot conflict with other volume paths on the
- * same build step or with certain reserved volume paths.
- */
+
+ /// Path at which to mount the volume.
+ ///
+ /// Paths must be absolute and cannot conflict with other volume paths on the
+ /// same build step or with certain reserved volume paths.
core.String path;
Volume();
@@ -1963,7 +1951,8 @@ class Volume {
}
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 (name != null) {
_json["name"] = name;
}
« no previous file with comments | « generated/googleapis/lib/cloudbilling/v1.dart ('k') | generated/googleapis/lib/clouddebugger/v2.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698