| Index: generated/googleapis_beta/lib/ml/v1beta1.dart
|
| diff --git a/generated/googleapis_beta/lib/ml/v1beta1.dart b/generated/googleapis_beta/lib/ml/v1beta1.dart
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..045150b792c79534a5ae795c847cc3b4baa40ef6
|
| --- /dev/null
|
| +++ b/generated/googleapis_beta/lib/ml/v1beta1.dart
|
| @@ -0,0 +1,2664 @@
|
| +// 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;
|
| +
|
| +export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
|
| + ApiRequestError, DetailedApiRequestError;
|
| +
|
| +const core.String USER_AGENT = 'dart-api-client ml/v1beta1';
|
| +
|
| +/** An API to enable creating and using machine learning models. */
|
| +class MlApi {
|
| + /** View and manage your data across Google Cloud Platform services */
|
| + static const CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform";
|
| +
|
| +
|
| + final commons.ApiRequester _requester;
|
| +
|
| + ProjectsResourceApi get projects => new ProjectsResourceApi(_requester);
|
| +
|
| + MlApi(http.Client client, {core.String rootUrl: "https://ml.googleapis.com/", core.String servicePath: ""}) :
|
| + _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
|
| +}
|
| +
|
| +
|
| +class ProjectsResourceApi {
|
| + final commons.ApiRequester _requester;
|
| +
|
| + ProjectsJobsResourceApi get jobs => new ProjectsJobsResourceApi(_requester);
|
| + ProjectsModelsResourceApi get models => new ProjectsModelsResourceApi(_requester);
|
| + ProjectsOperationsResourceApi get operations => new ProjectsOperationsResourceApi(_requester);
|
| +
|
| + ProjectsResourceApi(commons.ApiRequester client) :
|
| + _requester = client;
|
| +
|
| + /**
|
| + * Get the service account information associated with your project. You need
|
| + * this information in order to grant the service account persmissions for
|
| + * the Google Cloud Storage location where you put your model training code
|
| + * for training the model with Google Cloud Machine Learning.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [name] - Required. The project name.
|
| + *
|
| + * Authorization: requires `Viewer` role on the specified project.
|
| + * Value must have pattern "^projects/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleCloudMlV1beta1GetConfigResponse].
|
| + *
|
| + * 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<GoogleCloudMlV1beta1GetConfigResponse> getConfig(core.String name) {
|
| + 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.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name') + ':getConfig';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleCloudMlV1beta1GetConfigResponse.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Performs prediction on the data in the request.
|
| + *
|
| + * Responses are very similar to requests. There are two top-level fields,
|
| + * each of which are JSON lists:
|
| + *
|
| + * <dl>
|
| + * <dt>predictions</dt>
|
| + * <dd>The list of predictions, one per instance in the request.</dd>
|
| + * <dt>error</dt>
|
| + * <dd>An error message returned instead of a prediction list if any
|
| + * instance produced an error.</dd>
|
| + * </dl>
|
| + *
|
| + * If the call is successful, the response body will contain one prediction
|
| + * entry per instance in the request body. If prediction fails for any
|
| + * instance, the response body will contain no predictions and will contian
|
| + * a single error entry instead.
|
| + *
|
| + * Even though there is one prediction per instance, the format of a
|
| + * prediction is not directly related to the format of an instance.
|
| + * Predictions take whatever format is specified in the outputs collection
|
| + * defined in the model. The collection of predictions is returned in a JSON
|
| + * list. Each member of the list can be a simple value, a list, or a JSON
|
| + * object of any complexity. If your model has more than one output tensor,
|
| + * each prediction will be a JSON object containing a name/value pair for each
|
| + * output. The names identify the output aliases in the graph.
|
| + *
|
| + * The following examples show some possible responses:
|
| + *
|
| + * A simple set of predictions for three input instances, where each
|
| + * prediction is an integer value:
|
| + * <pre>
|
| + * {"predictions": [5, 4, 3]}
|
| + * </pre>
|
| + * A more complex set of predictions, each containing two named values that
|
| + * correspond to output tensors, named **label** and **scores** respectively.
|
| + * The value of **label** is the predicted category ("car" or "beach") and
|
| + * **scores** contains a list of probabilities for that instance across the
|
| + * possible categories.
|
| + * <pre>
|
| + * {"predictions": [{"label": "beach", "scores": [0.1, 0.9]},
|
| + * {"label": "car", "scores": [0.75, 0.25]}]}
|
| + * </pre>
|
| + * A response when there is an error processing an input instance:
|
| + * <pre>
|
| + * {"error": "Divide by zero"}
|
| + * </pre>
|
| + *
|
| + * [request] - The metadata request object.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [name] - Required. The resource name of a model or a version.
|
| + *
|
| + * Authorization: requires `Viewer` role on the parent project.
|
| + * Value must have pattern "^projects/.+$".
|
| + *
|
| + * Completes with a [GoogleApiHttpBody].
|
| + *
|
| + * 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<GoogleApiHttpBody> predict(GoogleCloudMlV1beta1PredictRequest request, core.String name) {
|
| + var _url = null;
|
| + var _queryParams = new core.Map();
|
| + var _uploadMedia = null;
|
| + var _uploadOptions = null;
|
| + var _downloadOptions = commons.DownloadOptions.Metadata;
|
| + var _body = null;
|
| +
|
| + if (request != null) {
|
| + _body = convert.JSON.encode((request).toJson());
|
| + }
|
| + if (name == null) {
|
| + throw new core.ArgumentError("Parameter name is required.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name') + ':predict';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleApiHttpBody.fromJson(data));
|
| + }
|
| +
|
| +}
|
| +
|
| +
|
| +class ProjectsJobsResourceApi {
|
| + final commons.ApiRequester _requester;
|
| +
|
| + ProjectsJobsResourceApi(commons.ApiRequester client) :
|
| + _requester = client;
|
| +
|
| + /**
|
| + * Cancels a running job.
|
| + *
|
| + * [request] - The metadata request object.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [name] - Required. The name of the job to cancel.
|
| + *
|
| + * Authorization: requires `Editor` role on the parent project.
|
| + * Value must have pattern "^projects/[^/]+/jobs/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleProtobufEmpty].
|
| + *
|
| + * 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<GoogleProtobufEmpty> cancel(GoogleCloudMlV1beta1CancelJobRequest request, core.String name) {
|
| + var _url = null;
|
| + var _queryParams = new core.Map();
|
| + var _uploadMedia = null;
|
| + var _uploadOptions = null;
|
| + var _downloadOptions = commons.DownloadOptions.Metadata;
|
| + var _body = null;
|
| +
|
| + if (request != null) {
|
| + _body = convert.JSON.encode((request).toJson());
|
| + }
|
| + if (name == null) {
|
| + throw new core.ArgumentError("Parameter name is required.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name') + ':cancel';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleProtobufEmpty.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Creates a training or a batch prediction job.
|
| + *
|
| + * [request] - The metadata request object.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [parent] - Required. The project name.
|
| + *
|
| + * Authorization: requires `Editor` role on the specified project.
|
| + * Value must have pattern "^projects/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleCloudMlV1beta1Job].
|
| + *
|
| + * 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<GoogleCloudMlV1beta1Job> create(GoogleCloudMlV1beta1Job request, core.String parent) {
|
| + var _url = null;
|
| + var _queryParams = new core.Map();
|
| + var _uploadMedia = null;
|
| + var _uploadOptions = null;
|
| + var _downloadOptions = commons.DownloadOptions.Metadata;
|
| + var _body = null;
|
| +
|
| + if (request != null) {
|
| + _body = convert.JSON.encode((request).toJson());
|
| + }
|
| + if (parent == null) {
|
| + throw new core.ArgumentError("Parameter parent is required.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/jobs';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleCloudMlV1beta1Job.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Describes a job.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [name] - Required. The name of the job to get the description of.
|
| + *
|
| + * Authorization: requires `Viewer` role on the parent project.
|
| + * Value must have pattern "^projects/[^/]+/jobs/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleCloudMlV1beta1Job].
|
| + *
|
| + * 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<GoogleCloudMlV1beta1Job> get(core.String name) {
|
| + 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.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name');
|
| +
|
| + var _response = _requester.request(_url,
|
| + "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleCloudMlV1beta1Job.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * 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/[^/]+$".
|
| + *
|
| + * [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.
|
| + *
|
| + * [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.
|
| + *
|
| + * 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.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 (parent == null) {
|
| + throw new core.ArgumentError("Parameter parent is required.");
|
| + }
|
| + if (pageSize != null) {
|
| + _queryParams["pageSize"] = ["${pageSize}"];
|
| + }
|
| + if (filter != null) {
|
| + _queryParams["filter"] = [filter];
|
| + }
|
| + if (pageToken != null) {
|
| + _queryParams["pageToken"] = [pageToken];
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/jobs';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleCloudMlV1beta1ListJobsResponse.fromJson(data));
|
| + }
|
| +
|
| +}
|
| +
|
| +
|
| +class ProjectsModelsResourceApi {
|
| + final commons.ApiRequester _requester;
|
| +
|
| + ProjectsModelsVersionsResourceApi get versions => new ProjectsModelsVersionsResourceApi(_requester);
|
| +
|
| + ProjectsModelsResourceApi(commons.ApiRequester client) :
|
| + _requester = client;
|
| +
|
| + /**
|
| + * Creates a model which will later contain one or more versions.
|
| + *
|
| + * You must add at least one version before you can request predictions from
|
| + * the model. Add versions by calling
|
| + * [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create).
|
| + *
|
| + * [request] - The metadata request object.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [parent] - Required. The project name.
|
| + *
|
| + * Authorization: requires `Editor` role on the specified project.
|
| + * Value must have pattern "^projects/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleCloudMlV1beta1Model].
|
| + *
|
| + * 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<GoogleCloudMlV1beta1Model> create(GoogleCloudMlV1beta1Model request, core.String parent) {
|
| + var _url = null;
|
| + var _queryParams = new core.Map();
|
| + var _uploadMedia = null;
|
| + var _uploadOptions = null;
|
| + var _downloadOptions = commons.DownloadOptions.Metadata;
|
| + var _body = null;
|
| +
|
| + if (request != null) {
|
| + _body = convert.JSON.encode((request).toJson());
|
| + }
|
| + if (parent == null) {
|
| + throw new core.ArgumentError("Parameter parent is required.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/models';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleCloudMlV1beta1Model.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Deletes a model.
|
| + *
|
| + * You can only delete a model if there are no versions in it. You can delete
|
| + * versions by calling
|
| + * [projects.models.versions.delete](/ml/reference/rest/v1beta1/projects.models.versions/delete).
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [name] - Required. The name of the model.
|
| + *
|
| + * Authorization: requires `Editor` role on the parent project.
|
| + * Value must have pattern "^projects/[^/]+/models/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleLongrunningOperation].
|
| + *
|
| + * 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<GoogleLongrunningOperation> delete(core.String name) {
|
| + 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.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name');
|
| +
|
| + var _response = _requester.request(_url,
|
| + "DELETE",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleLongrunningOperation.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Gets information about a model, including its name, the description (if
|
| + * set), and the default version (if at least one version of the model has
|
| + * been deployed).
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [name] - Required. The name of the model.
|
| + *
|
| + * Authorization: requires `Viewer` role on the parent project.
|
| + * Value must have pattern "^projects/[^/]+/models/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleCloudMlV1beta1Model].
|
| + *
|
| + * 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<GoogleCloudMlV1beta1Model> get(core.String name) {
|
| + 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.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name');
|
| +
|
| + var _response = _requester.request(_url,
|
| + "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleCloudMlV1beta1Model.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Lists the models in a project.
|
| + *
|
| + * Each project can contain multiple models, and each model can have multiple
|
| + * versions.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [parent] - Required. The name of the project whose models are to be listed.
|
| + *
|
| + * Authorization: requires `Viewer` role on the specified project.
|
| + * Value must have pattern "^projects/[^/]+$".
|
| + *
|
| + * [pageSize] - Optional. The number of models 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.
|
| + *
|
| + * [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.
|
| + *
|
| + * Completes with a [GoogleCloudMlV1beta1ListModelsResponse].
|
| + *
|
| + * 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<GoogleCloudMlV1beta1ListModelsResponse> list(core.String parent, {core.int pageSize, 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 (parent == null) {
|
| + throw new core.ArgumentError("Parameter parent is required.");
|
| + }
|
| + if (pageSize != null) {
|
| + _queryParams["pageSize"] = ["${pageSize}"];
|
| + }
|
| + if (pageToken != null) {
|
| + _queryParams["pageToken"] = [pageToken];
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/models';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleCloudMlV1beta1ListModelsResponse.fromJson(data));
|
| + }
|
| +
|
| +}
|
| +
|
| +
|
| +class ProjectsModelsVersionsResourceApi {
|
| + final commons.ApiRequester _requester;
|
| +
|
| + ProjectsModelsVersionsResourceApi(commons.ApiRequester client) :
|
| + _requester = client;
|
| +
|
| + /**
|
| + * Creates a new version of a model from a trained TensorFlow model.
|
| + *
|
| + * If the version created in the cloud by this call is the first deployed
|
| + * version of the specified model, it will be made the default version of the
|
| + * model. When you add a version to a model that already has one or more
|
| + * versions, the default version does not automatically change. If you want a
|
| + * new version to be the default, you must call
|
| + * [projects.models.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).
|
| + *
|
| + * [request] - The metadata request object.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [parent] - Required. The name of the model.
|
| + *
|
| + * Authorization: requires `Editor` role on the parent project.
|
| + * Value must have pattern "^projects/[^/]+/models/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleLongrunningOperation].
|
| + *
|
| + * 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<GoogleLongrunningOperation> create(GoogleCloudMlV1beta1Version request, core.String parent) {
|
| + var _url = null;
|
| + var _queryParams = new core.Map();
|
| + var _uploadMedia = null;
|
| + var _uploadOptions = null;
|
| + var _downloadOptions = commons.DownloadOptions.Metadata;
|
| + var _body = null;
|
| +
|
| + if (request != null) {
|
| + _body = convert.JSON.encode((request).toJson());
|
| + }
|
| + if (parent == null) {
|
| + throw new core.ArgumentError("Parameter parent is required.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/versions';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleLongrunningOperation.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Deletes a model version.
|
| + *
|
| + * Each model can have multiple versions deployed and in use at any given
|
| + * time. Use this method to remove a single version.
|
| + *
|
| + * Note: You cannot delete the version that is set as the default version
|
| + * of the model unless it is the only remaining version.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [name] - Required. The name of the version. You can get the names of all
|
| + * the
|
| + * versions of a model by calling
|
| + * [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
|
| + *
|
| + * Authorization: requires `Editor` role on the parent project.
|
| + * Value must have pattern "^projects/[^/]+/models/[^/]+/versions/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleLongrunningOperation].
|
| + *
|
| + * 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<GoogleLongrunningOperation> delete(core.String name) {
|
| + 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.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name');
|
| +
|
| + var _response = _requester.request(_url,
|
| + "DELETE",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleLongrunningOperation.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Gets information about a model version.
|
| + *
|
| + * Models can have multiple versions. You can call
|
| + * [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list)
|
| + * to get the same information that this method returns for all of the
|
| + * versions of a model.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [name] - Required. The name of the version.
|
| + *
|
| + * Authorization: requires `Viewer` role on the parent project.
|
| + * Value must have pattern "^projects/[^/]+/models/[^/]+/versions/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleCloudMlV1beta1Version].
|
| + *
|
| + * 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<GoogleCloudMlV1beta1Version> get(core.String name) {
|
| + 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.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name');
|
| +
|
| + var _response = _requester.request(_url,
|
| + "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleCloudMlV1beta1Version.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Gets basic information about all the versions of a model.
|
| + *
|
| + * If you expect that a model has a lot of versions, or if you need to handle
|
| + * only a limited number of results at a time, you can request that the list
|
| + * be retrieved in batches (called pages):
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [parent] - Required. The name of the model for which to list the version.
|
| + *
|
| + * Authorization: requires `Viewer` role on the parent project.
|
| + * Value must have pattern "^projects/[^/]+/models/[^/]+$".
|
| + *
|
| + * [pageSize] - Optional. The number of versions 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.
|
| + *
|
| + * [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.
|
| + *
|
| + * Completes with a [GoogleCloudMlV1beta1ListVersionsResponse].
|
| + *
|
| + * 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<GoogleCloudMlV1beta1ListVersionsResponse> list(core.String parent, {core.int pageSize, 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 (parent == null) {
|
| + throw new core.ArgumentError("Parameter parent is required.");
|
| + }
|
| + if (pageSize != null) {
|
| + _queryParams["pageSize"] = ["${pageSize}"];
|
| + }
|
| + if (pageToken != null) {
|
| + _queryParams["pageToken"] = [pageToken];
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/versions';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleCloudMlV1beta1ListVersionsResponse.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Designates a version to be the default for the model.
|
| + *
|
| + * The default version is used for prediction requests made against the model
|
| + * that don't specify a version.
|
| + *
|
| + * The first version to be created for a model is automatically set as the
|
| + * default. You must make any subsequent changes to the default version
|
| + * setting manually using this method.
|
| + *
|
| + * [request] - The metadata request object.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [name] - Required. The name of the version to make the default for the
|
| + * model. You
|
| + * can get the names of all the versions of a model by calling
|
| + * [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
|
| + *
|
| + * Authorization: requires `Editor` role on the parent project.
|
| + * Value must have pattern "^projects/[^/]+/models/[^/]+/versions/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleCloudMlV1beta1Version].
|
| + *
|
| + * 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<GoogleCloudMlV1beta1Version> setDefault(GoogleCloudMlV1beta1SetDefaultVersionRequest request, core.String name) {
|
| + var _url = null;
|
| + var _queryParams = new core.Map();
|
| + var _uploadMedia = null;
|
| + var _uploadOptions = null;
|
| + var _downloadOptions = commons.DownloadOptions.Metadata;
|
| + var _body = null;
|
| +
|
| + if (request != null) {
|
| + _body = convert.JSON.encode((request).toJson());
|
| + }
|
| + if (name == null) {
|
| + throw new core.ArgumentError("Parameter name is required.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name') + ':setDefault';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleCloudMlV1beta1Version.fromJson(data));
|
| + }
|
| +
|
| +}
|
| +
|
| +
|
| +class ProjectsOperationsResourceApi {
|
| + final commons.ApiRequester _requester;
|
| +
|
| + ProjectsOperationsResourceApi(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 parameters:
|
| + *
|
| + * [name] - The name of the operation resource to be cancelled.
|
| + * Value must have pattern "^projects/[^/]+/operations/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleProtobufEmpty].
|
| + *
|
| + * 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<GoogleProtobufEmpty> cancel(core.String name) {
|
| + 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.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name') + ':cancel';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleProtobufEmpty.fromJson(data));
|
| + }
|
| +
|
| + /**
|
| + * Deletes a long-running operation. This method indicates that the client is
|
| + * no longer interested in the operation result. It does not cancel the
|
| + * operation. If the server doesn't support this method, it returns
|
| + * `google.rpc.Code.UNIMPLEMENTED`.
|
| + *
|
| + * Request parameters:
|
| + *
|
| + * [name] - The name of the operation resource to be deleted.
|
| + * Value must have pattern "^projects/[^/]+/operations/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleProtobufEmpty].
|
| + *
|
| + * 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<GoogleProtobufEmpty> delete(core.String name) {
|
| + 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.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name');
|
| +
|
| + var _response = _requester.request(_url,
|
| + "DELETE",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleProtobufEmpty.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 "^projects/[^/]+/operations/[^/]+$".
|
| + *
|
| + * Completes with a [GoogleLongrunningOperation].
|
| + *
|
| + * 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<GoogleLongrunningOperation> get(core.String name) {
|
| + 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.");
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name');
|
| +
|
| + var _response = _requester.request(_url,
|
| + "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleLongrunningOperation.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 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/[^/]+$".
|
| + *
|
| + * [pageSize] - The standard list page size.
|
| + *
|
| + * [filter] - The standard list filter.
|
| + *
|
| + * [pageToken] - The standard list page token.
|
| + *
|
| + * 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.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 (name == null) {
|
| + throw new core.ArgumentError("Parameter name is required.");
|
| + }
|
| + if (pageSize != null) {
|
| + _queryParams["pageSize"] = ["${pageSize}"];
|
| + }
|
| + if (filter != null) {
|
| + _queryParams["filter"] = [filter];
|
| + }
|
| + if (pageToken != null) {
|
| + _queryParams["pageToken"] = [pageToken];
|
| + }
|
| +
|
| + _url = 'v1beta1/' + commons.Escaper.ecapeVariableReserved('$name') + '/operations';
|
| +
|
| + var _response = _requester.request(_url,
|
| + "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response.then((data) => new GoogleLongrunningListOperationsResponse.fromJson(data));
|
| + }
|
| +
|
| +}
|
| +
|
| +
|
| +
|
| +/**
|
| + * Message that represents an arbitrary HTTP body. It should only be used for
|
| + * payload formats that can't be represented as JSON, such as raw binary or
|
| + * an HTML page.
|
| + *
|
| + *
|
| + * This message can be used both in streaming and non-streaming API methods in
|
| + * the request as well as the response.
|
| + *
|
| + * It can be used as a top-level request field, which is convenient if one
|
| + * wants to extract parameters from either the URL or HTTP template into the
|
| + * request fields and also want access to the raw HTTP body.
|
| + *
|
| + * Example:
|
| + *
|
| + * message GetResourceRequest {
|
| + * // A unique request id.
|
| + * string request_id = 1;
|
| + *
|
| + * // The raw HTTP body is bound to this field.
|
| + * google.api.HttpBody http_body = 2;
|
| + * }
|
| + *
|
| + * service ResourceService {
|
| + * rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
|
| + * rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);
|
| + * }
|
| + *
|
| + * Example with streaming methods:
|
| + *
|
| + * service CaldavService {
|
| + * rpc GetCalendar(stream google.api.HttpBody)
|
| + * returns (stream google.api.HttpBody);
|
| + * rpc UpdateCalendar(stream google.api.HttpBody)
|
| + * returns (stream google.api.HttpBody);
|
| + * }
|
| + *
|
| + * Use of this type only changes how the request and response bodies are
|
| + * handled, all other features will continue to work unchanged.
|
| + */
|
| +class GoogleApiHttpBody {
|
| + /**
|
| + * The HTTP Content-Type string representing the content type of the body.
|
| + */
|
| + core.String contentType;
|
| + /** HTTP body binary data. */
|
| + core.String data;
|
| + core.List<core.int> get dataAsBytes {
|
| + return convert.BASE64.decode(data);
|
| + }
|
| +
|
| + void set dataAsBytes(core.List<core.int> _bytes) {
|
| + data = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| + }
|
| +
|
| + GoogleApiHttpBody();
|
| +
|
| + GoogleApiHttpBody.fromJson(core.Map _json) {
|
| + if (_json.containsKey("contentType")) {
|
| + contentType = _json["contentType"];
|
| + }
|
| + if (_json.containsKey("data")) {
|
| + data = _json["data"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (contentType != null) {
|
| + _json["contentType"] = contentType;
|
| + }
|
| + if (data != null) {
|
| + _json["data"] = data;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** An observed value of a metric. */
|
| +class GoogleCloudMlV1beta1HyperparameterOutputHyperparameterMetric {
|
| + /** The objective value at this training step. */
|
| + core.double objectiveValue;
|
| + /** The global training step for this metric. */
|
| + core.String trainingStep;
|
| +
|
| + GoogleCloudMlV1beta1HyperparameterOutputHyperparameterMetric();
|
| +
|
| + GoogleCloudMlV1beta1HyperparameterOutputHyperparameterMetric.fromJson(core.Map _json) {
|
| + if (_json.containsKey("objectiveValue")) {
|
| + objectiveValue = _json["objectiveValue"];
|
| + }
|
| + if (_json.containsKey("trainingStep")) {
|
| + trainingStep = _json["trainingStep"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (objectiveValue != null) {
|
| + _json["objectiveValue"] = objectiveValue;
|
| + }
|
| + if (trainingStep != null) {
|
| + _json["trainingStep"] = trainingStep;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Request message for the CancelJob method. */
|
| +class GoogleCloudMlV1beta1CancelJobRequest {
|
| +
|
| + GoogleCloudMlV1beta1CancelJobRequest();
|
| +
|
| + GoogleCloudMlV1beta1CancelJobRequest.fromJson(core.Map _json) {
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Returns service account information associated with a project. */
|
| +class GoogleCloudMlV1beta1GetConfigResponse {
|
| + /** The service account Cloud ML uses to access resources in the project. */
|
| + core.String serviceAccount;
|
| + /** The project number for `service_account`. */
|
| + core.String serviceAccountProject;
|
| +
|
| + GoogleCloudMlV1beta1GetConfigResponse();
|
| +
|
| + GoogleCloudMlV1beta1GetConfigResponse.fromJson(core.Map _json) {
|
| + if (_json.containsKey("serviceAccount")) {
|
| + serviceAccount = _json["serviceAccount"];
|
| + }
|
| + if (_json.containsKey("serviceAccountProject")) {
|
| + serviceAccountProject = _json["serviceAccountProject"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (serviceAccount != null) {
|
| + _json["serviceAccount"] = serviceAccount;
|
| + }
|
| + if (serviceAccountProject != null) {
|
| + _json["serviceAccountProject"] = serviceAccountProject;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/**
|
| + * Represents the result of a single hyperparameter tuning trial from a
|
| + * training job. The TrainingOutput object that is returned on successful
|
| + * completion of a training job with hyperparameter tuning includes a list
|
| + * of HyperparameterOutput objects, one for each successful trial.
|
| + */
|
| +class GoogleCloudMlV1beta1HyperparameterOutput {
|
| + /** All recorded object metrics for this trial. */
|
| + core.List<GoogleCloudMlV1beta1HyperparameterOutputHyperparameterMetric> allMetrics;
|
| + /** The final objective metric seen for this trial. */
|
| + GoogleCloudMlV1beta1HyperparameterOutputHyperparameterMetric finalMetric;
|
| + /** The hyperparameters given to this trial. */
|
| + core.Map<core.String, core.String> hyperparameters;
|
| + /** The trial id for these results. */
|
| + core.String trialId;
|
| +
|
| + GoogleCloudMlV1beta1HyperparameterOutput();
|
| +
|
| + GoogleCloudMlV1beta1HyperparameterOutput.fromJson(core.Map _json) {
|
| + if (_json.containsKey("allMetrics")) {
|
| + allMetrics = _json["allMetrics"].map((value) => new GoogleCloudMlV1beta1HyperparameterOutputHyperparameterMetric.fromJson(value)).toList();
|
| + }
|
| + if (_json.containsKey("finalMetric")) {
|
| + finalMetric = new GoogleCloudMlV1beta1HyperparameterOutputHyperparameterMetric.fromJson(_json["finalMetric"]);
|
| + }
|
| + if (_json.containsKey("hyperparameters")) {
|
| + hyperparameters = _json["hyperparameters"];
|
| + }
|
| + if (_json.containsKey("trialId")) {
|
| + trialId = _json["trialId"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (allMetrics != null) {
|
| + _json["allMetrics"] = allMetrics.map((value) => (value).toJson()).toList();
|
| + }
|
| + if (finalMetric != null) {
|
| + _json["finalMetric"] = (finalMetric).toJson();
|
| + }
|
| + if (hyperparameters != null) {
|
| + _json["hyperparameters"] = hyperparameters;
|
| + }
|
| + if (trialId != null) {
|
| + _json["trialId"] = trialId;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Represents a set of hyperparameters to optimize. */
|
| +class GoogleCloudMlV1beta1HyperparameterSpec {
|
| + /**
|
| + * Required. The type of goal to use for tuning. Available types are
|
| + * `MAXIMIZE` and `MINIMIZE`.
|
| + *
|
| + * Defaults to `MAXIMIZE`.
|
| + * Possible string values are:
|
| + * - "GOAL_TYPE_UNSPECIFIED" : Goal Type will default to maximize.
|
| + * - "MAXIMIZE" : Maximize the goal metric.
|
| + * - "MINIMIZE" : Minimize the goal metric.
|
| + */
|
| + core.String goal;
|
| + /**
|
| + * Optional. The number of training trials to run concurrently.
|
| + * You can reduce the time it takes to perform hyperparameter tuning by adding
|
| + * trials in parallel. However, each trail only benefits from the information
|
| + * gained in completed trials. That means that a trial does not get access to
|
| + * the results of trials running at the same time, which could reduce the
|
| + * quality of the overall optimization.
|
| + *
|
| + * Each trial will use the same scale tier and machine types.
|
| + *
|
| + * Defaults to one.
|
| + */
|
| + core.int maxParallelTrials;
|
| + /**
|
| + * Optional. How many training trials should be attempted to optimize
|
| + * the specified hyperparameters.
|
| + *
|
| + * Defaults to one.
|
| + */
|
| + core.int maxTrials;
|
| + /** Required. The set of parameters to tune. */
|
| + core.List<GoogleCloudMlV1beta1ParameterSpec> params;
|
| +
|
| + GoogleCloudMlV1beta1HyperparameterSpec();
|
| +
|
| + GoogleCloudMlV1beta1HyperparameterSpec.fromJson(core.Map _json) {
|
| + if (_json.containsKey("goal")) {
|
| + goal = _json["goal"];
|
| + }
|
| + if (_json.containsKey("maxParallelTrials")) {
|
| + maxParallelTrials = _json["maxParallelTrials"];
|
| + }
|
| + if (_json.containsKey("maxTrials")) {
|
| + maxTrials = _json["maxTrials"];
|
| + }
|
| + if (_json.containsKey("params")) {
|
| + params = _json["params"].map((value) => new GoogleCloudMlV1beta1ParameterSpec.fromJson(value)).toList();
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (goal != null) {
|
| + _json["goal"] = goal;
|
| + }
|
| + if (maxParallelTrials != null) {
|
| + _json["maxParallelTrials"] = maxParallelTrials;
|
| + }
|
| + if (maxTrials != null) {
|
| + _json["maxTrials"] = maxTrials;
|
| + }
|
| + if (params != null) {
|
| + _json["params"] = params.map((value) => (value).toJson()).toList();
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Represents a training or prediction job. */
|
| +class GoogleCloudMlV1beta1Job {
|
| + /** Output only. When the job was created. */
|
| + core.String createTime;
|
| + /** Output only. When the job processing was completed. */
|
| + core.String endTime;
|
| + /** Output only. The details of a failure or a cancellation. */
|
| + core.String errorMessage;
|
| + /** Required. The user-specified id of the job. */
|
| + core.String jobId;
|
| + /** Input parameters to create a prediction job. */
|
| + GoogleCloudMlV1beta1PredictionInput predictionInput;
|
| + /** The current prediction job result. */
|
| + GoogleCloudMlV1beta1PredictionOutput predictionOutput;
|
| + /** Output only. When the job processing was started. */
|
| + core.String startTime;
|
| + /**
|
| + * Output only. The detailed state of a job.
|
| + * Possible string values are:
|
| + * - "STATE_UNSPECIFIED" : The job state is unspecified.
|
| + * - "QUEUED" : The job has been just created and processing has not yet
|
| + * begun.
|
| + * - "PREPARING" : The service is preparing to run the job.
|
| + * - "RUNNING" : The job is in progress.
|
| + * - "SUCCEEDED" : The job completed successfully.
|
| + * - "FAILED" : The job failed.
|
| + * `error_message` should contain the details of the failure.
|
| + * - "CANCELLING" : The job is being cancelled.
|
| + * `error_message` should describe the reason for the cancellation.
|
| + * - "CANCELLED" : The job has been cancelled.
|
| + * `error_message` should describe the reason for the cancellation.
|
| + */
|
| + core.String state;
|
| + /** Input parameters to create a training job. */
|
| + GoogleCloudMlV1beta1TrainingInput trainingInput;
|
| + /** The current training job result. */
|
| + GoogleCloudMlV1beta1TrainingOutput trainingOutput;
|
| +
|
| + GoogleCloudMlV1beta1Job();
|
| +
|
| + GoogleCloudMlV1beta1Job.fromJson(core.Map _json) {
|
| + if (_json.containsKey("createTime")) {
|
| + createTime = _json["createTime"];
|
| + }
|
| + if (_json.containsKey("endTime")) {
|
| + endTime = _json["endTime"];
|
| + }
|
| + if (_json.containsKey("errorMessage")) {
|
| + errorMessage = _json["errorMessage"];
|
| + }
|
| + if (_json.containsKey("jobId")) {
|
| + jobId = _json["jobId"];
|
| + }
|
| + if (_json.containsKey("predictionInput")) {
|
| + predictionInput = new GoogleCloudMlV1beta1PredictionInput.fromJson(_json["predictionInput"]);
|
| + }
|
| + if (_json.containsKey("predictionOutput")) {
|
| + predictionOutput = new GoogleCloudMlV1beta1PredictionOutput.fromJson(_json["predictionOutput"]);
|
| + }
|
| + if (_json.containsKey("startTime")) {
|
| + startTime = _json["startTime"];
|
| + }
|
| + if (_json.containsKey("state")) {
|
| + state = _json["state"];
|
| + }
|
| + if (_json.containsKey("trainingInput")) {
|
| + trainingInput = new GoogleCloudMlV1beta1TrainingInput.fromJson(_json["trainingInput"]);
|
| + }
|
| + if (_json.containsKey("trainingOutput")) {
|
| + trainingOutput = new GoogleCloudMlV1beta1TrainingOutput.fromJson(_json["trainingOutput"]);
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (createTime != null) {
|
| + _json["createTime"] = createTime;
|
| + }
|
| + if (endTime != null) {
|
| + _json["endTime"] = endTime;
|
| + }
|
| + if (errorMessage != null) {
|
| + _json["errorMessage"] = errorMessage;
|
| + }
|
| + if (jobId != null) {
|
| + _json["jobId"] = jobId;
|
| + }
|
| + if (predictionInput != null) {
|
| + _json["predictionInput"] = (predictionInput).toJson();
|
| + }
|
| + if (predictionOutput != null) {
|
| + _json["predictionOutput"] = (predictionOutput).toJson();
|
| + }
|
| + if (startTime != null) {
|
| + _json["startTime"] = startTime;
|
| + }
|
| + if (state != null) {
|
| + _json["state"] = state;
|
| + }
|
| + if (trainingInput != null) {
|
| + _json["trainingInput"] = (trainingInput).toJson();
|
| + }
|
| + if (trainingOutput != null) {
|
| + _json["trainingOutput"] = (trainingOutput).toJson();
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Response message for the ListJobs method. */
|
| +class GoogleCloudMlV1beta1ListJobsResponse {
|
| + /** The list of jobs. */
|
| + core.List<GoogleCloudMlV1beta1Job> jobs;
|
| + /**
|
| + * Optional. Pass this token as the `page_token` field of the request for a
|
| + * subsequent call.
|
| + */
|
| + core.String nextPageToken;
|
| +
|
| + GoogleCloudMlV1beta1ListJobsResponse();
|
| +
|
| + GoogleCloudMlV1beta1ListJobsResponse.fromJson(core.Map _json) {
|
| + if (_json.containsKey("jobs")) {
|
| + jobs = _json["jobs"].map((value) => new GoogleCloudMlV1beta1Job.fromJson(value)).toList();
|
| + }
|
| + if (_json.containsKey("nextPageToken")) {
|
| + nextPageToken = _json["nextPageToken"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (jobs != null) {
|
| + _json["jobs"] = jobs.map((value) => (value).toJson()).toList();
|
| + }
|
| + if (nextPageToken != null) {
|
| + _json["nextPageToken"] = nextPageToken;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Response message for the ListModels method. */
|
| +class GoogleCloudMlV1beta1ListModelsResponse {
|
| + /** The list of models. */
|
| + core.List<GoogleCloudMlV1beta1Model> models;
|
| + /**
|
| + * Optional. Pass this token as the `page_token` field of the request for a
|
| + * subsequent call.
|
| + */
|
| + core.String nextPageToken;
|
| +
|
| + GoogleCloudMlV1beta1ListModelsResponse();
|
| +
|
| + GoogleCloudMlV1beta1ListModelsResponse.fromJson(core.Map _json) {
|
| + if (_json.containsKey("models")) {
|
| + models = _json["models"].map((value) => new GoogleCloudMlV1beta1Model.fromJson(value)).toList();
|
| + }
|
| + if (_json.containsKey("nextPageToken")) {
|
| + nextPageToken = _json["nextPageToken"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (models != null) {
|
| + _json["models"] = models.map((value) => (value).toJson()).toList();
|
| + }
|
| + if (nextPageToken != null) {
|
| + _json["nextPageToken"] = nextPageToken;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Response message for the ListVersions method. */
|
| +class GoogleCloudMlV1beta1ListVersionsResponse {
|
| + /**
|
| + * Optional. Pass this token as the `page_token` field of the request for a
|
| + * subsequent call.
|
| + */
|
| + core.String nextPageToken;
|
| + /** The list of versions. */
|
| + core.List<GoogleCloudMlV1beta1Version> versions;
|
| +
|
| + GoogleCloudMlV1beta1ListVersionsResponse();
|
| +
|
| + GoogleCloudMlV1beta1ListVersionsResponse.fromJson(core.Map _json) {
|
| + if (_json.containsKey("nextPageToken")) {
|
| + nextPageToken = _json["nextPageToken"];
|
| + }
|
| + if (_json.containsKey("versions")) {
|
| + versions = _json["versions"].map((value) => new GoogleCloudMlV1beta1Version.fromJson(value)).toList();
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (nextPageToken != null) {
|
| + _json["nextPageToken"] = nextPageToken;
|
| + }
|
| + if (versions != null) {
|
| + _json["versions"] = versions.map((value) => (value).toJson()).toList();
|
| + }
|
| + 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
|
| + * 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).
|
| + */
|
| + GoogleCloudMlV1beta1Version defaultVersion;
|
| + /** Optional. The description specified for the model when it was created. */
|
| + core.String description;
|
| + /**
|
| + * Required. The name specified for the model when it was created.
|
| + *
|
| + * The model name must be unique within the project it is created in.
|
| + */
|
| + core.String name;
|
| +
|
| + GoogleCloudMlV1beta1Model();
|
| +
|
| + GoogleCloudMlV1beta1Model.fromJson(core.Map _json) {
|
| + if (_json.containsKey("defaultVersion")) {
|
| + defaultVersion = new GoogleCloudMlV1beta1Version.fromJson(_json["defaultVersion"]);
|
| + }
|
| + if (_json.containsKey("description")) {
|
| + description = _json["description"];
|
| + }
|
| + if (_json.containsKey("name")) {
|
| + name = _json["name"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (defaultVersion != null) {
|
| + _json["defaultVersion"] = (defaultVersion).toJson();
|
| + }
|
| + if (description != null) {
|
| + _json["description"] = description;
|
| + }
|
| + if (name != null) {
|
| + _json["name"] = name;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Represents the metadata of the long-running operation. */
|
| +class GoogleCloudMlV1beta1OperationMetadata {
|
| + /** 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;
|
| + /**
|
| + * The operation type.
|
| + * Possible string values are:
|
| + * - "OPERATION_TYPE_UNSPECIFIED" : Unspecified operation type.
|
| + * - "CREATE_VERSION" : An operation to create a new version.
|
| + * - "DELETE_VERSION" : An operation to delete an existing version.
|
| + * - "DELETE_MODEL" : An operation to delete an existing model.
|
| + */
|
| + core.String operationType;
|
| + /** The time operation processing started. */
|
| + core.String startTime;
|
| + /** Contains the version associated with the operation. */
|
| + GoogleCloudMlV1beta1Version version;
|
| +
|
| + GoogleCloudMlV1beta1OperationMetadata();
|
| +
|
| + GoogleCloudMlV1beta1OperationMetadata.fromJson(core.Map _json) {
|
| + if (_json.containsKey("createTime")) {
|
| + createTime = _json["createTime"];
|
| + }
|
| + if (_json.containsKey("endTime")) {
|
| + endTime = _json["endTime"];
|
| + }
|
| + if (_json.containsKey("isCancellationRequested")) {
|
| + isCancellationRequested = _json["isCancellationRequested"];
|
| + }
|
| + if (_json.containsKey("modelName")) {
|
| + modelName = _json["modelName"];
|
| + }
|
| + if (_json.containsKey("operationType")) {
|
| + operationType = _json["operationType"];
|
| + }
|
| + if (_json.containsKey("startTime")) {
|
| + startTime = _json["startTime"];
|
| + }
|
| + if (_json.containsKey("version")) {
|
| + version = new GoogleCloudMlV1beta1Version.fromJson(_json["version"]);
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (createTime != null) {
|
| + _json["createTime"] = createTime;
|
| + }
|
| + if (endTime != null) {
|
| + _json["endTime"] = endTime;
|
| + }
|
| + if (isCancellationRequested != null) {
|
| + _json["isCancellationRequested"] = isCancellationRequested;
|
| + }
|
| + if (modelName != null) {
|
| + _json["modelName"] = modelName;
|
| + }
|
| + if (operationType != null) {
|
| + _json["operationType"] = operationType;
|
| + }
|
| + if (startTime != null) {
|
| + _json["startTime"] = startTime;
|
| + }
|
| + if (version != null) {
|
| + _json["version"] = (version).toJson();
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Represents a single hyperparameter to optimize. */
|
| +class GoogleCloudMlV1beta1ParameterSpec {
|
| + /** Required if type is `CATEGORICAL`. The list of possible categories. */
|
| + core.List<core.String> categoricalValues;
|
| + /**
|
| + * Required if type is `DISCRETE`.
|
| + * A list of feasible points.
|
| + * The list should be in strictly increasing order. For instance, this
|
| + * parameter might have possible settings of 1.5, 2.5, and 4.0. This list
|
| + * should not contain more than 1,000 values.
|
| + */
|
| + core.List<core.double> discreteValues;
|
| + /**
|
| + * Required if typeis `DOUBLE` or `INTEGER`. This field
|
| + * should be unset if type is `CATEGORICAL`. This value should be integers if
|
| + * type is `INTEGER`.
|
| + */
|
| + core.double maxValue;
|
| + /**
|
| + * Required if type is `DOUBLE` or `INTEGER`. This field
|
| + * should be unset if type is `CATEGORICAL`. This value should be integers if
|
| + * type is INTEGER.
|
| + */
|
| + core.double minValue;
|
| + /**
|
| + * Required. The parameter name must be unique amongst all ParameterConfigs in
|
| + * a HyperparameterSpec message. E.g., "learning_rate".
|
| + */
|
| + core.String parameterName;
|
| + /**
|
| + * Optional. How the parameter should be scaled to the hypercube.
|
| + * Leave unset for categorical parameters.
|
| + * Some kind of scaling is strongly recommended for real or integral
|
| + * parameters (e.g., `UNIT_LINEAR_SCALE`).
|
| + * Possible string values are:
|
| + * - "NONE" : By default, no scaling is applied.
|
| + * - "UNIT_LINEAR_SCALE" : Scales the feasible space to (0, 1) linearly.
|
| + * - "UNIT_LOG_SCALE" : Scales the feasible space logarithmically to (0, 1).
|
| + * The entire feasible
|
| + * space must be strictly positive.
|
| + * - "UNIT_REVERSE_LOG_SCALE" : Scales the feasible space "reverse"
|
| + * logarithmically to (0, 1). The result
|
| + * is that values close to the top of the feasible space are spread out more
|
| + * than points near the bottom. The entire feasible space must be strictly
|
| + * positive.
|
| + */
|
| + core.String scaleType;
|
| + /**
|
| + * Required. The type of the parameter.
|
| + * Possible string values are:
|
| + * - "PARAMETER_TYPE_UNSPECIFIED" : You must specify a valid type. Using this
|
| + * unspecified type will result in
|
| + * an error.
|
| + * - "DOUBLE" : Type for real-valued parameters.
|
| + * - "INTEGER" : Type for integral parameters.
|
| + * - "CATEGORICAL" : The parameter is categorical, with a value chosen from
|
| + * the categories
|
| + * field.
|
| + * - "DISCRETE" : The parameter is real valued, with a fixed set of feasible
|
| + * points. If
|
| + * `type==DISCRETE`, feasible_points must be provided, and
|
| + * {`min_value`, `max_value`} will be ignored.
|
| + */
|
| + core.String type;
|
| +
|
| + GoogleCloudMlV1beta1ParameterSpec();
|
| +
|
| + GoogleCloudMlV1beta1ParameterSpec.fromJson(core.Map _json) {
|
| + if (_json.containsKey("categoricalValues")) {
|
| + categoricalValues = _json["categoricalValues"];
|
| + }
|
| + if (_json.containsKey("discreteValues")) {
|
| + discreteValues = _json["discreteValues"];
|
| + }
|
| + if (_json.containsKey("maxValue")) {
|
| + maxValue = _json["maxValue"];
|
| + }
|
| + if (_json.containsKey("minValue")) {
|
| + minValue = _json["minValue"];
|
| + }
|
| + if (_json.containsKey("parameterName")) {
|
| + parameterName = _json["parameterName"];
|
| + }
|
| + if (_json.containsKey("scaleType")) {
|
| + scaleType = _json["scaleType"];
|
| + }
|
| + if (_json.containsKey("type")) {
|
| + type = _json["type"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (categoricalValues != null) {
|
| + _json["categoricalValues"] = categoricalValues;
|
| + }
|
| + if (discreteValues != null) {
|
| + _json["discreteValues"] = discreteValues;
|
| + }
|
| + if (maxValue != null) {
|
| + _json["maxValue"] = maxValue;
|
| + }
|
| + if (minValue != null) {
|
| + _json["minValue"] = minValue;
|
| + }
|
| + if (parameterName != null) {
|
| + _json["parameterName"] = parameterName;
|
| + }
|
| + if (scaleType != null) {
|
| + _json["scaleType"] = scaleType;
|
| + }
|
| + if (type != null) {
|
| + _json["type"] = type;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/**
|
| + * Request for predictions to be issued against a trained model.
|
| + *
|
| + * The body of the request is a single JSON object with a single top-level
|
| + * field:
|
| + *
|
| + * <dl>
|
| + * <dt>instances</dt>
|
| + * <dd>A JSON array containing values representing the instances to use for
|
| + * prediction.</dd>
|
| + * </dl>
|
| + *
|
| + * The structure of each element of the instances list is determined by your
|
| + * model's input definition. Instances can include named inputs or can contain
|
| + * only unlabeled values.
|
| + *
|
| + * Most data does not include named inputs. Some instances will be simple
|
| + * JSON values (boolean, number, or string). However, instances are often lists
|
| + * of simple values, or complex nested lists. Here are some examples of request
|
| + * bodies:
|
| + *
|
| + * CSV data with each row encoded as a string value:
|
| + * <pre>
|
| + * {"instances": ["1.0,true,\\"x\\"", "-2.0,false,\\"y\\""]}
|
| + * </pre>
|
| + * Plain text:
|
| + * <pre>
|
| + * {"instances": ["the quick brown fox", "la bruja le dio"]}
|
| + * </pre>
|
| + * Sentences encoded as lists of words (vectors of strings):
|
| + * <pre>
|
| + * {"instances": [["the","quick","brown"], ["la","bruja","le"]]}
|
| + * </pre>
|
| + * Floating point scalar values:
|
| + * <pre>
|
| + * {"instances": [0.0, 1.1, 2.2]}
|
| + * </pre>
|
| + * Vectors of integers:
|
| + * <pre>
|
| + * {"instances": [[0, 1, 2], [3, 4, 5],...]}
|
| + * </pre>
|
| + * Tensors (in this case, two-dimensional tensors):
|
| + * <pre>
|
| + * {"instances": [[[0, 1, 2], [3, 4, 5]], ...]}
|
| + * </pre>
|
| + * Images represented as a three-dimensional list. In this encoding scheme the
|
| + * first two dimensions represent the rows and columns of the image, and the
|
| + * third contains the R, G, and B values for each pixel.
|
| + * <pre>
|
| + * {"instances": [[[[138, 30, 66], [130, 20, 56], ...]]]]}
|
| + * </pre>
|
| + * Data must be encoded as UTF-8. If your data uses another character encoding,
|
| + * you must base64 encode the data and mark it as binary. To mark a JSON string
|
| + * as binary, replace it with an object with a single attribute named `b`:
|
| + * <pre>{"b": "..."} </pre>
|
| + * For example:
|
| + *
|
| + * Two Serialized tf.Examples (fake data, for illustrative purposes only):
|
| + * <pre>
|
| + * {"instances": [{"b64": "X5ad6u"}, {"b64": "IA9j4nx"}]}
|
| + * </pre>
|
| + * Two JPEG image byte strings (fake data, for illustrative purposes only):
|
| + * <pre>
|
| + * {"instances": [{"b64": "ASa8asdf"}, {"b64": "JLK7ljk3"}]}
|
| + * </pre>
|
| + * If your data includes named references, format each instance as a JSON object
|
| + * with the named references as the keys:
|
| + *
|
| + * JSON input data to be preprocessed:
|
| + * <pre>
|
| + * {"instances": [{"a": 1.0, "b": true, "c": "x"},
|
| + * {"a": -2.0, "b": false, "c": "y"}]}
|
| + * </pre>
|
| + * Some models have an underlying TensorFlow graph that accepts multiple input
|
| + * tensors. In this case, you should use the names of JSON name/value pairs to
|
| + * identify the input tensors, as shown in the following exmaples:
|
| + *
|
| + * For a graph with input tensor aliases "tag" (string) and "image"
|
| + * (base64-encoded string):
|
| + * <pre>
|
| + * {"instances": [{"tag": "beach", "image": {"b64": "ASa8asdf"}},
|
| + * {"tag": "car", "image": {"b64": "JLK7ljk3"}}]}
|
| + * </pre>
|
| + * For a graph with input tensor aliases "tag" (string) and "image"
|
| + * (3-dimensional array of 8-bit ints):
|
| + * <pre>
|
| + * {"instances": [{"tag": "beach", "image": [[[263, 1, 10], [262, 2, 11],
|
| + * ...]]},
|
| + * {"tag": "car", "image": [[[10, 11, 24], [23, 10, 15], ...]]}]}
|
| + * </pre>
|
| + * If the call is successful, the response body will contain one prediction
|
| + * entry per instance in the request body. If prediction fails for any
|
| + * instance, the response body will contain no predictions and will contian
|
| + * a single error entry instead.
|
| + */
|
| +class GoogleCloudMlV1beta1PredictRequest {
|
| + /**
|
| + *
|
| + * Required. The prediction request body.
|
| + */
|
| + GoogleApiHttpBody httpBody;
|
| +
|
| + GoogleCloudMlV1beta1PredictRequest();
|
| +
|
| + GoogleCloudMlV1beta1PredictRequest.fromJson(core.Map _json) {
|
| + if (_json.containsKey("httpBody")) {
|
| + httpBody = new GoogleApiHttpBody.fromJson(_json["httpBody"]);
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (httpBody != null) {
|
| + _json["httpBody"] = (httpBody).toJson();
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Represents input parameters for a prediction job. */
|
| +class GoogleCloudMlV1beta1PredictionInput {
|
| + /**
|
| + * Required. The format of the input data files.
|
| + * Possible string values are:
|
| + * - "DATA_FORMAT_UNSPECIFIED" : Unspecified format.
|
| + * - "TEXT" : The source file is a text file with instances separated by the
|
| + * new-line character.
|
| + * - "TF_RECORD" : The source file is a TFRecord file.
|
| + * - "TF_RECORD_GZIP" : The source file is a GZIP-compressed TFRecord file.
|
| + */
|
| + core.String dataFormat;
|
| + /**
|
| + * Required. The Google Cloud Storage location of the input data files.
|
| + * May contain wildcards.
|
| + */
|
| + core.List<core.String> inputPaths;
|
| + /**
|
| + * Optional. The maximum number of workers to be used for parallel processing.
|
| + * Defaults to 10 if not specified.
|
| + */
|
| + core.String maxWorkerCount;
|
| + /**
|
| + * Use this field if you want to use the default version for the specified
|
| + * model. The string must use the following format:
|
| + *
|
| + * `"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
|
| + */
|
| + core.String modelName;
|
| + /** Required. The output Google Cloud Storage location. */
|
| + core.String outputPath;
|
| + /**
|
| + * Required. The Google Compute Engine region to run the prediction job in.
|
| + */
|
| + core.String region;
|
| + /**
|
| + * 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;
|
| +
|
| + GoogleCloudMlV1beta1PredictionInput();
|
| +
|
| + GoogleCloudMlV1beta1PredictionInput.fromJson(core.Map _json) {
|
| + if (_json.containsKey("dataFormat")) {
|
| + dataFormat = _json["dataFormat"];
|
| + }
|
| + if (_json.containsKey("inputPaths")) {
|
| + inputPaths = _json["inputPaths"];
|
| + }
|
| + if (_json.containsKey("maxWorkerCount")) {
|
| + maxWorkerCount = _json["maxWorkerCount"];
|
| + }
|
| + if (_json.containsKey("modelName")) {
|
| + modelName = _json["modelName"];
|
| + }
|
| + if (_json.containsKey("outputPath")) {
|
| + outputPath = _json["outputPath"];
|
| + }
|
| + if (_json.containsKey("region")) {
|
| + region = _json["region"];
|
| + }
|
| + if (_json.containsKey("versionName")) {
|
| + versionName = _json["versionName"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (dataFormat != null) {
|
| + _json["dataFormat"] = dataFormat;
|
| + }
|
| + if (inputPaths != null) {
|
| + _json["inputPaths"] = inputPaths;
|
| + }
|
| + if (maxWorkerCount != null) {
|
| + _json["maxWorkerCount"] = maxWorkerCount;
|
| + }
|
| + if (modelName != null) {
|
| + _json["modelName"] = modelName;
|
| + }
|
| + if (outputPath != null) {
|
| + _json["outputPath"] = outputPath;
|
| + }
|
| + if (region != null) {
|
| + _json["region"] = region;
|
| + }
|
| + if (versionName != null) {
|
| + _json["versionName"] = versionName;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Represents results of a prediction job. */
|
| +class GoogleCloudMlV1beta1PredictionOutput {
|
| + /** The number of data instances which resulted in errors. */
|
| + core.String errorCount;
|
| + /**
|
| + * The output Google Cloud Storage location provided at the job creation time.
|
| + */
|
| + core.String outputPath;
|
| + /** The number of generated predictions. */
|
| + core.String predictionCount;
|
| +
|
| + GoogleCloudMlV1beta1PredictionOutput();
|
| +
|
| + GoogleCloudMlV1beta1PredictionOutput.fromJson(core.Map _json) {
|
| + if (_json.containsKey("errorCount")) {
|
| + errorCount = _json["errorCount"];
|
| + }
|
| + if (_json.containsKey("outputPath")) {
|
| + outputPath = _json["outputPath"];
|
| + }
|
| + if (_json.containsKey("predictionCount")) {
|
| + predictionCount = _json["predictionCount"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (errorCount != null) {
|
| + _json["errorCount"] = errorCount;
|
| + }
|
| + if (outputPath != null) {
|
| + _json["outputPath"] = outputPath;
|
| + }
|
| + if (predictionCount != null) {
|
| + _json["predictionCount"] = predictionCount;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Request message for the SetDefaultVersion request. */
|
| +class GoogleCloudMlV1beta1SetDefaultVersionRequest {
|
| +
|
| + GoogleCloudMlV1beta1SetDefaultVersionRequest();
|
| +
|
| + GoogleCloudMlV1beta1SetDefaultVersionRequest.fromJson(core.Map _json) {
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** 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. Specifies the type of virtual machine to use for your training
|
| + * job's master worker.
|
| + *
|
| + * The following types are supported:
|
| + *
|
| + * <dl>
|
| + * <dt>standard</dt>
|
| + * <dd>
|
| + * A basic machine configuration suitable for training simple models with
|
| + * small to moderate datasets.
|
| + * </dd>
|
| + * <dt>large_model</dt>
|
| + * <dd>
|
| + * A machine with a lot of memory, specially suited for parameter servers
|
| + * when your model is large (having many hidden layers or layers with very
|
| + * large numbers of nodes).
|
| + * </dd>
|
| + * <dt>complex_model_s</dt>
|
| + * <dd>
|
| + * A machine suitable for the master and workers of the cluster when your
|
| + * model requires more computation than the standard machine can handle
|
| + * satisfactorily.
|
| + * </dd>
|
| + * <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>
|
| + * </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;
|
| + /**
|
| + * Optional. The number of parameter server replicas to use for the training
|
| + * job. Each replica in the cluster will be of the type specified in
|
| + * `parameter_server_type`.
|
| + *
|
| + * This value can only be used when `scale_tier` is set to `CUSTOM`.If you
|
| + * set this value, you must also set `parameter_server_type`.
|
| + */
|
| + core.String parameterServerCount;
|
| + /**
|
| + * Optional. Specifies the type of virtual machine to use for your training
|
| + * job's parameter server.
|
| + *
|
| + * The supported values are the same as those described in the entry for
|
| + * `master_type`.
|
| + *
|
| + * This value must be present when `scaleTier` is set to `CUSTOM` and
|
| + * `parameter_server_count` is greater than zero.
|
| + */
|
| + core.String parameterServerType;
|
| + /** Required. The Python module name to run after installing the packages. */
|
| + core.String pythonModule;
|
| + /** Required. The Google Compute Engine region to run the training job in. */
|
| + core.String region;
|
| + /**
|
| + * 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.
|
| + * - "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
|
| + * workers to use. If you specify one or more workers, you _must_ also
|
| + * set `TrainingInput.workerType` to specify the type of machine to use
|
| + * for your worker nodes.
|
| + *
|
| + * * You _may_ set `TrainingInput.parameterServerCount` to specify the
|
| + * number of parameter servers to use. If you specify one or more
|
| + * parameter servers, you _must_ also set
|
| + * `TrainingInput.parameterServerType` to specify the type of machine to
|
| + * use for your parameter servers.
|
| + *
|
| + * Note that all of your workers must use the same machine type, which can
|
| + * be different from your parameter server type and master type. Your
|
| + * parameter servers must likewise use the same machine type, which can be
|
| + * different from your worker type and master type.
|
| + */
|
| + core.String scaleTier;
|
| + /**
|
| + * Optional. The number of worker replicas to use for the training job. Each
|
| + * replica in the cluster will be of the type specified in `worker_type`.
|
| + *
|
| + * This value can only be used when `scale_tier` is set to `CUSTOM`. If you
|
| + * set this value, you must also set `worker_type`.
|
| + */
|
| + core.String workerCount;
|
| + /**
|
| + * Optional. Specifies the type of virtual machine to use for your training
|
| + * job's worker nodes.
|
| + *
|
| + * The supported values are the same as those described in the entry for
|
| + * `masterType`.
|
| + *
|
| + * This value must be present when `scaleTier` is set to `CUSTOM` and
|
| + * `workerCount` is greater than zero.
|
| + */
|
| + core.String workerType;
|
| +
|
| + GoogleCloudMlV1beta1TrainingInput();
|
| +
|
| + GoogleCloudMlV1beta1TrainingInput.fromJson(core.Map _json) {
|
| + if (_json.containsKey("args")) {
|
| + args = _json["args"];
|
| + }
|
| + if (_json.containsKey("hyperparameters")) {
|
| + hyperparameters = new GoogleCloudMlV1beta1HyperparameterSpec.fromJson(_json["hyperparameters"]);
|
| + }
|
| + if (_json.containsKey("masterType")) {
|
| + masterType = _json["masterType"];
|
| + }
|
| + if (_json.containsKey("packageUris")) {
|
| + packageUris = _json["packageUris"];
|
| + }
|
| + if (_json.containsKey("parameterServerCount")) {
|
| + parameterServerCount = _json["parameterServerCount"];
|
| + }
|
| + if (_json.containsKey("parameterServerType")) {
|
| + parameterServerType = _json["parameterServerType"];
|
| + }
|
| + if (_json.containsKey("pythonModule")) {
|
| + pythonModule = _json["pythonModule"];
|
| + }
|
| + if (_json.containsKey("region")) {
|
| + region = _json["region"];
|
| + }
|
| + if (_json.containsKey("scaleTier")) {
|
| + scaleTier = _json["scaleTier"];
|
| + }
|
| + if (_json.containsKey("workerCount")) {
|
| + workerCount = _json["workerCount"];
|
| + }
|
| + if (_json.containsKey("workerType")) {
|
| + workerType = _json["workerType"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (args != null) {
|
| + _json["args"] = args;
|
| + }
|
| + if (hyperparameters != null) {
|
| + _json["hyperparameters"] = (hyperparameters).toJson();
|
| + }
|
| + if (masterType != null) {
|
| + _json["masterType"] = masterType;
|
| + }
|
| + if (packageUris != null) {
|
| + _json["packageUris"] = packageUris;
|
| + }
|
| + if (parameterServerCount != null) {
|
| + _json["parameterServerCount"] = parameterServerCount;
|
| + }
|
| + if (parameterServerType != null) {
|
| + _json["parameterServerType"] = parameterServerType;
|
| + }
|
| + if (pythonModule != null) {
|
| + _json["pythonModule"] = pythonModule;
|
| + }
|
| + if (region != null) {
|
| + _json["region"] = region;
|
| + }
|
| + if (scaleTier != null) {
|
| + _json["scaleTier"] = scaleTier;
|
| + }
|
| + if (workerCount != null) {
|
| + _json["workerCount"] = workerCount;
|
| + }
|
| + if (workerType != null) {
|
| + _json["workerType"] = workerType;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** Represents results of a training job. */
|
| +class GoogleCloudMlV1beta1TrainingOutput {
|
| + /**
|
| + * The number of hyperparameter tuning trials that completed successfully.
|
| + */
|
| + core.String completedTrialCount;
|
| + /** Results for individual Hyperparameter trials. */
|
| + core.List<GoogleCloudMlV1beta1HyperparameterOutput> trials;
|
| +
|
| + GoogleCloudMlV1beta1TrainingOutput();
|
| +
|
| + GoogleCloudMlV1beta1TrainingOutput.fromJson(core.Map _json) {
|
| + if (_json.containsKey("completedTrialCount")) {
|
| + completedTrialCount = _json["completedTrialCount"];
|
| + }
|
| + if (_json.containsKey("trials")) {
|
| + trials = _json["trials"].map((value) => new GoogleCloudMlV1beta1HyperparameterOutput.fromJson(value)).toList();
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (completedTrialCount != null) {
|
| + _json["completedTrialCount"] = completedTrialCount;
|
| + }
|
| + if (trials != null) {
|
| + _json["trials"] = trials.map((value) => (value).toJson()).toList();
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/**
|
| + * Represents a version of the model.
|
| + *
|
| + * Each version is a trained model deployed in the cloud, ready to handle
|
| + * prediction requests. A model can have multiple versions. You can get
|
| + * information about all of the versions of a given model by calling
|
| + * [projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).
|
| + */
|
| +class GoogleCloudMlV1beta1Version {
|
| + /** Output only. The time the version was created. */
|
| + core.String createTime;
|
| + /**
|
| + * Required. The Google Cloud Storage location of the trained model used to
|
| + * create the version. See the
|
| + * [overview of model deployment](/ml/docs/concepts/deployment-overview) for
|
| + * more informaiton.
|
| + *
|
| + * When passing Version to
|
| + * [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
|
| + * the model service uses the specified location as the source of the model.
|
| + * Once deployed, the model version is hosted by the prediction service, so
|
| + * this location is useful only as a historical record.
|
| + */
|
| + core.String deploymentUri;
|
| + /**
|
| + * Optional. The description specified for the version when it was created.
|
| + */
|
| + core.String description;
|
| + /**
|
| + * 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;
|
| + /**
|
| + * 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;
|
| +
|
| + 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("name")) {
|
| + name = _json["name"];
|
| + }
|
| + }
|
| +
|
| + 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 (name != null) {
|
| + _json["name"] = name;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/** The response message for Operations.ListOperations. */
|
| +class GoogleLongrunningListOperationsResponse {
|
| + /** The standard List next-page token. */
|
| + core.String nextPageToken;
|
| + /** A list of operations that matches the specified filter in the request. */
|
| + core.List<GoogleLongrunningOperation> operations;
|
| +
|
| + GoogleLongrunningListOperationsResponse();
|
| +
|
| + GoogleLongrunningListOperationsResponse.fromJson(core.Map _json) {
|
| + if (_json.containsKey("nextPageToken")) {
|
| + nextPageToken = _json["nextPageToken"];
|
| + }
|
| + if (_json.containsKey("operations")) {
|
| + operations = _json["operations"].map((value) => new GoogleLongrunningOperation.fromJson(value)).toList();
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (nextPageToken != null) {
|
| + _json["nextPageToken"] = nextPageToken;
|
| + }
|
| + if (operations != null) {
|
| + _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.
|
| + */
|
| +class GoogleLongrunningOperation {
|
| + /**
|
| + * 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. */
|
| + GoogleRpcStatus 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.
|
| + */
|
| + 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`.
|
| + */
|
| + 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.
|
| + */
|
| + core.Map<core.String, core.Object> response;
|
| +
|
| + GoogleLongrunningOperation();
|
| +
|
| + GoogleLongrunningOperation.fromJson(core.Map _json) {
|
| + if (_json.containsKey("done")) {
|
| + done = _json["done"];
|
| + }
|
| + if (_json.containsKey("error")) {
|
| + error = new GoogleRpcStatus.fromJson(_json["error"]);
|
| + }
|
| + if (_json.containsKey("metadata")) {
|
| + metadata = _json["metadata"];
|
| + }
|
| + if (_json.containsKey("name")) {
|
| + name = _json["name"];
|
| + }
|
| + if (_json.containsKey("response")) {
|
| + response = _json["response"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (done != null) {
|
| + _json["done"] = done;
|
| + }
|
| + if (error != null) {
|
| + _json["error"] = (error).toJson();
|
| + }
|
| + if (metadata != null) {
|
| + _json["metadata"] = metadata;
|
| + }
|
| + if (name != null) {
|
| + _json["name"] = name;
|
| + }
|
| + if (response != null) {
|
| + _json["response"] = response;
|
| + }
|
| + 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 `{}`.
|
| + */
|
| +class GoogleProtobufEmpty {
|
| +
|
| + GoogleProtobufEmpty();
|
| +
|
| + GoogleProtobufEmpty.fromJson(core.Map _json) {
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + return _json;
|
| + }
|
| +}
|
| +
|
| +/**
|
| + * The `Status` type defines a logical error model that is suitable for
|
| + * different
|
| + * programming environments, including REST APIs and RPC APIs. It is used by
|
| + * [gRPC](https://github.com/grpc). The error model is designed to be:
|
| + *
|
| + * - Simple to use and understand for most users
|
| + * - Flexible enough to meet unexpected needs
|
| + *
|
| + * # Overview
|
| + *
|
| + * The `Status` message contains three pieces of data: error code, error
|
| + * message,
|
| + * and error details. The error code should be an enum value of
|
| + * google.rpc.Code, but it may accept additional error codes if needed. The
|
| + * error message should be a developer-facing English message that helps
|
| + * developers *understand* and *resolve* the error. If a localized user-facing
|
| + * error message is needed, put the localized message in the error details or
|
| + * localize it in the client. The optional error details may contain arbitrary
|
| + * information about the error. There is a predefined set of error detail types
|
| + * in the package `google.rpc` which can be used for common error conditions.
|
| + *
|
| + * # Language mapping
|
| + *
|
| + * The `Status` message is the logical representation of the error model, but it
|
| + * is not necessarily the actual wire format. When the `Status` message is
|
| + * exposed in different client libraries and different wire protocols, it can be
|
| + * mapped differently. For example, it will likely be mapped to some exceptions
|
| + * in Java, but more likely mapped to some error codes in C.
|
| + *
|
| + * # Other uses
|
| + *
|
| + * The error model and the `Status` message can be used in a variety of
|
| + * environments, either with or without APIs, to provide a
|
| + * consistent developer experience across different environments.
|
| + *
|
| + * Example uses of this error model include:
|
| + *
|
| + * - Partial errors. If a service needs to return partial errors to the client,
|
| + * it may embed the `Status` in the normal response to indicate the partial
|
| + * errors.
|
| + *
|
| + * - Workflow errors. A typical workflow has multiple steps. Each step may
|
| + * have a `Status` message for error reporting purpose.
|
| + *
|
| + * - Batch operations. If a client uses batch request and batch response, the
|
| + * `Status` message should be used directly inside batch response, one for
|
| + * each error sub-response.
|
| + *
|
| + * - Asynchronous operations. If an API call embeds asynchronous operation
|
| + * results in its response, the status of those operations should be
|
| + * represented directly using the `Status` message.
|
| + *
|
| + * - Logging. If some API errors are stored in logs, the message `Status` could
|
| + * be used directly after any stripping needed for security/privacy reasons.
|
| + */
|
| +class GoogleRpcStatus {
|
| + /** The status code, which should be an enum value of google.rpc.Code. */
|
| + core.int code;
|
| + /**
|
| + * A list of messages that carry the error details. There will be a
|
| + * common set of message types for APIs to use.
|
| + *
|
| + * 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.
|
| + */
|
| + core.String message;
|
| +
|
| + GoogleRpcStatus();
|
| +
|
| + GoogleRpcStatus.fromJson(core.Map _json) {
|
| + if (_json.containsKey("code")) {
|
| + code = _json["code"];
|
| + }
|
| + if (_json.containsKey("details")) {
|
| + details = _json["details"];
|
| + }
|
| + if (_json.containsKey("message")) {
|
| + message = _json["message"];
|
| + }
|
| + }
|
| +
|
| + core.Map toJson() {
|
| + var _json = new core.Map();
|
| + if (code != null) {
|
| + _json["code"] = code;
|
| + }
|
| + if (details != null) {
|
| + _json["details"] = details;
|
| + }
|
| + if (message != null) {
|
| + _json["message"] = message;
|
| + }
|
| + return _json;
|
| + }
|
| +}
|
|
|
Chromium Code Reviews
Issue 2485703002:
Api-roll 42: 2016-11-08 (Closed)
