Api-roll 42: 2016-11-08

generated/googleapis/lib/cloudbuild/v1.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.cloudbuild.v1;
 
 import 'dart:core' as core;
 import 'dart:async' as async;
 import 'dart:convert' as convert;
 
 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
 import 'package:http/http.dart' as http;
@@ skipping 26 matching lines @@
       _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/.*$".
+   * 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) {
@@ skipping 248 matching lines @@
    *
    * Previously requested builds may still be in-progress, or may have finished
    * successfully or unsuccessfully.
    *
    * Request parameters:
    *
    * [projectId] - ID of the project.
    *
    * [pageSize] - Number of results to return in the list.
    *
+   * [filter] - The raw filter text to constrain the results.
+   *
    * [pageToken] - Token to provide to skip to a particular spot in the list.
    *
    * 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.int pageSize, core.String pageToken}) {
+  async.Future<ListBuildsResponse> list(core.String projectId, {core.int pageSize, core.String filter, core.String pageToken}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (projectId == null) {
       throw new core.ArgumentError("Parameter projectId is required.");
     }
     if (pageSize != null) {
       _queryParams["pageSize"] = ["${pageSize}"];
     }
+    if (filter != null) {
+      _queryParams["filter"] = [filter];
+    }
     if (pageToken != null) {
       _queryParams["pageToken"] = [pageToken];
     }
 
     _url = 'v1/projects/' + commons.Escaper.ecapeVariable('$projectId') + '/builds';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
@@ skipping 245 matching lines @@
 }
 
 
 
 /**
  * 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
+   */
+  core.String buildTriggerId;
+  /**
    * Time at which the build was created.
    * @OutputOnly
    */
   core.String createTime;
   /**
    * Time at which execution of the build was finished.
    * @OutputOnly
    */
   core.String finishTime;
   /**
    * Unique identifier of the build.
    * @OutputOnly
    */
   core.String id;
   /**
-   * List of images expected to be built and pushed to Google Container
-   * Registry. If an image is listed here and the image is not produced by
-   * one of the build steps, the build will fail. Any images present when
-   * the build steps are complete will be pushed to Container Registry.
+   * 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
    */
   core.String logUrl;
   /**
    * Google Cloud Storage bucket where logs should be written (see
    * [Bucket Name
@@ skipping 52 matching lines @@
    * 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();
 
   Build.fromJson(core.Map _json) {
+    if (_json.containsKey("buildTriggerId")) {
+      buildTriggerId = _json["buildTriggerId"];
+    }
     if (_json.containsKey("createTime")) {
       createTime = _json["createTime"];
     }
     if (_json.containsKey("finishTime")) {
       finishTime = _json["finishTime"];
     }
     if (_json.containsKey("id")) {
       id = _json["id"];
     }
     if (_json.containsKey("images")) {
@@ skipping 32 matching lines @@
     if (_json.containsKey("steps")) {
       steps = _json["steps"].map((value) => new BuildStep.fromJson(value)).toList();
     }
     if (_json.containsKey("timeout")) {
       timeout = _json["timeout"];
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
+    if (buildTriggerId != null) {
+      _json["buildTriggerId"] = buildTriggerId;
+    }
     if (createTime != null) {
       _json["createTime"] = createTime;
     }
     if (finishTime != null) {
       _json["finishTime"] = finishTime;
     }
     if (id != null) {
       _json["id"] = id;
     }
     if (images != null) {
@@ skipping 57 matching lines @@
     if (build != null) {
       _json["build"] = (build).toJson();
     }
     return _json;
   }
 }
 
 /** Optional arguments to enable specific features of builds. */
 class BuildOptions {
   /**
-   * Options for a verifiable build with details uploaded to the Analysis API.
+   * Requested verifiability options.
    * Possible string values are:
    * - "NOT_VERIFIED" : Not a verifiable build. (default)
    * - "VERIFIED" : Verified build.
    */
   core.String requestedVerifyOption;
   /** Requested hash for SourceProvenance. */
   core.List<core.String> sourceProvenanceHash;
 
   BuildOptions();
 
@@ skipping 13 matching lines @@
     }
     if (sourceProvenanceHash != null) {
       _json["sourceProvenanceHash"] = sourceProvenanceHash;
     }
     return _json;
   }
 }
 
 /** BuildStep describes a step to perform in the build pipeline. */
 class BuildStep {
-  /** Command-line arguments to use when running this step's container. */
+  /**
+   * 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.
    */
   core.String dir;
-  /** Additional environment variables to set for this step's container. */
+  /**
+   * 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.
    */
   core.String id;
   /**
-   * Name of the container image to use for creating this stage in the
-   * pipeline, as presented to `docker pull`.
+   * 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). 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;
   /**
    * 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;
@@ skipping 51 matching lines @@
  */
 class BuildTrigger {
   /** Contents of the build template. */
   Build build;
   /**
    * Time when the trigger was created.
    *
    * @OutputOnly
    */
   core.String createTime;
+  /** Human-readable description of this trigger. */
+  core.String description;
+  /** 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.
    */
   core.String filename;
   /**
    * Unique identifier of the trigger.
    *
    * @OutputOnly
    */
   core.String id;
   /**
    * 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();
 
   BuildTrigger.fromJson(core.Map _json) {
     if (_json.containsKey("build")) {
       build = new Build.fromJson(_json["build"]);
     }
     if (_json.containsKey("createTime")) {
       createTime = _json["createTime"];
     }
+    if (_json.containsKey("description")) {
+      description = _json["description"];
+    }
+    if (_json.containsKey("disabled")) {
+      disabled = _json["disabled"];
+    }
     if (_json.containsKey("filename")) {
       filename = _json["filename"];
     }
     if (_json.containsKey("id")) {
       id = _json["id"];
     }
     if (_json.containsKey("triggerTemplate")) {
       triggerTemplate = new RepoSource.fromJson(_json["triggerTemplate"]);
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (build != null) {
       _json["build"] = (build).toJson();
     }
     if (createTime != null) {
       _json["createTime"] = createTime;
     }
+    if (description != null) {
+      _json["description"] = description;
+    }
+    if (disabled != null) {
+      _json["disabled"] = disabled;
+    }
     if (filename != null) {
       _json["filename"] = filename;
     }
     if (id != null) {
       _json["id"] = id;
     }
     if (triggerTemplate != null) {
       _json["triggerTemplate"] = (triggerTemplate).toJson();
     }
     return _json;
@@ skipping 224 matching lines @@
  * 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.
    */
   core.bool done;
-  /** The error result of the operation in case of failure. */
+  /** The error result of the operation in case of failure or cancellation. */
   Status error;
   /**
    * Service-specific metadata associated with the operation.  It typically
    * contains progress information and common metadata such as create time.
    * Some services might not provide such metadata.  Any method that returns a
    * 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.
    */
@@ skipping 394 matching lines @@
     }
     if (generation != null) {
       _json["generation"] = generation;
     }
     if (object != null) {
       _json["object"] = object;
     }
     return _json;
   }
 }