Api-roll 46: 2017-03-06

generated/googleapis_beta/lib/ml/v1beta1.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis_beta.ml.v1beta1;
 
 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 270 matching lines @@
   /**
    * Lists the jobs in the project.
    *
    * Request parameters:
    *
    * [parent] - Required. The name of the project for which to list jobs.
    *
    * Authorization: requires `Viewer` role on the specified project.
    * Value must have pattern "^projects/[^/]+$".
    *
-   * [filter] - Optional. Specifies the subset of jobs to retrieve.
-   *
    * [pageToken] - Optional. A page token to request the next page of results.
    *
    * You get the token from the `next_page_token` field of the response from
    * the previous call.
    *
    * [pageSize] - Optional. The number of jobs to retrieve per "page" of
    * results. If there
    * are more remaining results than this number, the response message will
    * contain a valid value in the `next_page_token` field.
    *
    * The default value is 20, and the maximum page size is 100.
    *
+   * [filter] - Optional. Specifies the subset of jobs to retrieve.
+   *
    * Completes with a [GoogleCloudMlV1beta1ListJobsResponse].
    *
    * 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<GoogleCloudMlV1beta1ListJobsResponse> list(core.String parent, {core.String filter, core.String pageToken, core.int pageSize}) {
+  async.Future<GoogleCloudMlV1beta1ListJobsResponse> list(core.String parent, {core.String pageToken, core.int pageSize, core.String filter}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     if (parent == null) {
       throw new core.ArgumentError("Parameter parent 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 = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/jobs';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 645 matching lines @@
    * server doesn't support this method, it returns `UNIMPLEMENTED`.
    *
    * NOTE: the `name` binding below allows API services to override the binding
    * to use different resource name schemes, such as `users / * /operations`.
    *
    * Request parameters:
    *
    * [name] - The name of the operation collection.
    * Value must have pattern "^projects/[^/]+$".
    *
-   * [filter] - The standard list filter.
-   *
    * [pageToken] - The standard list page token.
    *
    * [pageSize] - The standard list page size.
    *
+   * [filter] - The standard list filter.
+   *
    * Completes with a [GoogleLongrunningListOperationsResponse].
    *
    * 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<GoogleLongrunningListOperationsResponse> list(core.String name, {core.String filter, core.String pageToken, core.int pageSize}) {
+  async.Future<GoogleLongrunningListOperationsResponse> list(core.String name, {core.String pageToken, core.int pageSize, core.String filter}) {
     var _url = null;
     var _queryParams = new core.Map();
     var _uploadMedia = null;
     var _uploadOptions = null;
     var _downloadOptions = commons.DownloadOptions.Metadata;
     var _body = null;
 
     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 = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name') + '/operations';
 
     var _response = _requester.request(_url,
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
@@ skipping 75 matching lines @@
     if (contentType != null) {
       _json["contentType"] = contentType;
     }
     if (data != null) {
       _json["data"] = data;
     }
     return _json;
   }
 }
 
+/** Options for manually scaling a model. */
+class GoogleCloudMlV1ManualScaling {
+  /**
+   * The number of nodes to allocate for this model. These nodes are always up,
+   * starting from the time the model is deployed, so the cost of operating
+   * this model will be proportional to nodes * number of hours since
+   * deployment.
+   */
+  core.int nodes;
+
+  GoogleCloudMlV1ManualScaling();
+
+  GoogleCloudMlV1ManualScaling.fromJson(core.Map _json) {
+    if (_json.containsKey("nodes")) {
+      nodes = _json["nodes"];
+    }
+  }
+
+  core.Map toJson() {
+    var _json = new core.Map();
+    if (nodes != null) {
+      _json["nodes"] = nodes;
+    }
+    return _json;
+  }
+}
+
 /** Represents the metadata of the long-running operation. */
 class GoogleCloudMlV1OperationMetadata {
   /** The time the operation was submitted. */
   core.String createTime;
   /** The time operation processing completed. */
   core.String endTime;
   /** Indicates whether a request to cancel this operation has been made. */
   core.bool isCancellationRequested;
   /** Contains the name of the model associated with the operation. */
   core.String modelName;
@@ skipping 96 matching lines @@
    * Output only. If true, this version will be used to handle prediction
    * requests that do not specify a version.
    *
    * You can change the default version by calling
    * [projects.methods.versions.setDefault](/ml/reference/rest/v1/projects.models.versions/setDefault).
    */
   core.bool isDefault;
   /** Output only. The time the version was last used for prediction. */
   core.String lastUseTime;
   /**
+   * Optional. Manually select the number of nodes to use for serving the
+   * model. If unset (i.e., by default), the number of nodes used to serve
+   * the model automatically scales with traffic. However, care should be
+   * taken to ramp up traffic according to the model's ability to scale. If
+   * your model needs to handle bursts of traffic beyond it's ability to
+   * scale, it is recommended you set this field appropriately.
+   */
+  GoogleCloudMlV1ManualScaling manualScaling;
+  /**
    * Required.The name specified for the version when it was created.
    *
    * The version name must be unique within the model it is created in.
    */
   core.String name;
   /**
    * Optional. The Google Cloud ML runtime version to use for this deployment.
    * If not set, Google Cloud ML will choose a version.
    */
   core.String runtimeVersion;
 
   GoogleCloudMlV1Version();
 
   GoogleCloudMlV1Version.fromJson(core.Map _json) {
     if (_json.containsKey("createTime")) {
       createTime = _json["createTime"];
     }
     if (_json.containsKey("deploymentUri")) {
       deploymentUri = _json["deploymentUri"];
     }
     if (_json.containsKey("description")) {
       description = _json["description"];
     }
     if (_json.containsKey("isDefault")) {
       isDefault = _json["isDefault"];
     }
     if (_json.containsKey("lastUseTime")) {
       lastUseTime = _json["lastUseTime"];
     }
+    if (_json.containsKey("manualScaling")) {
+      manualScaling = new GoogleCloudMlV1ManualScaling.fromJson(_json["manualScaling"]);
+    }
     if (_json.containsKey("name")) {
       name = _json["name"];
     }
     if (_json.containsKey("runtimeVersion")) {
       runtimeVersion = _json["runtimeVersion"];
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (createTime != null) {
       _json["createTime"] = createTime;
     }
     if (deploymentUri != null) {
       _json["deploymentUri"] = deploymentUri;
     }
     if (description != null) {
       _json["description"] = description;
     }
     if (isDefault != null) {
       _json["isDefault"] = isDefault;
     }
     if (lastUseTime != null) {
       _json["lastUseTime"] = lastUseTime;
     }
+    if (manualScaling != null) {
+      _json["manualScaling"] = (manualScaling).toJson();
+    }
     if (name != null) {
       _json["name"] = name;
     }
     if (runtimeVersion != null) {
       _json["runtimeVersion"] = runtimeVersion;
     }
     return _json;
   }
 }
 
@@ skipping 408 matching lines @@
     if (nextPageToken != null) {
       _json["nextPageToken"] = nextPageToken;
     }
     if (versions != null) {
       _json["versions"] = versions.map((value) => (value).toJson()).toList();
     }
     return _json;
   }
 }
 
+/** Options for manually scaling a model. */
+class GoogleCloudMlV1beta1ManualScaling {
+  /**
+   * The number of nodes to allocate for this model. These nodes are always up,
+   * starting from the time the model is deployed, so the cost of operating
+   * this model will be proportional to nodes * number of hours since
+   * deployment.
+   */
+  core.int nodes;
+
+  GoogleCloudMlV1beta1ManualScaling();
+
+  GoogleCloudMlV1beta1ManualScaling.fromJson(core.Map _json) {
+    if (_json.containsKey("nodes")) {
+      nodes = _json["nodes"];
+    }
+  }
+
+  core.Map toJson() {
+    var _json = new core.Map();
+    if (nodes != null) {
+      _json["nodes"] = nodes;
+    }
+    return _json;
+  }
+}
+
 /**
  * Represents a machine learning solution.
  *
  * A model can have multiple versions, each of which is a deployed, trained
  * model ready to receive prediction requests. The model itself is just a
  * container.
  */
 class GoogleCloudMlV1beta1Model {
   /**
    * Output only. The default version of the model. This version will be used to
@@ skipping 507 matching lines @@
    */
   core.String region;
   /**
    * Optional. The Google Cloud ML runtime version to use for this batch
    * prediction. If not set, Google Cloud ML will pick the runtime version used
    * during the CreateVersion request for this model version, or choose the
    * latest stable version when model version information is not available
    * such as when the model is specified by uri.
    */
   core.String runtimeVersion;
-  /** Use this field if you want to specify a GCS path to the model to use. */
+  /**
+   * Use this field if you want to specify a Google Cloud Storage path for
+   * the model to use.
+   */
   core.String uri;
   /**
    * Use this field if you want to specify a version of the model to use. The
    * string is formatted the same way as `model_version`, with the addition
    * of the version information:
    *
    * `"projects/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"`
    */
   core.String versionName;
 
@@ skipping 124 matching lines @@
   }
 }
 
 /** Represents input parameters for a training job. */
 class GoogleCloudMlV1beta1TrainingInput {
   /** Optional. Command line arguments to pass to the program. */
   core.List<core.String> args;
   /** Optional. The set of Hyperparameters to tune. */
   GoogleCloudMlV1beta1HyperparameterSpec hyperparameters;
   /**
-   * Optional. A GCS path in which to store training outputs and other data
-   * needed for training. This path will be passed to your TensorFlow program as
-   * the 'job_dir' command-line arg. The benefit of specifying this field is
-   * that
-   * Cloud ML will validate the path for use in training.
+   * Optional. A Google Cloud Storage path in which to store training outputs
+   * and other data needed for training. This path is passed to your TensorFlow
+   * program as the 'job_dir' command-line argument. The benefit of specifying
+   * this field is that Cloud ML validates the path for use in training.
    */
   core.String jobDir;
   /**
    * Optional. Specifies the type of virtual machine to use for your training
    * job's master worker.
    *
    * The following types are supported:
    *
    * <dl>
    *   <dt>standard</dt>
@@ skipping 16 matching lines @@
    *   <dt>complex_model_m</dt>
    *   <dd>
    *   A machine with roughly twice the number of cores and roughly double the
    *   memory of <code suppresswarning="true">complex_model_s</code>.
    *   </dd>
    *   <dt>complex_model_l</dt>
    *   <dd>
    *   A machine with roughly twice the number of cores and roughly double the
    *   memory of <code suppresswarning="true">complex_model_m</code>.
    *   </dd>
+   *   <dt>standard_gpu</dt>
+   *   <dd>
+   * A machine equivalent to <code suppresswarning="true">standard</code> that
+   *   also includes a
+   *   <a href="ml/docs/how-tos/using-gpus">
+   *   GPU that you can use in your trainer</a>.
+   *   </dd>
+   *   <dt>complex_model_m_gpu</dt>
+   *   <dd>
+   *   A machine equivalent to
+   *   <code suppresswarning="true">coplex_model_m</code> that also includes
+   *   four GPUs.
+   *   </dd>
    * </dl>
    *
    * You must set this value when `scaleTier` is set to `CUSTOM`.
    */
   core.String masterType;
   /**
    * Required. The Google Cloud Storage location of the packages with
    * the training program and any additional dependencies.
    */
   core.List<core.String> packageUris;
@@ skipping 28 matching lines @@
   core.String runtimeVersion;
   /**
    * Required. Specifies the machine types, the number of replicas for workers
    * and parameter servers.
    * Possible string values are:
    * - "BASIC" : A single worker instance. This tier is suitable for learning
    * how to use
    * Cloud ML, and for experimenting with new models using small datasets.
    * - "STANDARD_1" : Many workers and a few parameter servers.
    * - "PREMIUM_1" : A large number of workers with many parameter servers.
-   * - "BASIC_GPU" : A single worker instance with a GPU.
+   * - "BASIC_GPU" : A single worker instance [with a
+   * GPU](ml/docs/how-tos/using-gpus).
    * - "CUSTOM" : The CUSTOM tier is not a set tier, but rather enables you to
    * use your
    * own cluster specification. When you use this tier, set values to
    * configure your processing cluster according to these guidelines:
    *
    * *   You _must_ set `TrainingInput.masterType` to specify the type
    *     of machine to use for your master node. This is the only required
    *     setting.
    *
    * *   You _may_ set `TrainingInput.workerCount` to specify the number of
@@ skipping 206 matching lines @@
    * Output only. If true, this version will be used to handle prediction
    * requests that do not specify a version.
    *
    * You can change the default version by calling
    * [projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
    */
   core.bool isDefault;
   /** Output only. The time the version was last used for prediction. */
   core.String lastUseTime;
   /**
+   * Optional. Manually select the number of nodes to use for serving the
+   * model. If unset (i.e., by default), the number of nodes used to serve
+   * the model automatically scales with traffic. However, care should be
+   * taken to ramp up traffic according to the model's ability to scale. If
+   * your model needs to handle bursts of traffic beyond it's ability to
+   * scale, it is recommended you set this field appropriately.
+   */
+  GoogleCloudMlV1beta1ManualScaling manualScaling;
+  /**
    * Required.The name specified for the version when it was created.
    *
    * The version name must be unique within the model it is created in.
    */
   core.String name;
   /**
    * Optional. The Google Cloud ML runtime version to use for this deployment.
    * If not set, Google Cloud ML will choose a version.
    */
   core.String runtimeVersion;
 
   GoogleCloudMlV1beta1Version();
 
   GoogleCloudMlV1beta1Version.fromJson(core.Map _json) {
     if (_json.containsKey("createTime")) {
       createTime = _json["createTime"];
     }
     if (_json.containsKey("deploymentUri")) {
       deploymentUri = _json["deploymentUri"];
     }
     if (_json.containsKey("description")) {
       description = _json["description"];
     }
     if (_json.containsKey("isDefault")) {
       isDefault = _json["isDefault"];
     }
     if (_json.containsKey("lastUseTime")) {
       lastUseTime = _json["lastUseTime"];
     }
+    if (_json.containsKey("manualScaling")) {
+      manualScaling = new GoogleCloudMlV1beta1ManualScaling.fromJson(_json["manualScaling"]);
+    }
     if (_json.containsKey("name")) {
       name = _json["name"];
     }
     if (_json.containsKey("runtimeVersion")) {
       runtimeVersion = _json["runtimeVersion"];
     }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (createTime != null) {
       _json["createTime"] = createTime;
     }
     if (deploymentUri != null) {
       _json["deploymentUri"] = deploymentUri;
     }
     if (description != null) {
       _json["description"] = description;
     }
     if (isDefault != null) {
       _json["isDefault"] = isDefault;
     }
     if (lastUseTime != null) {
       _json["lastUseTime"] = lastUseTime;
     }
+    if (manualScaling != null) {
+      _json["manualScaling"] = (manualScaling).toJson();
+    }
     if (name != null) {
       _json["name"] = name;
     }
     if (runtimeVersion != null) {
       _json["runtimeVersion"] = runtimeVersion;
     }
     return _json;
   }
 }
 
@@ skipping 231 matching lines @@
     }
     if (details != null) {
       _json["details"] = details;
     }
     if (message != null) {
       _json["message"] = message;
     }
     return _json;
   }
 }