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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « generated/googleapis/lib/mirror/v1.dart ('k') | generated/googleapis/lib/monitoring/v3.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: generated/googleapis/lib/ml/v1.dart
diff --git a/generated/googleapis/lib/ml/v1.dart b/generated/googleapis/lib/ml/v1.dart
index 3db694b610f9bda1011cfa7834c19c30c7c117f3..eebabc12e803ee5b7cb44265d3e4ba4948cc9bb5 100644
--- a/generated/googleapis/lib/ml/v1.dart
+++ b/generated/googleapis/lib/ml/v1.dart
@@ -9,55 +9,57 @@ import 'dart:convert' as convert;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
-export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
- ApiRequestError, DetailedApiRequestError;
+export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
+ show ApiRequestError, DetailedApiRequestError;
const core.String USER_AGENT = 'dart-api-client ml/v1';
-/** An API to enable creating and using machine learning models. */
+/// 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";
-
+ /// 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);
+ 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.
- * Value must have pattern "^projects/[^/]+$".
- *
- * Completes with a [GoogleCloudMlV1GetConfigResponse].
- *
- * 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.
- */
+ 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.
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// Completes with a [GoogleCloudMlV1GetConfigResponse].
+ ///
+ /// 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<GoogleCloudMlV1GetConfigResponse> getConfig(core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -70,41 +72,42 @@ class ProjectsResourceApi {
throw new core.ArgumentError("Parameter name is required.");
}
- _url = 'v1/' + 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 GoogleCloudMlV1GetConfigResponse.fromJson(data));
- }
-
- /**
- * Performs prediction on the data in the request.
- *
- * **** REMOVE FROM GENERATED DOCUMENTATION
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [name] - Required. The resource name of a model or a version.
- *
- * Authorization: requires the `predict` permission on the specified resource.
- * 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(GoogleCloudMlV1PredictRequest request, core.String name) {
+ _url =
+ 'v1/' + 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 GoogleCloudMlV1GetConfigResponse.fromJson(data));
+ }
+
+ /// Performs prediction on the data in the request.
+ ///
+ /// **** REMOVE FROM GENERATED DOCUMENTATION
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Required. The resource name of a model or a version.
+ ///
+ /// Authorization: requires the `predict` permission on the specified
+ /// resource.
+ /// 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(
+ GoogleCloudMlV1PredictRequest request, core.String name) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -121,44 +124,39 @@ class ProjectsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':predict';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new 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.
- * 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(GoogleCloudMlV1CancelJobRequest request, core.String name) {
+ 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.
+ /// 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(
+ GoogleCloudMlV1CancelJobRequest request, core.String name) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -175,35 +173,33 @@ class ProjectsJobsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':cancel';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleProtobufEmpty.fromJson(data));
}
- /**
- * Creates a training or a batch prediction job.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [parent] - Required. The project name.
- * Value must have pattern "^projects/[^/]+$".
- *
- * Completes with a [GoogleCloudMlV1Job].
- *
- * 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<GoogleCloudMlV1Job> create(GoogleCloudMlV1Job request, core.String parent) {
+ /// Creates a training or a batch prediction job.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [parent] - Required. The project name.
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// Completes with a [GoogleCloudMlV1Job].
+ ///
+ /// 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<GoogleCloudMlV1Job> create(
+ GoogleCloudMlV1Job request, core.String parent) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -220,32 +216,29 @@ class ProjectsJobsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/jobs';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleCloudMlV1Job.fromJson(data));
}
- /**
- * Describes a job.
- *
- * Request parameters:
- *
- * [name] - Required. The name of the job to get the description of.
- * Value must have pattern "^projects/[^/]+/jobs/[^/]+$".
- *
- * Completes with a [GoogleCloudMlV1Job].
- *
- * 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.
- */
+ /// Describes a job.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Required. The name of the job to get the description of.
+ /// Value must have pattern "^projects/[^/]+/jobs/[^/]+$".
+ ///
+ /// Completes with a [GoogleCloudMlV1Job].
+ ///
+ /// 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<GoogleCloudMlV1Job> get(core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -260,36 +253,33 @@ class ProjectsJobsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleCloudMlV1Job.fromJson(data));
}
- /**
- * Gets the access control policy for a resource.
- * Returns an empty policy if the resource exists and does not have a policy
- * set.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy is being
- * requested.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^projects/[^/]+/jobs/[^/]+$".
- *
- * Completes with a [GoogleIamV1Policy].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ /// Gets the access control policy for a resource.
+ /// Returns an empty policy if the resource exists and does not have a policy
+ /// set.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy is being
+ /// requested.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^projects/[^/]+/jobs/[^/]+$".
+ ///
+ /// Completes with a [GoogleIamV1Policy].
+ ///
+ /// 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<GoogleIamV1Policy> getIamPolicy(core.String resource) {
var _url = null;
var _queryParams = new core.Map();
@@ -302,49 +292,49 @@ class ProjectsJobsResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':getIamPolicy';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':getIamPolicy';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleIamV1Policy.fromJson(data));
}
- /**
- * Lists the jobs in the project.
- *
- * Request parameters:
- *
- * [parent] - Required. The name of the project for which to list jobs.
- * Value must have pattern "^projects/[^/]+$".
- *
- * [pageToken] - Optional. A page token to request the next page of results.
- *
- * You get the token from the `next_page_token` field of the response from
- * the previous call.
- *
- * [pageSize] - Optional. The number of jobs to retrieve per "page" of
- * results. If there
- * are more remaining results than this number, the response message will
- * contain a valid value in the `next_page_token` field.
- *
- * The default value is 20, and the maximum page size is 100.
- *
- * [filter] - Optional. Specifies the subset of jobs to retrieve.
- *
- * Completes with a [GoogleCloudMlV1ListJobsResponse].
- *
- * 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<GoogleCloudMlV1ListJobsResponse> list(core.String parent, {core.String pageToken, core.int pageSize, core.String filter}) {
+ /// Lists the jobs in the project.
+ ///
+ /// Request parameters:
+ ///
+ /// [parent] - Required. The name of the project for which to list jobs.
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// [filter] - Optional. Specifies the subset of jobs to retrieve.
+ ///
+ /// [pageToken] - Optional. A page token to request the next page of results.
+ ///
+ /// You get the token from the `next_page_token` field of the response from
+ /// the previous call.
+ ///
+ /// [pageSize] - Optional. The number of jobs to retrieve per "page" of
+ /// results. If there
+ /// are more remaining results than this number, the response message will
+ /// contain a valid value in the `next_page_token` field.
+ ///
+ /// The default value is 20, and the maximum page size is 100.
+ ///
+ /// Completes with a [GoogleCloudMlV1ListJobsResponse].
+ ///
+ /// 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<GoogleCloudMlV1ListJobsResponse> list(core.String parent,
+ {core.String filter, core.String pageToken, core.int pageSize}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -355,50 +345,49 @@ class ProjectsJobsResourceApi {
if (parent == null) {
throw new core.ArgumentError("Parameter parent is required.");
}
+ if (filter != null) {
+ _queryParams["filter"] = [filter];
+ }
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
- if (filter != null) {
- _queryParams["filter"] = [filter];
- }
_url = 'v1/' + 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 GoogleCloudMlV1ListJobsResponse.fromJson(data));
- }
-
- /**
- * Sets the access control policy on the specified resource. Replaces any
- * existing policy.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy is being
- * specified.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^projects/[^/]+/jobs/[^/]+$".
- *
- * Completes with a [GoogleIamV1Policy].
- *
- * 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<GoogleIamV1Policy> setIamPolicy(GoogleIamV1SetIamPolicyRequest request, core.String resource) {
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response
+ .then((data) => new GoogleCloudMlV1ListJobsResponse.fromJson(data));
+ }
+
+ /// Sets the access control policy on the specified resource. Replaces any
+ /// existing policy.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy is being
+ /// specified.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^projects/[^/]+/jobs/[^/]+$".
+ ///
+ /// Completes with a [GoogleIamV1Policy].
+ ///
+ /// 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<GoogleIamV1Policy> setIamPolicy(
+ GoogleIamV1SetIamPolicyRequest request, core.String resource) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -413,45 +402,46 @@ class ProjectsJobsResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':setIamPolicy';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':setIamPolicy';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleIamV1Policy.fromJson(data));
}
- /**
- * Returns permissions that a caller has on the specified resource.
- * If the resource does not exist, this will return an empty set of
- * permissions, not a NOT_FOUND error.
- *
- * Note: This operation is designed to be used for building permission-aware
- * UIs and command-line tools, not for authorization checking. This operation
- * may "fail open" without warning.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy detail is being
- * requested.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^projects/[^/]+/jobs/[^/]+$".
- *
- * Completes with a [GoogleIamV1TestIamPermissionsResponse].
- *
- * 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<GoogleIamV1TestIamPermissionsResponse> testIamPermissions(GoogleIamV1TestIamPermissionsRequest request, core.String resource) {
+ /// Returns permissions that a caller has on the specified resource.
+ /// If the resource does not exist, this will return an empty set of
+ /// permissions, not a NOT_FOUND error.
+ ///
+ /// Note: This operation is designed to be used for building permission-aware
+ /// UIs and command-line tools, not for authorization checking. This
+ /// operation
+ /// may "fail open" without warning.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy detail is being
+ /// requested.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^projects/[^/]+/jobs/[^/]+$".
+ ///
+ /// Completes with a [GoogleIamV1TestIamPermissionsResponse].
+ ///
+ /// 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<GoogleIamV1TestIamPermissionsResponse> testIamPermissions(
+ GoogleIamV1TestIamPermissionsRequest request, core.String resource) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -466,52 +456,51 @@ class ProjectsJobsResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':testIamPermissions';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':testIamPermissions';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
- return _response.then((data) => new GoogleIamV1TestIamPermissionsResponse.fromJson(data));
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response.then(
+ (data) => new GoogleIamV1TestIamPermissionsResponse.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-engine/reference/rest/v1/projects.models.versions/create).
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [parent] - Required. The project name.
- * Value must have pattern "^projects/[^/]+$".
- *
- * Completes with a [GoogleCloudMlV1Model].
- *
- * 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<GoogleCloudMlV1Model> create(GoogleCloudMlV1Model request, core.String parent) {
+ 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-engine/reference/rest/v1/projects.models.versions/create).
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [parent] - Required. The project name.
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// Completes with a [GoogleCloudMlV1Model].
+ ///
+ /// 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<GoogleCloudMlV1Model> create(
+ GoogleCloudMlV1Model request, core.String parent) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -528,36 +517,34 @@ class ProjectsModelsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/models';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleCloudMlV1Model.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-engine/reference/rest/v1/projects.models.versions/delete).
- *
- * Request parameters:
- *
- * [name] - Required. The name of the model.
- * 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.
- */
+ /// 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-engine/reference/rest/v1/projects.models.versions/delete).
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - Required. The name of the model.
+ /// 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();
@@ -572,34 +559,32 @@ class ProjectsModelsResourceApi {
_url = 'v1/' + 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.
- * Value must have pattern "^projects/[^/]+/models/[^/]+$".
- *
- * Completes with a [GoogleCloudMlV1Model].
- *
- * 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.
- */
+ 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.
+ /// Value must have pattern "^projects/[^/]+/models/[^/]+$".
+ ///
+ /// Completes with a [GoogleCloudMlV1Model].
+ ///
+ /// 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<GoogleCloudMlV1Model> get(core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -614,36 +599,33 @@ class ProjectsModelsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleCloudMlV1Model.fromJson(data));
}
- /**
- * Gets the access control policy for a resource.
- * Returns an empty policy if the resource exists and does not have a policy
- * set.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy is being
- * requested.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^projects/[^/]+/models/[^/]+$".
- *
- * Completes with a [GoogleIamV1Policy].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
+ /// Gets the access control policy for a resource.
+ /// Returns an empty policy if the resource exists and does not have a policy
+ /// set.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy is being
+ /// requested.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^projects/[^/]+/models/[^/]+$".
+ ///
+ /// Completes with a [GoogleIamV1Policy].
+ ///
+ /// 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<GoogleIamV1Policy> getIamPolicy(core.String resource) {
var _url = null;
var _queryParams = new core.Map();
@@ -656,50 +638,52 @@ class ProjectsModelsResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':getIamPolicy';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':getIamPolicy';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleIamV1Policy.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.
- * Value must have pattern "^projects/[^/]+$".
- *
- * [pageToken] - Optional. A page token to request the next page of results.
- *
- * You get the token from the `next_page_token` field of the response from
- * the previous call.
- *
- * [pageSize] - Optional. The number of 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.
- *
- * Completes with a [GoogleCloudMlV1ListModelsResponse].
- *
- * 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<GoogleCloudMlV1ListModelsResponse> list(core.String parent, {core.String pageToken, core.int pageSize}) {
+ /// 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.
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// [pageToken] - Optional. A page token to request the next page of results.
+ ///
+ /// You get the token from the `next_page_token` field of the response from
+ /// the previous call.
+ ///
+ /// [pageSize] - Optional. The number of 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.
+ ///
+ /// Completes with a [GoogleCloudMlV1ListModelsResponse].
+ ///
+ /// 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<GoogleCloudMlV1ListModelsResponse> list(core.String parent,
+ {core.String pageToken, core.int pageSize}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -719,38 +703,37 @@ class ProjectsModelsResourceApi {
_url = 'v1/' + 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 GoogleCloudMlV1ListModelsResponse.fromJson(data));
- }
-
- /**
- * Sets the access control policy on the specified resource. Replaces any
- * existing policy.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy is being
- * specified.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^projects/[^/]+/models/[^/]+$".
- *
- * Completes with a [GoogleIamV1Policy].
- *
- * 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<GoogleIamV1Policy> setIamPolicy(GoogleIamV1SetIamPolicyRequest request, core.String resource) {
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response
+ .then((data) => new GoogleCloudMlV1ListModelsResponse.fromJson(data));
+ }
+
+ /// Sets the access control policy on the specified resource. Replaces any
+ /// existing policy.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy is being
+ /// specified.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^projects/[^/]+/models/[^/]+$".
+ ///
+ /// Completes with a [GoogleIamV1Policy].
+ ///
+ /// 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<GoogleIamV1Policy> setIamPolicy(
+ GoogleIamV1SetIamPolicyRequest request, core.String resource) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -765,45 +748,46 @@ class ProjectsModelsResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':setIamPolicy';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':setIamPolicy';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleIamV1Policy.fromJson(data));
}
- /**
- * Returns permissions that a caller has on the specified resource.
- * If the resource does not exist, this will return an empty set of
- * permissions, not a NOT_FOUND error.
- *
- * Note: This operation is designed to be used for building permission-aware
- * UIs and command-line tools, not for authorization checking. This operation
- * may "fail open" without warning.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy detail is being
- * requested.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^projects/[^/]+/models/[^/]+$".
- *
- * Completes with a [GoogleIamV1TestIamPermissionsResponse].
- *
- * 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<GoogleIamV1TestIamPermissionsResponse> testIamPermissions(GoogleIamV1TestIamPermissionsRequest request, core.String resource) {
+ /// Returns permissions that a caller has on the specified resource.
+ /// If the resource does not exist, this will return an empty set of
+ /// permissions, not a NOT_FOUND error.
+ ///
+ /// Note: This operation is designed to be used for building permission-aware
+ /// UIs and command-line tools, not for authorization checking. This
+ /// operation
+ /// may "fail open" without warning.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy detail is being
+ /// requested.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^projects/[^/]+/models/[^/]+$".
+ ///
+ /// Completes with a [GoogleIamV1TestIamPermissionsResponse].
+ ///
+ /// 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<GoogleIamV1TestIamPermissionsResponse> testIamPermissions(
+ GoogleIamV1TestIamPermissionsRequest request, core.String resource) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -818,53 +802,54 @@ class ProjectsModelsResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':testIamPermissions';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':testIamPermissions';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
- return _response.then((data) => new GoogleIamV1TestIamPermissionsResponse.fromJson(data));
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response.then(
+ (data) => new GoogleIamV1TestIamPermissionsResponse.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-engine/reference/rest/v1/projects.models.versions/setDefault).
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [parent] - Required. The name of the model.
- * 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(GoogleCloudMlV1Version request, core.String parent) {
+ 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-engine/reference/rest/v1/projects.models.versions/setDefault).
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [parent] - Required. The name of the model.
+ /// 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(
+ GoogleCloudMlV1Version request, core.String parent) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -879,43 +864,42 @@ class ProjectsModelsVersionsResourceApi {
throw new core.ArgumentError("Parameter parent is required.");
}
- _url = 'v1/' + 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-engine/reference/rest/v1/projects.models.versions/list).
- * 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.
- */
+ _url =
+ 'v1/' + 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-engine/reference/rest/v1/projects.models.versions/list).
+ /// 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();
@@ -930,37 +914,35 @@ class ProjectsModelsVersionsResourceApi {
_url = 'v1/' + 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-engine/reference/rest/v1/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.
- * Value must have pattern "^projects/[^/]+/models/[^/]+/versions/[^/]+$".
- *
- * Completes with a [GoogleCloudMlV1Version].
- *
- * 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.
- */
+ 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-engine/reference/rest/v1/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.
+ /// Value must have pattern "^projects/[^/]+/models/[^/]+/versions/[^/]+$".
+ ///
+ /// Completes with a [GoogleCloudMlV1Version].
+ ///
+ /// 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<GoogleCloudMlV1Version> get(core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -975,49 +957,48 @@ class ProjectsModelsVersionsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleCloudMlV1Version.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.
- * Value must have pattern "^projects/[^/]+/models/[^/]+$".
- *
- * [pageToken] - Optional. A page token to request the next page of results.
- *
- * You get the token from the `next_page_token` field of the response from
- * the previous call.
- *
- * [pageSize] - Optional. The number of 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.
- *
- * Completes with a [GoogleCloudMlV1ListVersionsResponse].
- *
- * 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<GoogleCloudMlV1ListVersionsResponse> list(core.String parent, {core.String pageToken, core.int pageSize}) {
+ /// 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.
+ /// Value must have pattern "^projects/[^/]+/models/[^/]+$".
+ ///
+ /// [pageToken] - Optional. A page token to request the next page of results.
+ ///
+ /// You get the token from the `next_page_token` field of the response from
+ /// the previous call.
+ ///
+ /// [pageSize] - Optional. The number of 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.
+ ///
+ /// Completes with a [GoogleCloudMlV1ListVersionsResponse].
+ ///
+ /// 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<GoogleCloudMlV1ListVersionsResponse> list(core.String parent,
+ {core.String pageToken, core.int pageSize}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -1035,47 +1016,48 @@ class ProjectsModelsVersionsResourceApi {
_queryParams["pageSize"] = ["${pageSize}"];
}
- _url = 'v1/' + 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 GoogleCloudMlV1ListVersionsResponse.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-engine/reference/rest/v1/projects.models.versions/list).
- * Value must have pattern "^projects/[^/]+/models/[^/]+/versions/[^/]+$".
- *
- * Completes with a [GoogleCloudMlV1Version].
- *
- * 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<GoogleCloudMlV1Version> setDefault(GoogleCloudMlV1SetDefaultVersionRequest request, core.String name) {
+ _url =
+ 'v1/' + 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 GoogleCloudMlV1ListVersionsResponse.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-engine/reference/rest/v1/projects.models.versions/list).
+ /// Value must have pattern "^projects/[^/]+/models/[^/]+/versions/[^/]+$".
+ ///
+ /// Completes with a [GoogleCloudMlV1Version].
+ ///
+ /// 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<GoogleCloudMlV1Version> setDefault(
+ GoogleCloudMlV1SetDefaultVersionRequest request, core.String name) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -1090,52 +1072,48 @@ class ProjectsModelsVersionsResourceApi {
throw new core.ArgumentError("Parameter name is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':setDefault';
+ _url =
+ 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':setDefault';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new GoogleCloudMlV1Version.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.
- */
+ 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();
@@ -1150,35 +1128,33 @@ class ProjectsOperationsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':cancel';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new 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.
- */
+ /// 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();
@@ -1193,34 +1169,32 @@ class ProjectsOperationsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "DELETE",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "DELETE",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new 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.
- */
+ /// 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();
@@ -1235,48 +1209,48 @@ class ProjectsOperationsResourceApi {
_url = 'v1/' + 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 allows API services to override the binding
- * to use different resource name schemes, such as `users / * /operations`. To
- * override the binding, API services can add a binding such as
- * `"/v1/{name=users / * }/operations"` to their service configuration.
- * For backwards compatibility, the default name includes the operations
- * collection id, however overriding users must ensure the name binding
- * is the parent resource, without the operations collection id.
- *
- * Request parameters:
- *
- * [name] - The name of the operation's parent resource.
- * Value must have pattern "^projects/[^/]+$".
- *
- * [pageToken] - The standard list page token.
- *
- * [pageSize] - The standard list page size.
- *
- * [filter] - The standard list filter.
- *
- * Completes with a [GoogleLongrunningListOperationsResponse].
- *
- * Completes with a [commons.ApiRequestError] if the API endpoint returned an
- * error.
- *
- * If the used [http.Client] completes with an error when making a REST call,
- * this method will complete with the same error.
- */
- async.Future<GoogleLongrunningListOperationsResponse> list(core.String name, {core.String pageToken, core.int pageSize, core.String filter}) {
+ 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 allows API services to override the binding
+ /// to use different resource name schemes, such as `users / * /operations`.
+ /// To
+ /// override the binding, API services can add a binding such as
+ /// `"/v1/{name=users / * }/operations"` to their service configuration.
+ /// For backwards compatibility, the default name includes the operations
+ /// collection id, however overriding users must ensure the name binding
+ /// is the parent resource, without the operations collection id.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - The name of the operation's parent resource.
+ /// Value must have pattern "^projects/[^/]+$".
+ ///
+ /// [pageToken] - The standard list page token.
+ ///
+ /// [pageSize] - The standard list page size.
+ ///
+ /// [filter] - The standard list filter.
+ ///
+ /// Completes with a [GoogleLongrunningListOperationsResponse].
+ ///
+ /// Completes with a [commons.ApiRequestError] if the API endpoint returned
+ /// an error.
+ ///
+ /// If the used [http.Client] completes with an error when making a REST
+ /// call, this method will complete with the same error.
+ async.Future<GoogleLongrunningListOperationsResponse> list(core.String name,
+ {core.String pageToken, core.int pageSize, core.String filter}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -1297,83 +1271,78 @@ class ProjectsOperationsResourceApi {
_queryParams["filter"] = [filter];
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + '/operations';
+ _url =
+ 'v1/' + 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));
+ 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.
- */
+/// 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.
- */
+ /// The HTTP Content-Type string representing the content type of the body.
core.String contentType;
- /** HTTP body binary data. */
+
+ /// 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("+", "-");
+ data =
+ convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
- /**
- * Application specific response metadata. Must be set in the first response
- * for streaming APIs.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// Application specific response metadata. Must be set in the first response
+ /// for streaming APIs.
+ ///
+ /// 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>> extensions;
GoogleApiHttpBody();
@@ -1391,7 +1360,8 @@ class GoogleApiHttpBody {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (contentType != null) {
_json["contentType"] = contentType;
}
@@ -1405,16 +1375,18 @@ class GoogleApiHttpBody {
}
}
-/** An observed value of a metric. */
+/// An observed value of a metric.
class GoogleCloudMlV1HyperparameterOutputHyperparameterMetric {
- /** The objective value at this training step. */
+ /// The objective value at this training step.
core.double objectiveValue;
- /** The global training step for this metric. */
+
+ /// The global training step for this metric.
core.String trainingStep;
GoogleCloudMlV1HyperparameterOutputHyperparameterMetric();
- GoogleCloudMlV1HyperparameterOutputHyperparameterMetric.fromJson(core.Map _json) {
+ GoogleCloudMlV1HyperparameterOutputHyperparameterMetric.fromJson(
+ core.Map _json) {
if (_json.containsKey("objectiveValue")) {
objectiveValue = _json["objectiveValue"];
}
@@ -1424,7 +1396,8 @@ class GoogleCloudMlV1HyperparameterOutputHyperparameterMetric {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (objectiveValue != null) {
_json["objectiveValue"] = objectiveValue;
}
@@ -1435,28 +1408,27 @@ class GoogleCloudMlV1HyperparameterOutputHyperparameterMetric {
}
}
-/** Options for automatically scaling a model. */
+/// Options for automatically scaling a model.
class GoogleCloudMlV1AutoScaling {
- /**
- * Optional. The minimum number of nodes to allocate for this model. These
- * nodes are always up, starting from the time the model is deployed, so the
- * cost of operating this model will be at least
- * `rate` * `min_nodes` * number of hours since last billing cycle,
- * where `rate` is the cost per node-hour as documented in
- * [pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),
- * even if no predictions are performed. There is additional cost for each
- * prediction performed.
- *
- * Unlike manual scaling, if the load gets too heavy for the nodes
- * that are up, the service will automatically add nodes to handle the
- * increased load as well as scale back as traffic drops, always maintaining
- * at least `min_nodes`. You will be charged for the time in which additional
- * nodes are used.
- *
- * If not specified, `min_nodes` defaults to 0, in which case, when traffic
- * to a model stops (and after a cool-down period), nodes will be shut down
- * and no charges will be incurred until traffic to the model resumes.
- */
+ /// Optional. The minimum number of nodes to allocate for this model. These
+ /// nodes are always up, starting from the time the model is deployed, so the
+ /// cost of operating this model will be at least
+ /// `rate` * `min_nodes` * number of hours since last billing cycle,
+ /// where `rate` is the cost per node-hour as documented in
+ /// [pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),
+ /// even if no predictions are performed. There is additional cost for each
+ /// prediction performed.
+ ///
+ /// Unlike manual scaling, if the load gets too heavy for the nodes
+ /// that are up, the service will automatically add nodes to handle the
+ /// increased load as well as scale back as traffic drops, always maintaining
+ /// at least `min_nodes`. You will be charged for the time in which
+ /// additional
+ /// nodes are used.
+ ///
+ /// If not specified, `min_nodes` defaults to 0, in which case, when traffic
+ /// to a model stops (and after a cool-down period), nodes will be shut down
+ /// and no charges will be incurred until traffic to the model resumes.
core.int minNodes;
GoogleCloudMlV1AutoScaling();
@@ -1468,7 +1440,8 @@ class GoogleCloudMlV1AutoScaling {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (minNodes != null) {
_json["minNodes"] = minNodes;
}
@@ -1476,25 +1449,25 @@ class GoogleCloudMlV1AutoScaling {
}
}
-/** Request message for the CancelJob method. */
+/// Request message for the CancelJob method.
class GoogleCloudMlV1CancelJobRequest {
-
GoogleCloudMlV1CancelJobRequest();
- GoogleCloudMlV1CancelJobRequest.fromJson(core.Map _json) {
- }
+ GoogleCloudMlV1CancelJobRequest.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
return _json;
}
}
-/** Returns service account information associated with a project. */
+/// Returns service account information associated with a project.
class GoogleCloudMlV1GetConfigResponse {
- /** The service account Cloud ML uses to access resources in the project. */
+ /// The service account Cloud ML uses to access resources in the project.
core.String serviceAccount;
- /** The project number for `service_account`. */
+
+ /// The project number for `service_account`.
core.String serviceAccountProject;
GoogleCloudMlV1GetConfigResponse();
@@ -1509,7 +1482,8 @@ class GoogleCloudMlV1GetConfigResponse {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (serviceAccount != null) {
_json["serviceAccount"] = serviceAccount;
}
@@ -1520,30 +1494,37 @@ class GoogleCloudMlV1GetConfigResponse {
}
}
-/**
- * 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.
- */
+/// 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 GoogleCloudMlV1HyperparameterOutput {
- /** All recorded object metrics for this trial. */
+ /// All recorded object metrics for this trial.
core.List<GoogleCloudMlV1HyperparameterOutputHyperparameterMetric> allMetrics;
- /** The final objective metric seen for this trial. */
+
+ /// The final objective metric seen for this trial.
GoogleCloudMlV1HyperparameterOutputHyperparameterMetric finalMetric;
- /** The hyperparameters given to this trial. */
+
+ /// The hyperparameters given to this trial.
core.Map<core.String, core.String> hyperparameters;
- /** The trial id for these results. */
+
+ /// The trial id for these results.
core.String trialId;
GoogleCloudMlV1HyperparameterOutput();
GoogleCloudMlV1HyperparameterOutput.fromJson(core.Map _json) {
if (_json.containsKey("allMetrics")) {
- allMetrics = _json["allMetrics"].map((value) => new GoogleCloudMlV1HyperparameterOutputHyperparameterMetric.fromJson(value)).toList();
+ allMetrics = _json["allMetrics"]
+ .map((value) =>
+ new GoogleCloudMlV1HyperparameterOutputHyperparameterMetric
+ .fromJson(value))
+ .toList();
}
if (_json.containsKey("finalMetric")) {
- finalMetric = new GoogleCloudMlV1HyperparameterOutputHyperparameterMetric.fromJson(_json["finalMetric"]);
+ finalMetric =
+ new GoogleCloudMlV1HyperparameterOutputHyperparameterMetric.fromJson(
+ _json["finalMetric"]);
}
if (_json.containsKey("hyperparameters")) {
hyperparameters = _json["hyperparameters"];
@@ -1554,9 +1535,11 @@ class GoogleCloudMlV1HyperparameterOutput {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (allMetrics != null) {
- _json["allMetrics"] = allMetrics.map((value) => (value).toJson()).toList();
+ _json["allMetrics"] =
+ allMetrics.map((value) => (value).toJson()).toList();
}
if (finalMetric != null) {
_json["finalMetric"] = (finalMetric).toJson();
@@ -1571,48 +1554,49 @@ class GoogleCloudMlV1HyperparameterOutput {
}
}
-/** Represents a set of hyperparameters to optimize. */
+/// Represents a set of hyperparameters to optimize.
class GoogleCloudMlV1HyperparameterSpec {
- /**
- * 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.
- */
+ /// 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 Tensorflow summary tag name to use for optimizing trials. For
- * current versions of Tensorflow, this tag name should exactly match what is
- * shown in Tensorboard, including all scopes. For versions of Tensorflow
- * prior to 0.12, this should be only the tag passed to tf.Summary.
- * By default, "training/hptuning/metric" will be used.
- */
+
+ /// Optional. The Tensorflow summary tag name to use for optimizing trials.
+ /// For
+ /// current versions of Tensorflow, this tag name should exactly match what
+ /// is
+ /// shown in Tensorboard, including all scopes. For versions of Tensorflow
+ /// prior to 0.12, this should be only the tag passed to tf.Summary.
+ /// By default, "training/hptuning/metric" will be used.
core.String hyperparameterMetricTag;
- /**
- * 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.
- */
+
+ /// 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.
- */
+
+ /// 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. */
+
+ /// Required. The set of parameters to tune.
core.List<GoogleCloudMlV1ParameterSpec> params;
GoogleCloudMlV1HyperparameterSpec();
@@ -1631,12 +1615,15 @@ class GoogleCloudMlV1HyperparameterSpec {
maxTrials = _json["maxTrials"];
}
if (_json.containsKey("params")) {
- params = _json["params"].map((value) => new GoogleCloudMlV1ParameterSpec.fromJson(value)).toList();
+ params = _json["params"]
+ .map((value) => new GoogleCloudMlV1ParameterSpec.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (goal != null) {
_json["goal"] = goal;
}
@@ -1656,46 +1643,51 @@ class GoogleCloudMlV1HyperparameterSpec {
}
}
-/**
- * Represents a training or prediction job.
- *
- * Next ID: 16
- */
+/// Represents a training or prediction job.
+///
+/// Next ID: 16
class GoogleCloudMlV1Job {
- /** Output only. When the job was created. */
+ /// Output only. When the job was created.
core.String createTime;
- /** Output only. When the job processing was completed. */
+
+ /// Output only. When the job processing was completed.
core.String endTime;
- /** Output only. The details of a failure or a cancellation. */
+
+ /// Output only. The details of a failure or a cancellation.
core.String errorMessage;
- /** Required. The user-specified id of the job. */
+
+ /// Required. The user-specified id of the job.
core.String jobId;
- /** Input parameters to create a prediction job. */
+
+ /// Input parameters to create a prediction job.
GoogleCloudMlV1PredictionInput predictionInput;
- /** The current prediction job result. */
+
+ /// The current prediction job result.
GoogleCloudMlV1PredictionOutput predictionOutput;
- /** Output only. When the job processing was started. */
+
+ /// 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.
- */
+
+ /// 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. */
+
+ /// Input parameters to create a training job.
GoogleCloudMlV1TrainingInput trainingInput;
- /** The current training job result. */
+
+ /// The current training job result.
GoogleCloudMlV1TrainingOutput trainingOutput;
GoogleCloudMlV1Job();
@@ -1714,10 +1706,12 @@ class GoogleCloudMlV1Job {
jobId = _json["jobId"];
}
if (_json.containsKey("predictionInput")) {
- predictionInput = new GoogleCloudMlV1PredictionInput.fromJson(_json["predictionInput"]);
+ predictionInput =
+ new GoogleCloudMlV1PredictionInput.fromJson(_json["predictionInput"]);
}
if (_json.containsKey("predictionOutput")) {
- predictionOutput = new GoogleCloudMlV1PredictionOutput.fromJson(_json["predictionOutput"]);
+ predictionOutput = new GoogleCloudMlV1PredictionOutput.fromJson(
+ _json["predictionOutput"]);
}
if (_json.containsKey("startTime")) {
startTime = _json["startTime"];
@@ -1726,15 +1720,18 @@ class GoogleCloudMlV1Job {
state = _json["state"];
}
if (_json.containsKey("trainingInput")) {
- trainingInput = new GoogleCloudMlV1TrainingInput.fromJson(_json["trainingInput"]);
+ trainingInput =
+ new GoogleCloudMlV1TrainingInput.fromJson(_json["trainingInput"]);
}
if (_json.containsKey("trainingOutput")) {
- trainingOutput = new GoogleCloudMlV1TrainingOutput.fromJson(_json["trainingOutput"]);
+ trainingOutput =
+ new GoogleCloudMlV1TrainingOutput.fromJson(_json["trainingOutput"]);
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (createTime != null) {
_json["createTime"] = createTime;
}
@@ -1769,21 +1766,22 @@ class GoogleCloudMlV1Job {
}
}
-/** Response message for the ListJobs method. */
+/// Response message for the ListJobs method.
class GoogleCloudMlV1ListJobsResponse {
- /** The list of jobs. */
+ /// The list of jobs.
core.List<GoogleCloudMlV1Job> jobs;
- /**
- * Optional. Pass this token as the `page_token` field of the request for a
- * subsequent call.
- */
+
+ /// Optional. Pass this token as the `page_token` field of the request for a
+ /// subsequent call.
core.String nextPageToken;
GoogleCloudMlV1ListJobsResponse();
GoogleCloudMlV1ListJobsResponse.fromJson(core.Map _json) {
if (_json.containsKey("jobs")) {
- jobs = _json["jobs"].map((value) => new GoogleCloudMlV1Job.fromJson(value)).toList();
+ jobs = _json["jobs"]
+ .map((value) => new GoogleCloudMlV1Job.fromJson(value))
+ .toList();
}
if (_json.containsKey("nextPageToken")) {
nextPageToken = _json["nextPageToken"];
@@ -1791,7 +1789,8 @@ class GoogleCloudMlV1ListJobsResponse {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (jobs != null) {
_json["jobs"] = jobs.map((value) => (value).toJson()).toList();
}
@@ -1802,21 +1801,22 @@ class GoogleCloudMlV1ListJobsResponse {
}
}
-/** Response message for the ListModels method. */
+/// Response message for the ListModels method.
class GoogleCloudMlV1ListModelsResponse {
- /** The list of models. */
+ /// The list of models.
core.List<GoogleCloudMlV1Model> models;
- /**
- * Optional. Pass this token as the `page_token` field of the request for a
- * subsequent call.
- */
+
+ /// Optional. Pass this token as the `page_token` field of the request for a
+ /// subsequent call.
core.String nextPageToken;
GoogleCloudMlV1ListModelsResponse();
GoogleCloudMlV1ListModelsResponse.fromJson(core.Map _json) {
if (_json.containsKey("models")) {
- models = _json["models"].map((value) => new GoogleCloudMlV1Model.fromJson(value)).toList();
+ models = _json["models"]
+ .map((value) => new GoogleCloudMlV1Model.fromJson(value))
+ .toList();
}
if (_json.containsKey("nextPageToken")) {
nextPageToken = _json["nextPageToken"];
@@ -1824,7 +1824,8 @@ class GoogleCloudMlV1ListModelsResponse {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (models != null) {
_json["models"] = models.map((value) => (value).toJson()).toList();
}
@@ -1835,14 +1836,13 @@ class GoogleCloudMlV1ListModelsResponse {
}
}
-/** Response message for the ListVersions method. */
+/// Response message for the ListVersions method.
class GoogleCloudMlV1ListVersionsResponse {
- /**
- * Optional. Pass this token as the `page_token` field of the request for a
- * subsequent call.
- */
+ /// Optional. Pass this token as the `page_token` field of the request for a
+ /// subsequent call.
core.String nextPageToken;
- /** The list of versions. */
+
+ /// The list of versions.
core.List<GoogleCloudMlV1Version> versions;
GoogleCloudMlV1ListVersionsResponse();
@@ -1852,12 +1852,15 @@ class GoogleCloudMlV1ListVersionsResponse {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("versions")) {
- versions = _json["versions"].map((value) => new GoogleCloudMlV1Version.fromJson(value)).toList();
+ versions = _json["versions"]
+ .map((value) => new GoogleCloudMlV1Version.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
@@ -1868,14 +1871,13 @@ class GoogleCloudMlV1ListVersionsResponse {
}
}
-/** Options for manually scaling a model. */
+/// Options for manually scaling a model.
class GoogleCloudMlV1ManualScaling {
- /**
- * The number of nodes to allocate for this model. These nodes are always up,
- * starting from the time the model is deployed, so the cost of operating
- * this model will be proportional to `nodes` * number of hours since
- * last billing cycle plus the cost for each prediction performed.
- */
+ /// The number of nodes to allocate for this model. These nodes are always
+ /// up,
+ /// starting from the time the model is deployed, so the cost of operating
+ /// this model will be proportional to `nodes` * number of hours since
+ /// last billing cycle plus the cost for each prediction performed.
core.int nodes;
GoogleCloudMlV1ManualScaling();
@@ -1887,7 +1889,8 @@ class GoogleCloudMlV1ManualScaling {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (nodes != null) {
_json["nodes"] = nodes;
}
@@ -1895,55 +1898,51 @@ class GoogleCloudMlV1ManualScaling {
}
}
-/**
- * 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.
- *
- * Next ID: 8
- */
+/// 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.
+///
+/// Next ID: 8
class GoogleCloudMlV1Model {
- /**
- * 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-engine/reference/rest/v1/projects.models.versions/setDefault).
- */
+ /// 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-engine/reference/rest/v1/projects.models.versions/setDefault).
GoogleCloudMlV1Version defaultVersion;
- /** Optional. The description specified for the model when it was created. */
+
+ /// 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.
- */
+
+ /// 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;
- /**
- * Optional. If true, enables StackDriver Logging for online prediction.
- * Default is false.
- */
+
+ /// Optional. If true, enables StackDriver Logging for online prediction.
+ /// Default is false.
core.bool onlinePredictionLogging;
- /**
- * Optional. The list of regions where the model is going to be deployed.
- * Currently only one region per model is supported.
- * Defaults to 'us-central1' if nothing is set.
- * Note:
- * * No matter where a model is deployed, it can always be accessed by
- * users from anywhere, both for online and batch prediction.
- * * The region for a batch prediction job is set by the region field when
- * submitting the batch prediction job and does not take its value from
- * this field.
- */
+
+ /// Optional. The list of regions where the model is going to be deployed.
+ /// Currently only one region per model is supported.
+ /// Defaults to 'us-central1' if nothing is set.
+ /// Note:
+ /// * No matter where a model is deployed, it can always be accessed by
+ /// users from anywhere, both for online and batch prediction.
+ /// * The region for a batch prediction job is set by the region field when
+ /// submitting the batch prediction job and does not take its value from
+ /// this field.
core.List<core.String> regions;
GoogleCloudMlV1Model();
GoogleCloudMlV1Model.fromJson(core.Map _json) {
if (_json.containsKey("defaultVersion")) {
- defaultVersion = new GoogleCloudMlV1Version.fromJson(_json["defaultVersion"]);
+ defaultVersion =
+ new GoogleCloudMlV1Version.fromJson(_json["defaultVersion"]);
}
if (_json.containsKey("description")) {
description = _json["description"];
@@ -1960,7 +1959,8 @@ class GoogleCloudMlV1Model {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (defaultVersion != null) {
_json["defaultVersion"] = (defaultVersion).toJson();
}
@@ -1980,34 +1980,36 @@ class GoogleCloudMlV1Model {
}
}
-/**
- * Represents the metadata of the long-running operation.
- *
- * Next ID: 9
- */
+/// Represents the metadata of the long-running operation.
+///
+/// Next ID: 9
class GoogleCloudMlV1OperationMetadata {
- /** The time the operation was submitted. */
+ /// The time the operation was submitted.
core.String createTime;
- /** The time operation processing completed. */
+
+ /// The time operation processing completed.
core.String endTime;
- /** Indicates whether a request to cancel this operation has been made. */
+
+ /// Indicates whether a request to cancel this operation has been made.
core.bool isCancellationRequested;
- /** Contains the name of the model associated with the operation. */
+
+ /// 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.
- * - "UPDATE_MODEL" : An operation to update an existing model.
- * - "UPDATE_VERSION" : An operation to update an existing version.
- */
+
+ /// 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.
+ /// - "UPDATE_MODEL" : An operation to update an existing model.
+ /// - "UPDATE_VERSION" : An operation to update an existing version.
core.String operationType;
- /** The time operation processing started. */
+
+ /// The time operation processing started.
core.String startTime;
- /** Contains the version associated with the operation. */
+
+ /// Contains the version associated with the operation.
GoogleCloudMlV1Version version;
GoogleCloudMlV1OperationMetadata();
@@ -2037,7 +2039,8 @@ class GoogleCloudMlV1OperationMetadata {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (createTime != null) {
_json["createTime"] = createTime;
}
@@ -2063,69 +2066,66 @@ class GoogleCloudMlV1OperationMetadata {
}
}
-/** Represents a single hyperparameter to optimize. */
+/// Represents a single hyperparameter to optimize.
class GoogleCloudMlV1ParameterSpec {
- /** Required if type is `CATEGORICAL`. The list of possible categories. */
+ /// 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.
- */
+
+ /// 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`.
- */
+
+ /// 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.
- */
+
+ /// 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".
- */
+
+ /// 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.
- */
+
+ /// 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.
- */
+
+ /// 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;
GoogleCloudMlV1ParameterSpec();
@@ -2155,7 +2155,8 @@ class GoogleCloudMlV1ParameterSpec {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (categoricalValues != null) {
_json["categoricalValues"] = categoricalValues;
}
@@ -2181,199 +2182,199 @@ class GoogleCloudMlV1ParameterSpec {
}
}
-/**
- * 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.
- *
- * Not all data includes 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 can be represented different ways. In this encoding scheme the first
- * two dimensions represent the rows and columns of the image, and the third
- * contains lists (vectors) of the R, G, and B values for each pixel.
- * <pre>
- * {
- * "instances": [
- * [
- * [
- * [138, 30, 66],
- * [130, 20, 56],
- * ...
- * ],
- * [
- * [126, 38, 61],
- * [122, 24, 57],
- * ...
- * ],
- * ...
- * ],
- * ...
- * ]
- * }
- * </pre>
- * JSON strings must be encoded as UTF-8. To send binary data, you must
- * base64-encode the data and mark it as binary. To mark a JSON string
- * as binary, replace it with a JSON object with a single attribute named `b64`:
- * <pre>{"b64": "..."} </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": [
- * [
- * [138, 30, 66],
- * [130, 20, 56],
- * ...
- * ],
- * [
- * [126, 38, 61],
- * [122, 24, 57],
- * ...
- * ],
- * ...
- * ]
- * },
- * {
- * "tag": "car",
- * "image": [
- * [
- * [255, 0, 102],
- * [255, 0, 97],
- * ...
- * ],
- * [
- * [254, 1, 101],
- * [254, 2, 93],
- * ...
- * ],
- * ...
- * ]
- * },
- * ...
- * ]
- * }
- * </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.
- */
+/// 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.
+///
+/// Not all data includes 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 can be represented different ways. In this encoding scheme the first
+/// two dimensions represent the rows and columns of the image, and the third
+/// contains lists (vectors) of the R, G, and B values for each pixel.
+/// <pre>
+/// {
+/// "instances": [
+/// [
+/// [
+/// [138, 30, 66],
+/// [130, 20, 56],
+/// ...
+/// ],
+/// [
+/// [126, 38, 61],
+/// [122, 24, 57],
+/// ...
+/// ],
+/// ...
+/// ],
+/// ...
+/// ]
+/// }
+/// </pre>
+/// JSON strings must be encoded as UTF-8. To send binary data, you must
+/// base64-encode the data and mark it as binary. To mark a JSON string
+/// as binary, replace it with a JSON object with a single attribute named
+/// `b64`:
+/// <pre>{"b64": "..."} </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": [
+/// [
+/// [138, 30, 66],
+/// [130, 20, 56],
+/// ...
+/// ],
+/// [
+/// [126, 38, 61],
+/// [122, 24, 57],
+/// ...
+/// ],
+/// ...
+/// ]
+/// },
+/// {
+/// "tag": "car",
+/// "image": [
+/// [
+/// [255, 0, 102],
+/// [255, 0, 97],
+/// ...
+/// ],
+/// [
+/// [254, 1, 101],
+/// [254, 2, 93],
+/// ...
+/// ],
+/// ...
+/// ]
+/// },
+/// ...
+/// ]
+/// }
+/// </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 GoogleCloudMlV1PredictRequest {
- /**
- *
- * Required. The prediction request body.
- */
+ ///
+ /// Required. The prediction request body.
GoogleApiHttpBody httpBody;
GoogleCloudMlV1PredictRequest();
@@ -2385,7 +2386,8 @@ class GoogleCloudMlV1PredictRequest {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (httpBody != null) {
_json["httpBody"] = (httpBody).toJson();
}
@@ -2393,68 +2395,61 @@ class GoogleCloudMlV1PredictRequest {
}
}
-/** Represents input parameters for a prediction job. */
+/// Represents input parameters for a prediction job.
class GoogleCloudMlV1PredictionInput {
- /**
- * Optional. Number of records per batch, defaults to 64.
- * The service will buffer batch_size number of records in memory before
- * invoking one Tensorflow prediction call internally. So take the record
- * size and memory available into consideration when setting this parameter.
- */
+ /// Optional. Number of records per batch, defaults to 64.
+ /// The service will buffer batch_size number of records in memory before
+ /// invoking one Tensorflow prediction call internally. So take the record
+ /// size and memory available into consideration when setting this parameter.
core.String batchSize;
- /**
- * 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.
- */
+
+ /// 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.
- */
+
+ /// 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.
- */
+
+ /// 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>"`
- */
+
+ /// 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. */
+
+ /// Required. The output Google Cloud Storage location.
core.String outputPath;
- /**
- * Required. The Google Compute Engine region to run the prediction job in.
- */
+
+ /// Required. The Google Compute Engine region to run the prediction job in.
core.String region;
- /**
- * Optional. The Google Cloud ML runtime version to use for this batch
- * prediction. If not set, Google Cloud ML will pick the runtime version used
- * during the CreateVersion request for this model version, or choose the
- * latest stable version when model version information is not available
- * such as when the model is specified by uri.
- */
+
+ /// Optional. The Google Cloud ML runtime version to use for this batch
+ /// prediction. If not set, Google Cloud ML will pick the runtime version
+ /// used
+ /// during the CreateVersion request for this model version, or choose the
+ /// latest stable version when model version information is not available
+ /// such as when the model is specified by uri.
core.String runtimeVersion;
- /**
- * Use this field if you want to specify a Google Cloud Storage path for
- * the model to use.
- */
+
+ /// Use this field if you want to specify a Google Cloud Storage path for
+ /// the model to use.
core.String uri;
- /**
- * Use this field if you want to specify a version of the model to use. The
- * string is formatted the same way as `model_version`, with the addition
- * of the version information:
- *
- * `"projects/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"`
- */
+
+ /// 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;
GoogleCloudMlV1PredictionInput();
@@ -2493,7 +2488,8 @@ class GoogleCloudMlV1PredictionInput {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (batchSize != null) {
_json["batchSize"] = batchSize;
}
@@ -2528,17 +2524,19 @@ class GoogleCloudMlV1PredictionInput {
}
}
-/** Represents results of a prediction job. */
+/// Represents results of a prediction job.
class GoogleCloudMlV1PredictionOutput {
- /** The number of data instances which resulted in errors. */
+ /// The number of data instances which resulted in errors.
core.String errorCount;
- /** Node hours used by the batch prediction job. */
+
+ /// Node hours used by the batch prediction job.
core.double nodeHours;
- /**
- * The output Google Cloud Storage location provided at the job creation time.
- */
+
+ /// The output Google Cloud Storage location provided at the job creation
+ /// time.
core.String outputPath;
- /** The number of generated predictions. */
+
+ /// The number of generated predictions.
core.String predictionCount;
GoogleCloudMlV1PredictionOutput();
@@ -2559,7 +2557,8 @@ class GoogleCloudMlV1PredictionOutput {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (errorCount != null) {
_json["errorCount"] = errorCount;
}
@@ -2576,175 +2575,170 @@ class GoogleCloudMlV1PredictionOutput {
}
}
-/** Request message for the SetDefaultVersion request. */
+/// Request message for the SetDefaultVersion request.
class GoogleCloudMlV1SetDefaultVersionRequest {
-
GoogleCloudMlV1SetDefaultVersionRequest();
- GoogleCloudMlV1SetDefaultVersionRequest.fromJson(core.Map _json) {
- }
+ GoogleCloudMlV1SetDefaultVersionRequest.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
return _json;
}
}
-/** Represents input parameters for a training job. */
+/// Represents input parameters for a training job.
class GoogleCloudMlV1TrainingInput {
- /** Optional. Command line arguments to pass to the program. */
+ /// Optional. Command line arguments to pass to the program.
core.List<core.String> args;
- /** Optional. The set of Hyperparameters to tune. */
+
+ /// Optional. The set of Hyperparameters to tune.
GoogleCloudMlV1HyperparameterSpec hyperparameters;
- /**
- * Optional. A Google Cloud Storage path in which to store training outputs
- * and other data needed for training. This path is passed to your TensorFlow
- * program as the 'job_dir' command-line argument. The benefit of specifying
- * this field is that Cloud ML validates the path for use in training.
- */
+
+ /// Optional. A Google Cloud Storage path in which to store training outputs
+ /// and other data needed for training. This path is passed to your
+ /// TensorFlow
+ /// program as the 'job_dir' command-line argument. The benefit of specifying
+ /// this field is that Cloud ML validates the path for use in training.
core.String jobDir;
- /**
- * Optional. Specifies the type of virtual machine to use for your training
- * job's master worker.
- *
- * The following types are supported:
- *
- * <dl>
- * <dt>standard</dt>
- * <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>
- * <dt>standard_gpu</dt>
- * <dd>
- * A machine equivalent to <code suppresswarning="true">standard</code> that
- * also includes a
- * <a href="/ml-engine/docs/how-tos/using-gpus">
- * GPU that you can use in your trainer</a>.
- * </dd>
- * <dt>complex_model_m_gpu</dt>
- * <dd>
- * A machine equivalent to
- * <code suppresswarning="true">complex_model_m</code> that also includes
- * four GPUs.
- * </dd>
- * </dl>
- *
- * You must set this value when `scaleTier` is set to `CUSTOM`.
- */
+
+ /// 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>
+ /// <dt>standard_gpu</dt>
+ /// <dd>
+ /// A machine equivalent to <code suppresswarning="true">standard</code> that
+ /// also includes a
+ /// <a href="/ml-engine/docs/how-tos/using-gpus">
+ /// GPU that you can use in your trainer</a>.
+ /// </dd>
+ /// <dt>complex_model_m_gpu</dt>
+ /// <dd>
+ /// A machine equivalent to
+ /// <code suppresswarning="true">complex_model_m</code> that also includes
+ /// four GPUs.
+ /// </dd>
+ /// </dl>
+ ///
+ /// You must set this value when `scaleTier` is set to `CUSTOM`.
core.String masterType;
- /**
- * Required. The Google Cloud Storage location of the packages with
- * the training program and any additional dependencies.
- * The maximum number of package URIs is 100.
- */
+
+ /// Required. The Google Cloud Storage location of the packages with
+ /// the training program and any additional dependencies.
+ /// The maximum number of package URIs is 100.
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`.
- */
+
+ /// 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.
- */
+
+ /// 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. */
+
+ /// 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. */
+
+ /// Required. The Google Compute Engine region to run the training job in.
core.String region;
- /**
- * Optional. The Google Cloud ML runtime version to use for training. If not
- * set, Google Cloud ML will choose the latest stable version.
- */
+
+ /// Optional. The Google Cloud ML runtime version to use for training. If
+ /// not
+ /// set, Google Cloud ML will choose the latest stable version.
core.String runtimeVersion;
- /**
- * Required. Specifies the machine types, the number of replicas for workers
- * and parameter servers.
- * Possible string values are:
- * - "BASIC" : A single worker instance. This tier is suitable for learning
- * how to use
- * Cloud ML, and for experimenting with new models using small datasets.
- * - "STANDARD_1" : Many workers and a few parameter servers.
- * - "PREMIUM_1" : A large number of workers with many parameter servers.
- * - "BASIC_GPU" : A single worker instance [with a
- * GPU](/ml-engine/docs/how-tos/using-gpus).
- * - "CUSTOM" : The CUSTOM tier is not a set tier, but rather enables you to
- * use your
- * own cluster specification. When you use this tier, set values to
- * configure your processing cluster according to these guidelines:
- *
- * * You _must_ set `TrainingInput.masterType` to specify the type
- * of machine to use for your master node. This is the only required
- * setting.
- *
- * * You _may_ set `TrainingInput.workerCount` to specify the number of
- * 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.
- */
+
+ /// Required. Specifies the machine types, the number of replicas for workers
+ /// and parameter servers.
+ /// Possible string values are:
+ /// - "BASIC" : A single worker instance. This tier is suitable for learning
+ /// how to use
+ /// Cloud ML, and for experimenting with new models using small datasets.
+ /// - "STANDARD_1" : Many workers and a few parameter servers.
+ /// - "PREMIUM_1" : A large number of workers with many parameter servers.
+ /// - "BASIC_GPU" : A single worker instance [with a
+ /// GPU](/ml-engine/docs/how-tos/using-gpus).
+ /// - "CUSTOM" : The CUSTOM tier is not a set tier, but rather enables you to
+ /// use your
+ /// own cluster specification. When you use this tier, set values to
+ /// configure your processing cluster according to these guidelines:
+ ///
+ /// * You _must_ set `TrainingInput.masterType` to specify the type
+ /// of machine to use for your master node. This is the only required
+ /// setting.
+ ///
+ /// * You _may_ set `TrainingInput.workerCount` to specify the number of
+ /// 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`.
- */
+
+ /// 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.
- */
+
+ /// 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;
GoogleCloudMlV1TrainingInput();
@@ -2754,7 +2748,8 @@ class GoogleCloudMlV1TrainingInput {
args = _json["args"];
}
if (_json.containsKey("hyperparameters")) {
- hyperparameters = new GoogleCloudMlV1HyperparameterSpec.fromJson(_json["hyperparameters"]);
+ hyperparameters = new GoogleCloudMlV1HyperparameterSpec.fromJson(
+ _json["hyperparameters"]);
}
if (_json.containsKey("jobDir")) {
jobDir = _json["jobDir"];
@@ -2792,7 +2787,8 @@ class GoogleCloudMlV1TrainingInput {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (args != null) {
_json["args"] = args;
}
@@ -2836,21 +2832,20 @@ class GoogleCloudMlV1TrainingInput {
}
}
-/** Represents results of a training job. Output only. */
+/// Represents results of a training job. Output only.
class GoogleCloudMlV1TrainingOutput {
- /**
- * The number of hyperparameter tuning trials that completed successfully.
- * Only set for hyperparameter tuning jobs.
- */
+ /// The number of hyperparameter tuning trials that completed successfully.
+ /// Only set for hyperparameter tuning jobs.
core.String completedTrialCount;
- /** The amount of ML units consumed by the job. */
+
+ /// The amount of ML units consumed by the job.
core.double consumedMLUnits;
- /** Whether this job is a hyperparameter tuning job. */
+
+ /// Whether this job is a hyperparameter tuning job.
core.bool isHyperparameterTuningJob;
- /**
- * Results for individual Hyperparameter trials.
- * Only set for hyperparameter tuning jobs.
- */
+
+ /// Results for individual Hyperparameter trials.
+ /// Only set for hyperparameter tuning jobs.
core.List<GoogleCloudMlV1HyperparameterOutput> trials;
GoogleCloudMlV1TrainingOutput();
@@ -2866,12 +2861,16 @@ class GoogleCloudMlV1TrainingOutput {
isHyperparameterTuningJob = _json["isHyperparameterTuningJob"];
}
if (_json.containsKey("trials")) {
- trials = _json["trials"].map((value) => new GoogleCloudMlV1HyperparameterOutput.fromJson(value)).toList();
+ trials = _json["trials"]
+ .map((value) =>
+ new GoogleCloudMlV1HyperparameterOutput.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (completedTrialCount != null) {
_json["completedTrialCount"] = completedTrialCount;
}
@@ -2888,94 +2887,87 @@ class GoogleCloudMlV1TrainingOutput {
}
}
-/**
- * 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-engine/reference/rest/v1/projects.models.versions/list).
- *
- * Next ID: 18
- */
+/// 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-engine/reference/rest/v1/projects.models.versions/list).
+///
+/// Next ID: 18
class GoogleCloudMlV1Version {
- /**
- * Automatically scale the number of nodes used to serve the model in
- * response to increases and decreases in traffic. Care should be
- * taken to ramp up traffic according to the model's ability to scale
- * or you will start seeing increases in latency and 429 response codes.
- */
+ /// Automatically scale the number of nodes used to serve the model in
+ /// response to increases and decreases in traffic. Care should be
+ /// taken to ramp up traffic according to the model's ability to scale
+ /// or you will start seeing increases in latency and 429 response codes.
GoogleCloudMlV1AutoScaling autoScaling;
- /** Output only. The time the version was created. */
+
+ /// 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-engine/docs/concepts/deployment-overview) for more
- * information.
- *
- * When passing Version to
- * [projects.models.versions.create](/ml-engine/reference/rest/v1/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.
- * The total number of model files can't exceed 1000.
- */
+
+ /// Required. The Google Cloud Storage location of the trained model used to
+ /// create the version. See the
+ /// [overview of model
+ /// deployment](/ml-engine/docs/concepts/deployment-overview) for more
+ /// information.
+ ///
+ /// When passing Version to
+ /// [projects.models.versions.create](/ml-engine/reference/rest/v1/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.
+ /// The total number of model files can't exceed 1000.
core.String deploymentUri;
- /**
- * Optional. The description specified for the version when it was created.
- */
+
+ /// Optional. The description specified for the version when it was created.
core.String description;
- /** Output only. The details of a failure or a cancellation. */
+
+ /// Output only. The details of a failure or a cancellation.
core.String errorMessage;
- /**
- * 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-engine/reference/rest/v1/projects.models.versions/setDefault).
- */
+
+ /// 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-engine/reference/rest/v1/projects.models.versions/setDefault).
core.bool isDefault;
- /** Output only. The time the version was last used for prediction. */
+
+ /// Output only. The time the version was last used for prediction.
core.String lastUseTime;
- /**
- * Manually select the number of nodes to use for serving the
- * model. You should generally use `auto_scaling` with an appropriate
- * `min_nodes` instead, but this option is available if you want more
- * predictable billing. Beware that latency and error rates will increase
- * if the traffic exceeds that capability of the system to serve it based
- * on the selected number of nodes.
- */
+
+ /// Manually select the number of nodes to use for serving the
+ /// model. You should generally use `auto_scaling` with an appropriate
+ /// `min_nodes` instead, but this option is available if you want more
+ /// predictable billing. Beware that latency and error rates will increase
+ /// if the traffic exceeds that capability of the system to serve it based
+ /// on the selected number of nodes.
GoogleCloudMlV1ManualScaling manualScaling;
- /**
- * Required.The name specified for the version when it was created.
- *
- * The version name must be unique within the model it is created in.
- */
+
+ /// Required.The name specified for the version when it was created.
+ ///
+ /// The version name must be unique within the model it is created in.
core.String name;
- /**
- * Optional. The Google Cloud ML runtime version to use for this deployment.
- * If not set, Google Cloud ML will choose a version.
- */
+
+ /// Optional. The Google Cloud ML runtime version to use for this deployment.
+ /// If not set, Google Cloud ML will choose a version.
core.String runtimeVersion;
- /**
- * Output only. The state of a version.
- * Possible string values are:
- * - "UNKNOWN" : The version state is unspecified.
- * - "READY" : The version is ready for prediction.
- * - "CREATING" : The version is in the process of creation.
- * - "FAILED" : The version failed to be created, possibly cancelled.
- * `error_message` should contain the details of the failure.
- * - "DELETING" : The version is in the process of deletion.
- */
+
+ /// Output only. The state of a version.
+ /// Possible string values are:
+ /// - "UNKNOWN" : The version state is unspecified.
+ /// - "READY" : The version is ready for prediction.
+ /// - "CREATING" : The version is in the process of creation.
+ /// - "FAILED" : The version failed to be created, possibly cancelled.
+ /// `error_message` should contain the details of the failure.
+ /// - "DELETING" : The version is in the process of deletion.
core.String state;
GoogleCloudMlV1Version();
GoogleCloudMlV1Version.fromJson(core.Map _json) {
if (_json.containsKey("autoScaling")) {
- autoScaling = new GoogleCloudMlV1AutoScaling.fromJson(_json["autoScaling"]);
+ autoScaling =
+ new GoogleCloudMlV1AutoScaling.fromJson(_json["autoScaling"]);
}
if (_json.containsKey("createTime")) {
createTime = _json["createTime"];
@@ -2996,7 +2988,8 @@ class GoogleCloudMlV1Version {
lastUseTime = _json["lastUseTime"];
}
if (_json.containsKey("manualScaling")) {
- manualScaling = new GoogleCloudMlV1ManualScaling.fromJson(_json["manualScaling"]);
+ manualScaling =
+ new GoogleCloudMlV1ManualScaling.fromJson(_json["manualScaling"]);
}
if (_json.containsKey("name")) {
name = _json["name"];
@@ -3010,7 +3003,8 @@ class GoogleCloudMlV1Version {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (autoScaling != null) {
_json["autoScaling"] = (autoScaling).toJson();
}
@@ -3048,511 +3042,75 @@ class GoogleCloudMlV1Version {
}
}
-/** Options for automatically scaling a model. */
-class GoogleCloudMlV1beta1AutoScaling {
- /**
- * Optional. The minimum number of nodes to allocate for this model. These
- * nodes are always up, starting from the time the model is deployed, so the
- * cost of operating this model will be at least
- * `rate` * `min_nodes` * number of hours since last billing cycle,
- * where `rate` is the cost per node-hour as documented in
- * [pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),
- * even if no predictions are performed. There is additional cost for each
- * prediction performed.
- *
- * Unlike manual scaling, if the load gets too heavy for the nodes
- * that are up, the service will automatically add nodes to handle the
- * increased load as well as scale back as traffic drops, always maintaining
- * at least `min_nodes`. You will be charged for the time in which additional
- * nodes are used.
- *
- * If not specified, `min_nodes` defaults to 0, in which case, when traffic
- * to a model stops (and after a cool-down period), nodes will be shut down
- * and no charges will be incurred until traffic to the model resumes.
- */
- core.int minNodes;
-
- GoogleCloudMlV1beta1AutoScaling();
-
- GoogleCloudMlV1beta1AutoScaling.fromJson(core.Map _json) {
- if (_json.containsKey("minNodes")) {
- minNodes = _json["minNodes"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (minNodes != null) {
- _json["minNodes"] = minNodes;
- }
- return _json;
- }
-}
-
-/** Options for manually scaling a model. */
-class GoogleCloudMlV1beta1ManualScaling {
- /**
- * The number of nodes to allocate for this model. These nodes are always up,
- * starting from the time the model is deployed, so the cost of operating
- * this model will be proportional to `nodes` * number of hours since
- * last billing cycle plus the cost for each prediction performed.
- */
- core.int nodes;
-
- GoogleCloudMlV1beta1ManualScaling();
-
- GoogleCloudMlV1beta1ManualScaling.fromJson(core.Map _json) {
- if (_json.containsKey("nodes")) {
- nodes = _json["nodes"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (nodes != null) {
- _json["nodes"] = nodes;
- }
- return _json;
- }
-}
-
-/**
- * Represents the metadata of the long-running operation.
- *
- * Next ID: 9
- */
-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.
- * - "UPDATE_MODEL" : An operation to update an existing model.
- * - "UPDATE_VERSION" : An operation to update an existing version.
- */
- 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<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- 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 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-engine/reference/rest/v1beta1/projects.models.versions/list).
- *
- * Next ID: 18
- */
-class GoogleCloudMlV1beta1Version {
- /**
- * Automatically scale the number of nodes used to serve the model in
- * response to increases and decreases in traffic. Care should be
- * taken to ramp up traffic according to the model's ability to scale
- * or you will start seeing increases in latency and 429 response codes.
- */
- GoogleCloudMlV1beta1AutoScaling autoScaling;
- /** 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-engine/docs/concepts/deployment-overview) for more
- * information.
- *
- * When passing Version to
- * [projects.models.versions.create](/ml-engine/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.
- * The total number of model files can't exceed 1000.
- */
- core.String deploymentUri;
- /**
- * Optional. The description specified for the version when it was created.
- */
- core.String description;
- /** Output only. The details of a failure or a cancellation. */
- core.String errorMessage;
- /**
- * 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-engine/reference/rest/v1beta1/projects.models.versions/setDefault).
- */
- core.bool isDefault;
- /** Output only. The time the version was last used for prediction. */
- core.String lastUseTime;
- /**
- * Manually select the number of nodes to use for serving the
- * model. You should generally use `auto_scaling` with an appropriate
- * `min_nodes` instead, but this option is available if you want more
- * predictable billing. Beware that latency and error rates will increase
- * if the traffic exceeds that capability of the system to serve it based
- * on the selected number of nodes.
- */
- GoogleCloudMlV1beta1ManualScaling manualScaling;
- /**
- * Required.The name specified for the version when it was created.
- *
- * The version name must be unique within the model it is created in.
- */
- core.String name;
- /**
- * Optional. The Google Cloud ML runtime version to use for this deployment.
- * If not set, Google Cloud ML will choose a version.
- */
- core.String runtimeVersion;
- /**
- * Output only. The state of a version.
- * Possible string values are:
- * - "UNKNOWN" : The version state is unspecified.
- * - "READY" : The version is ready for prediction.
- * - "CREATING" : The version is in the process of creation.
- * - "FAILED" : The version failed to be created, possibly cancelled.
- * `error_message` should contain the details of the failure.
- * - "DELETING" : The version is in the process of deletion.
- */
- core.String state;
-
- GoogleCloudMlV1beta1Version();
-
- GoogleCloudMlV1beta1Version.fromJson(core.Map _json) {
- if (_json.containsKey("autoScaling")) {
- autoScaling = new GoogleCloudMlV1beta1AutoScaling.fromJson(_json["autoScaling"]);
- }
- if (_json.containsKey("createTime")) {
- createTime = _json["createTime"];
- }
- if (_json.containsKey("deploymentUri")) {
- deploymentUri = _json["deploymentUri"];
- }
- if (_json.containsKey("description")) {
- description = _json["description"];
- }
- if (_json.containsKey("errorMessage")) {
- errorMessage = _json["errorMessage"];
- }
- if (_json.containsKey("isDefault")) {
- isDefault = _json["isDefault"];
- }
- if (_json.containsKey("lastUseTime")) {
- lastUseTime = _json["lastUseTime"];
- }
- if (_json.containsKey("manualScaling")) {
- manualScaling = new GoogleCloudMlV1beta1ManualScaling.fromJson(_json["manualScaling"]);
- }
- if (_json.containsKey("name")) {
- name = _json["name"];
- }
- if (_json.containsKey("runtimeVersion")) {
- runtimeVersion = _json["runtimeVersion"];
- }
- if (_json.containsKey("state")) {
- state = _json["state"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (autoScaling != null) {
- _json["autoScaling"] = (autoScaling).toJson();
- }
- if (createTime != null) {
- _json["createTime"] = createTime;
- }
- if (deploymentUri != null) {
- _json["deploymentUri"] = deploymentUri;
- }
- if (description != null) {
- _json["description"] = description;
- }
- if (errorMessage != null) {
- _json["errorMessage"] = errorMessage;
- }
- if (isDefault != null) {
- _json["isDefault"] = isDefault;
- }
- if (lastUseTime != null) {
- _json["lastUseTime"] = lastUseTime;
- }
- if (manualScaling != null) {
- _json["manualScaling"] = (manualScaling).toJson();
- }
- if (name != null) {
- _json["name"] = name;
- }
- if (runtimeVersion != null) {
- _json["runtimeVersion"] = runtimeVersion;
- }
- if (state != null) {
- _json["state"] = state;
- }
- return _json;
- }
-}
-
-/** Write a Cloud Audit log */
-class GoogleIamV1LogConfigCloudAuditOptions {
- /**
- * The log_name to populate in the Cloud Audit Record.
- * Possible string values are:
- * - "UNSPECIFIED_LOG_NAME" : Default. Should not be used.
- * - "ADMIN_ACTIVITY" : Corresponds to "cloudaudit.googleapis.com/activity"
- * - "DATA_ACCESS" : Corresponds to "cloudaudit.googleapis.com/data_access"
- */
- core.String logName;
-
- GoogleIamV1LogConfigCloudAuditOptions();
-
- GoogleIamV1LogConfigCloudAuditOptions.fromJson(core.Map _json) {
- if (_json.containsKey("logName")) {
- logName = _json["logName"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (logName != null) {
- _json["logName"] = logName;
- }
- return _json;
- }
-}
-
-/**
- * Increment a streamz counter with the specified metric and field names.
- *
- * Metric names should start with a '/', generally be lowercase-only,
- * and end in "_count". Field names should not contain an initial slash.
- * The actual exported metric names will have "/iam/policy" prepended.
- *
- * Field names correspond to IAM request parameters and field values are
- * their respective values.
- *
- * At present the only supported field names are
- * - "iam_principal", corresponding to IAMContext.principal;
- * - "" (empty string), resulting in one aggretated counter with no field.
- *
- * Examples:
- * counter { metric: "/debug_access_count" field: "iam_principal" }
- * ==> increment counter /iam/policy/backend_debug_access_count
- * {iam_principal=[value of IAMContext.principal]}
- *
- * At this time we do not support:
- * * multiple field names (though this may be supported in the future)
- * * decrementing the counter
- * * incrementing it by anything other than 1
- */
-class GoogleIamV1LogConfigCounterOptions {
- /** The field value to attribute. */
- core.String field;
- /** The metric to update. */
- core.String metric;
-
- GoogleIamV1LogConfigCounterOptions();
-
- GoogleIamV1LogConfigCounterOptions.fromJson(core.Map _json) {
- if (_json.containsKey("field")) {
- field = _json["field"];
- }
- if (_json.containsKey("metric")) {
- metric = _json["metric"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (field != null) {
- _json["field"] = field;
- }
- if (metric != null) {
- _json["metric"] = metric;
- }
- return _json;
- }
-}
-
-/** Write a Data Access (Gin) log */
-class GoogleIamV1LogConfigDataAccessOptions {
- /**
- * Whether Gin logging should happen in a fail-closed manner at the caller.
- * This is relevant only in the LocalIAM implementation, for now.
- * Possible string values are:
- * - "LOG_MODE_UNSPECIFIED" : Client is not required to write a partial Gin
- * log immediately after
- * the authorization check. If client chooses to write one and it fails,
- * client may either fail open (allow the operation to continue) or
- * fail closed (handle as a DENY outcome).
- * - "LOG_FAIL_CLOSED" : The application's operation in the context of which
- * this authorization
- * check is being made may only be performed if it is successfully logged
- * to Gin. For instance, the authorization library may satisfy this
- * obligation by emitting a partial log entry at authorization check time
- * and only returning ALLOW to the application if it succeeds.
- *
- * If a matching Rule has this directive, but the client has not indicated
- * that it will honor such requirements, then the IAM check will result in
- * authorization failure by setting CheckPolicyResponse.success=false.
- */
- core.String logMode;
-
- GoogleIamV1LogConfigDataAccessOptions();
-
- GoogleIamV1LogConfigDataAccessOptions.fromJson(core.Map _json) {
- if (_json.containsKey("logMode")) {
- logMode = _json["logMode"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (logMode != null) {
- _json["logMode"] = logMode;
- }
- return _json;
- }
-}
-
-/**
- * Specifies the audit configuration for a service.
- * The configuration determines which permission types are logged, and what
- * identities, if any, are exempted from logging.
- * An AuditConfig must have one or more AuditLogConfigs.
- *
- * If there are AuditConfigs for both `allServices` and a specific service,
- * the union of the two AuditConfigs is used for that service: the log_types
- * specified in each AuditConfig are enabled, and the exempted_members in each
- * AuditConfig are exempted.
- *
- * Example Policy with multiple AuditConfigs:
- *
- * {
- * "audit_configs": [
- * {
- * "service": "allServices"
- * "audit_log_configs": [
- * {
- * "log_type": "DATA_READ",
- * "exempted_members": [
- * "user:foo@gmail.com"
- * ]
- * },
- * {
- * "log_type": "DATA_WRITE",
- * },
- * {
- * "log_type": "ADMIN_READ",
- * }
- * ]
- * },
- * {
- * "service": "fooservice.googleapis.com"
- * "audit_log_configs": [
- * {
- * "log_type": "DATA_READ",
- * },
- * {
- * "log_type": "DATA_WRITE",
- * "exempted_members": [
- * "user:bar@gmail.com"
- * ]
- * }
- * ]
- * }
- * ]
- * }
- *
- * For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- * logging. It also exempts foo@gmail.com from DATA_READ logging, and
- * bar@gmail.com from DATA_WRITE logging.
- */
+/// Specifies the audit configuration for a service.
+/// The configuration determines which permission types are logged, and what
+/// identities, if any, are exempted from logging.
+/// An AuditConfig must have one or more AuditLogConfigs.
+///
+/// If there are AuditConfigs for both `allServices` and a specific service,
+/// the union of the two AuditConfigs is used for that service: the log_types
+/// specified in each AuditConfig are enabled, and the exempted_members in each
+/// AuditConfig are exempted.
+///
+/// Example Policy with multiple AuditConfigs:
+///
+/// {
+/// "audit_configs": [
+/// {
+/// "service": "allServices"
+/// "audit_log_configs": [
+/// {
+/// "log_type": "DATA_READ",
+/// "exempted_members": [
+/// "user:foo@gmail.com"
+/// ]
+/// },
+/// {
+/// "log_type": "DATA_WRITE",
+/// },
+/// {
+/// "log_type": "ADMIN_READ",
+/// }
+/// ]
+/// },
+/// {
+/// "service": "fooservice.googleapis.com"
+/// "audit_log_configs": [
+/// {
+/// "log_type": "DATA_READ",
+/// },
+/// {
+/// "log_type": "DATA_WRITE",
+/// "exempted_members": [
+/// "user:bar@gmail.com"
+/// ]
+/// }
+/// ]
+/// }
+/// ]
+/// }
+///
+/// For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+/// logging. It also exempts foo@gmail.com from DATA_READ logging, and
+/// bar@gmail.com from DATA_WRITE logging.
class GoogleIamV1AuditConfig {
- /**
- * The configuration for logging of each type of permission.
- * Next ID: 4
- */
+ /// The configuration for logging of each type of permission.
+ /// Next ID: 4
core.List<GoogleIamV1AuditLogConfig> auditLogConfigs;
core.List<core.String> exemptedMembers;
- /**
- * Specifies a service that will be enabled for audit logging.
- * For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
- * `allServices` is a special value that covers all services.
- */
+
+ /// Specifies a service that will be enabled for audit logging.
+ /// For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ /// `allServices` is a special value that covers all services.
core.String service;
GoogleIamV1AuditConfig();
GoogleIamV1AuditConfig.fromJson(core.Map _json) {
if (_json.containsKey("auditLogConfigs")) {
- auditLogConfigs = _json["auditLogConfigs"].map((value) => new GoogleIamV1AuditLogConfig.fromJson(value)).toList();
+ auditLogConfigs = _json["auditLogConfigs"]
+ .map((value) => new GoogleIamV1AuditLogConfig.fromJson(value))
+ .toList();
}
if (_json.containsKey("exemptedMembers")) {
exemptedMembers = _json["exemptedMembers"];
@@ -3563,9 +3121,11 @@ class GoogleIamV1AuditConfig {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (auditLogConfigs != null) {
- _json["auditLogConfigs"] = auditLogConfigs.map((value) => (value).toJson()).toList();
+ _json["auditLogConfigs"] =
+ auditLogConfigs.map((value) => (value).toJson()).toList();
}
if (exemptedMembers != null) {
_json["exemptedMembers"] = exemptedMembers;
@@ -3577,42 +3137,37 @@ class GoogleIamV1AuditConfig {
}
}
-/**
- * Provides the configuration for logging a type of permissions.
- * Example:
- *
- * {
- * "audit_log_configs": [
- * {
- * "log_type": "DATA_READ",
- * "exempted_members": [
- * "user:foo@gmail.com"
- * ]
- * },
- * {
- * "log_type": "DATA_WRITE",
- * }
- * ]
- * }
- *
- * This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- * foo@gmail.com from DATA_READ logging.
- */
+/// Provides the configuration for logging a type of permissions.
+/// Example:
+///
+/// {
+/// "audit_log_configs": [
+/// {
+/// "log_type": "DATA_READ",
+/// "exempted_members": [
+/// "user:foo@gmail.com"
+/// ]
+/// },
+/// {
+/// "log_type": "DATA_WRITE",
+/// }
+/// ]
+/// }
+///
+/// This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+/// foo@gmail.com from DATA_READ logging.
class GoogleIamV1AuditLogConfig {
- /**
- * Specifies the identities that do not cause logging for this type of
- * permission.
- * Follows the same format of Binding.members.
- */
+ /// Specifies the identities that do not cause logging for this type of
+ /// permission.
+ /// Follows the same format of Binding.members.
core.List<core.String> exemptedMembers;
- /**
- * The log type that this config enables.
- * Possible string values are:
- * - "LOG_TYPE_UNSPECIFIED" : Default case. Should never be this.
- * - "ADMIN_READ" : Admin reads. Example: CloudIAM getIamPolicy
- * - "DATA_WRITE" : Data writes. Example: CloudSQL Users create
- * - "DATA_READ" : Data reads. Example: CloudSQL Users list
- */
+
+ /// The log type that this config enables.
+ /// Possible string values are:
+ /// - "LOG_TYPE_UNSPECIFIED" : Default case. Should never be this.
+ /// - "ADMIN_READ" : Admin reads. Example: CloudIAM getIamPolicy
+ /// - "DATA_WRITE" : Data writes. Example: CloudSQL Users create
+ /// - "DATA_READ" : Data reads. Example: CloudSQL Users list
core.String logType;
GoogleIamV1AuditLogConfig();
@@ -3627,7 +3182,8 @@ class GoogleIamV1AuditLogConfig {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (exemptedMembers != null) {
_json["exemptedMembers"] = exemptedMembers;
}
@@ -3638,46 +3194,42 @@ class GoogleIamV1AuditLogConfig {
}
}
-/** Associates `members` with a `role`. */
+/// Associates `members` with a `role`.
class GoogleIamV1Binding {
- /**
- * The condition that is associated with this binding.
- * NOTE: an unsatisfied condition will not allow user access via current
- * binding. Different bindings, including their conditions, are examined
- * independently.
- * This field is GOOGLE_INTERNAL.
- */
+ /// The condition that is associated with this binding.
+ /// NOTE: an unsatisfied condition will not allow user access via current
+ /// binding. Different bindings, including their conditions, are examined
+ /// independently.
+ /// This field is GOOGLE_INTERNAL.
GoogleTypeExpr condition;
- /**
- * Specifies the identities requesting access for a Cloud Platform resource.
- * `members` can have the following values:
- *
- * * `allUsers`: A special identifier that represents anyone who is
- * on the internet; with or without a Google account.
- *
- * * `allAuthenticatedUsers`: A special identifier that represents anyone
- * who is authenticated with a Google account or a service account.
- *
- * * `user:{emailid}`: An email address that represents a specific Google
- * account. For example, `alice@gmail.com` or `joe@example.com`.
- *
- *
- * * `serviceAccount:{emailid}`: An email address that represents a service
- * account. For example, `my-other-app@appspot.gserviceaccount.com`.
- *
- * * `group:{emailid}`: An email address that represents a Google group.
- * For example, `admins@example.com`.
- *
- *
- * * `domain:{domain}`: A Google Apps domain name that represents all the
- * users of that domain. For example, `google.com` or `example.com`.
- */
+
+ /// Specifies the identities requesting access for a Cloud Platform resource.
+ /// `members` can have the following values:
+ ///
+ /// * `allUsers`: A special identifier that represents anyone who is
+ /// on the internet; with or without a Google account.
+ ///
+ /// * `allAuthenticatedUsers`: A special identifier that represents anyone
+ /// who is authenticated with a Google account or a service account.
+ ///
+ /// * `user:{emailid}`: An email address that represents a specific Google
+ /// account. For example, `alice@gmail.com` or `joe@example.com`.
+ ///
+ ///
+ /// * `serviceAccount:{emailid}`: An email address that represents a service
+ /// account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ ///
+ /// * `group:{emailid}`: An email address that represents a Google group.
+ /// For example, `admins@example.com`.
+ ///
+ ///
+ /// * `domain:{domain}`: A Google Apps domain name that represents all the
+ /// users of that domain. For example, `google.com` or `example.com`.
core.List<core.String> members;
- /**
- * Role that is assigned to `members`.
- * For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- * Required
- */
+
+ /// Role that is assigned to `members`.
+ /// For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ /// Required
core.String role;
GoogleIamV1Binding();
@@ -3695,7 +3247,8 @@ class GoogleIamV1Binding {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (condition != null) {
_json["condition"] = (condition).toJson();
}
@@ -3709,238 +3262,85 @@ class GoogleIamV1Binding {
}
}
-/** A condition to be met. */
-class GoogleIamV1Condition {
- /**
- * Trusted attributes supplied by the IAM system.
- * Possible string values are:
- * - "NO_ATTR" : Default non-attribute.
- * - "AUTHORITY" : Either principal or (if present) authority selector.
- * - "ATTRIBUTION" : The principal (even if an authority selector is present),
- * which
- * must only be used for attribution, not authorization.
- * - "APPROVER" : An approver (distinct from the requester) that has
- * authorized this
- * request.
- * When used with IN, the condition indicates that one of the approvers
- * associated with the request matches the specified principal, or is a
- * member of the specified group. Approvers can only grant additional
- * access, and are thus only used in a strictly positive context
- * (e.g. ALLOW/IN or DENY/NOT_IN).
- * - "JUSTIFICATION_TYPE" : What types of justifications have been supplied
- * with this request.
- * String values should match enum names from tech.iam.JustificationType,
- * e.g. "MANUAL_STRING". It is not permitted to grant access based on
- * the *absence* of a justification, so justification conditions can only
- * be used in a "positive" context (e.g., ALLOW/IN or DENY/NOT_IN).
- *
- * Multiple justifications, e.g., a Buganizer ID and a manually-entered
- * reason, are normal and supported.
- */
- core.String iam;
- /**
- * An operator to apply the subject with.
- * Possible string values are:
- * - "NO_OP" : Default no-op.
- * - "EQUALS" : DEPRECATED. Use IN instead.
- * - "NOT_EQUALS" : DEPRECATED. Use NOT_IN instead.
- * - "IN" : The condition is true if the subject (or any element of it if it
- * is
- * a set) matches any of the supplied values.
- * - "NOT_IN" : The condition is true if the subject (or every element of it
- * if it is
- * a set) matches none of the supplied values.
- * - "DISCHARGED" : Subject is discharged
- */
- core.String op;
- /** Trusted attributes discharged by the service. */
- core.String svc;
- /**
- * Trusted attributes supplied by any service that owns resources and uses
- * the IAM system for access control.
- * Possible string values are:
- * - "NO_ATTR" : Default non-attribute type
- * - "REGION" : Region of the resource
- * - "SERVICE" : Service name
- * - "NAME" : Resource name
- * - "IP" : IP address of the caller
- */
- core.String sys;
- /** DEPRECATED. Use 'values' instead. */
- core.String value;
- /** The objects of the condition. This is mutually exclusive with 'value'. */
- core.List<core.String> values;
-
- GoogleIamV1Condition();
-
- GoogleIamV1Condition.fromJson(core.Map _json) {
- if (_json.containsKey("iam")) {
- iam = _json["iam"];
- }
- if (_json.containsKey("op")) {
- op = _json["op"];
- }
- if (_json.containsKey("svc")) {
- svc = _json["svc"];
- }
- if (_json.containsKey("sys")) {
- sys = _json["sys"];
- }
- if (_json.containsKey("value")) {
- value = _json["value"];
- }
- if (_json.containsKey("values")) {
- values = _json["values"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (iam != null) {
- _json["iam"] = iam;
- }
- if (op != null) {
- _json["op"] = op;
- }
- if (svc != null) {
- _json["svc"] = svc;
- }
- if (sys != null) {
- _json["sys"] = sys;
- }
- if (value != null) {
- _json["value"] = value;
- }
- if (values != null) {
- _json["values"] = values;
- }
- return _json;
- }
-}
-
-/** Specifies what kind of log the caller must write */
-class GoogleIamV1LogConfig {
- /** Cloud audit options. */
- GoogleIamV1LogConfigCloudAuditOptions cloudAudit;
- /** Counter options. */
- GoogleIamV1LogConfigCounterOptions counter;
- /** Data access options. */
- GoogleIamV1LogConfigDataAccessOptions dataAccess;
-
- GoogleIamV1LogConfig();
-
- GoogleIamV1LogConfig.fromJson(core.Map _json) {
- if (_json.containsKey("cloudAudit")) {
- cloudAudit = new GoogleIamV1LogConfigCloudAuditOptions.fromJson(_json["cloudAudit"]);
- }
- if (_json.containsKey("counter")) {
- counter = new GoogleIamV1LogConfigCounterOptions.fromJson(_json["counter"]);
- }
- if (_json.containsKey("dataAccess")) {
- dataAccess = new GoogleIamV1LogConfigDataAccessOptions.fromJson(_json["dataAccess"]);
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (cloudAudit != null) {
- _json["cloudAudit"] = (cloudAudit).toJson();
- }
- if (counter != null) {
- _json["counter"] = (counter).toJson();
- }
- if (dataAccess != null) {
- _json["dataAccess"] = (dataAccess).toJson();
- }
- return _json;
- }
-}
-
-/**
- * Defines an Identity and Access Management (IAM) policy. It is used to
- * specify access control policies for Cloud Platform resources.
- *
- *
- * A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
- * `members` to a `role`, where the members can be user accounts, Google groups,
- * Google domains, and service accounts. A `role` is a named list of permissions
- * defined by IAM.
- *
- * **Example**
- *
- * {
- * "bindings": [
- * {
- * "role": "roles/owner",
- * "members": [
- * "user:mike@example.com",
- * "group:admins@example.com",
- * "domain:google.com",
- * "serviceAccount:my-other-app@appspot.gserviceaccount.com",
- * ]
- * },
- * {
- * "role": "roles/viewer",
- * "members": ["user:sean@example.com"]
- * }
- * ]
- * }
- *
- * For a description of IAM and its features, see the
- * [IAM developer's guide](https://cloud.google.com/iam).
- */
+/// Defines an Identity and Access Management (IAM) policy. It is used to
+/// specify access control policies for Cloud Platform resources.
+///
+///
+/// A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+/// `members` to a `role`, where the members can be user accounts, Google
+/// groups,
+/// Google domains, and service accounts. A `role` is a named list of
+/// permissions
+/// defined by IAM.
+///
+/// **Example**
+///
+/// {
+/// "bindings": [
+/// {
+/// "role": "roles/owner",
+/// "members": [
+/// "user:mike@example.com",
+/// "group:admins@example.com",
+/// "domain:google.com",
+/// "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+/// ]
+/// },
+/// {
+/// "role": "roles/viewer",
+/// "members": ["user:sean@example.com"]
+/// }
+/// ]
+/// }
+///
+/// For a description of IAM and its features, see the
+/// [IAM developer's guide](https://cloud.google.com/iam).
class GoogleIamV1Policy {
- /** Specifies cloud audit logging configuration for this policy. */
+ /// Specifies cloud audit logging configuration for this policy.
core.List<GoogleIamV1AuditConfig> auditConfigs;
- /**
- * Associates a list of `members` to a `role`.
- * `bindings` with no members will result in an error.
- */
+
+ /// Associates a list of `members` to a `role`.
+ /// `bindings` with no members will result in an error.
core.List<GoogleIamV1Binding> bindings;
- /**
- * `etag` is used for optimistic concurrency control as a way to help
- * prevent simultaneous updates of a policy from overwriting each other.
- * It is strongly suggested that systems make use of the `etag` in the
- * read-modify-write cycle to perform policy updates in order to avoid race
- * conditions: An `etag` is returned in the response to `getIamPolicy`, and
- * systems are expected to put that etag in the request to `setIamPolicy` to
- * ensure that their change will be applied to the same version of the policy.
- *
- * If no `etag` is provided in the call to `setIamPolicy`, then the existing
- * policy is overwritten blindly.
- */
+
+ /// `etag` is used for optimistic concurrency control as a way to help
+ /// prevent simultaneous updates of a policy from overwriting each other.
+ /// It is strongly suggested that systems make use of the `etag` in the
+ /// read-modify-write cycle to perform policy updates in order to avoid race
+ /// conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ /// systems are expected to put that etag in the request to `setIamPolicy` to
+ /// ensure that their change will be applied to the same version of the
+ /// policy.
+ ///
+ /// If no `etag` is provided in the call to `setIamPolicy`, then the existing
+ /// policy is overwritten blindly.
core.String etag;
core.List<core.int> get etagAsBytes {
return convert.BASE64.decode(etag);
}
void set etagAsBytes(core.List<core.int> _bytes) {
- etag = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
+ etag =
+ convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
+
core.bool iamOwned;
- /**
- * If more than one rule is specified, the rules are applied in the following
- * manner:
- * - All matching LOG rules are always applied.
- * - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
- * Logging will be applied if one or more matching rule requires logging.
- * - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
- * granted.
- * Logging will be applied if one or more matching rule requires logging.
- * - Otherwise, if no rule applies, permission is denied.
- */
- core.List<GoogleIamV1Rule> rules;
- /** Version of the `Policy`. The default version is 0. */
+
+ /// Version of the `Policy`. The default version is 0.
core.int version;
GoogleIamV1Policy();
GoogleIamV1Policy.fromJson(core.Map _json) {
if (_json.containsKey("auditConfigs")) {
- auditConfigs = _json["auditConfigs"].map((value) => new GoogleIamV1AuditConfig.fromJson(value)).toList();
+ auditConfigs = _json["auditConfigs"]
+ .map((value) => new GoogleIamV1AuditConfig.fromJson(value))
+ .toList();
}
if (_json.containsKey("bindings")) {
- bindings = _json["bindings"].map((value) => new GoogleIamV1Binding.fromJson(value)).toList();
+ bindings = _json["bindings"]
+ .map((value) => new GoogleIamV1Binding.fromJson(value))
+ .toList();
}
if (_json.containsKey("etag")) {
etag = _json["etag"];
@@ -3948,18 +3348,17 @@ class GoogleIamV1Policy {
if (_json.containsKey("iamOwned")) {
iamOwned = _json["iamOwned"];
}
- if (_json.containsKey("rules")) {
- rules = _json["rules"].map((value) => new GoogleIamV1Rule.fromJson(value)).toList();
- }
if (_json.containsKey("version")) {
version = _json["version"];
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (auditConfigs != null) {
- _json["auditConfigs"] = auditConfigs.map((value) => (value).toJson()).toList();
+ _json["auditConfigs"] =
+ auditConfigs.map((value) => (value).toJson()).toList();
}
if (bindings != null) {
_json["bindings"] = bindings.map((value) => (value).toJson()).toList();
@@ -3970,9 +3369,6 @@ class GoogleIamV1Policy {
if (iamOwned != null) {
_json["iamOwned"] = iamOwned;
}
- if (rules != null) {
- _json["rules"] = rules.map((value) => (value).toJson()).toList();
- }
if (version != null) {
_json["version"] = version;
}
@@ -3980,120 +3376,21 @@ class GoogleIamV1Policy {
}
}
-/** A rule to be applied in a Policy. */
-class GoogleIamV1Rule {
- /**
- * Required
- * Possible string values are:
- * - "NO_ACTION" : Default no action.
- * - "ALLOW" : Matching 'Entries' grant access.
- * - "ALLOW_WITH_LOG" : Matching 'Entries' grant access and the caller
- * promises to log
- * the request per the returned log_configs.
- * - "DENY" : Matching 'Entries' deny access.
- * - "DENY_WITH_LOG" : Matching 'Entries' deny access and the caller promises
- * to log
- * the request per the returned log_configs.
- * - "LOG" : Matching 'Entries' tell IAM.Check callers to generate logs.
- */
- core.String action;
- /** Additional restrictions that must be met */
- core.List<GoogleIamV1Condition> conditions;
- /** Human-readable description of the rule. */
- core.String description;
- /**
- * If one or more 'in' clauses are specified, the rule matches if
- * the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
- */
- core.List<core.String> in_;
- /**
- * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
- * that match the LOG action.
- */
- core.List<GoogleIamV1LogConfig> logConfig;
- /**
- * If one or more 'not_in' clauses are specified, the rule matches
- * if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
- * The format for in and not_in entries is the same as for members in a
- * Binding (see google/iam/v1/policy.proto).
- */
- core.List<core.String> notIn;
- /**
- * A permission is a string of form '<service>.<resource type>.<verb>'
- * (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
- * and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
- */
- core.List<core.String> permissions;
-
- GoogleIamV1Rule();
-
- GoogleIamV1Rule.fromJson(core.Map _json) {
- if (_json.containsKey("action")) {
- action = _json["action"];
- }
- if (_json.containsKey("conditions")) {
- conditions = _json["conditions"].map((value) => new GoogleIamV1Condition.fromJson(value)).toList();
- }
- if (_json.containsKey("description")) {
- description = _json["description"];
- }
- if (_json.containsKey("in")) {
- in_ = _json["in"];
- }
- if (_json.containsKey("logConfig")) {
- logConfig = _json["logConfig"].map((value) => new GoogleIamV1LogConfig.fromJson(value)).toList();
- }
- if (_json.containsKey("notIn")) {
- notIn = _json["notIn"];
- }
- if (_json.containsKey("permissions")) {
- permissions = _json["permissions"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (action != null) {
- _json["action"] = action;
- }
- if (conditions != null) {
- _json["conditions"] = conditions.map((value) => (value).toJson()).toList();
- }
- if (description != null) {
- _json["description"] = description;
- }
- if (in_ != null) {
- _json["in"] = in_;
- }
- if (logConfig != null) {
- _json["logConfig"] = logConfig.map((value) => (value).toJson()).toList();
- }
- if (notIn != null) {
- _json["notIn"] = notIn;
- }
- if (permissions != null) {
- _json["permissions"] = permissions;
- }
- return _json;
- }
-}
-
-/** Request message for `SetIamPolicy` method. */
+/// Request message for `SetIamPolicy` method.
class GoogleIamV1SetIamPolicyRequest {
- /**
- * REQUIRED: The complete policy to be applied to the `resource`. The size of
- * the policy is limited to a few 10s of KB. An empty policy is a
- * valid policy but certain Cloud Platform services (such as Projects)
- * might reject them.
- */
+ /// REQUIRED: The complete policy to be applied to the `resource`. The size
+ /// of
+ /// the policy is limited to a few 10s of KB. An empty policy is a
+ /// valid policy but certain Cloud Platform services (such as Projects)
+ /// might reject them.
GoogleIamV1Policy policy;
- /**
- * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- * the fields in the mask will be modified. If no mask is provided, the
- * following default mask is used:
- * paths: "bindings, etag"
- * This field is only used by Cloud IAM.
- */
+
+ /// OPTIONAL: A FieldMask specifying which fields of the policy to modify.
+ /// Only
+ /// the fields in the mask will be modified. If no mask is provided, the
+ /// following default mask is used:
+ /// paths: "bindings, etag"
+ /// This field is only used by Cloud IAM.
core.String updateMask;
GoogleIamV1SetIamPolicyRequest();
@@ -4108,7 +3405,8 @@ class GoogleIamV1SetIamPolicyRequest {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (policy != null) {
_json["policy"] = (policy).toJson();
}
@@ -4119,14 +3417,12 @@ class GoogleIamV1SetIamPolicyRequest {
}
}
-/** Request message for `TestIamPermissions` method. */
+/// Request message for `TestIamPermissions` method.
class GoogleIamV1TestIamPermissionsRequest {
- /**
- * The set of permissions to check for the `resource`. Permissions with
- * wildcards (such as '*' or 'storage.*') are not allowed. For more
- * information see
- * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
- */
+ /// The set of permissions to check for the `resource`. Permissions with
+ /// wildcards (such as '*' or 'storage.*') are not allowed. For more
+ /// information see
+ /// [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
core.List<core.String> permissions;
GoogleIamV1TestIamPermissionsRequest();
@@ -4138,7 +3434,8 @@ class GoogleIamV1TestIamPermissionsRequest {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (permissions != null) {
_json["permissions"] = permissions;
}
@@ -4146,12 +3443,10 @@ class GoogleIamV1TestIamPermissionsRequest {
}
}
-/** Response message for `TestIamPermissions` method. */
+/// Response message for `TestIamPermissions` method.
class GoogleIamV1TestIamPermissionsResponse {
- /**
- * A subset of `TestPermissionsRequest.permissions` that the caller is
- * allowed.
- */
+ /// A subset of `TestPermissionsRequest.permissions` that the caller is
+ /// allowed.
core.List<core.String> permissions;
GoogleIamV1TestIamPermissionsResponse();
@@ -4163,7 +3458,8 @@ class GoogleIamV1TestIamPermissionsResponse {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (permissions != null) {
_json["permissions"] = permissions;
}
@@ -4171,11 +3467,12 @@ class GoogleIamV1TestIamPermissionsResponse {
}
}
-/** The response message for Operations.ListOperations. */
+/// The response message for Operations.ListOperations.
class GoogleLongrunningListOperationsResponse {
- /** The standard List next-page token. */
+ /// The standard List next-page token.
core.String nextPageToken;
- /** A list of operations that matches the specified filter in the request. */
+
+ /// A list of operations that matches the specified filter in the request.
core.List<GoogleLongrunningOperation> operations;
GoogleLongrunningListOperationsResponse();
@@ -4185,64 +3482,64 @@ class GoogleLongrunningListOperationsResponse {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("operations")) {
- operations = _json["operations"].map((value) => new GoogleLongrunningOperation.fromJson(value)).toList();
+ operations = _json["operations"]
+ .map((value) => new GoogleLongrunningOperation.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
if (operations != null) {
- _json["operations"] = operations.map((value) => (value).toJson()).toList();
+ _json["operations"] =
+ operations.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/**
- * This resource represents a long-running operation that is the result of a
- * network API call.
- */
+/// This resource represents a long-running operation that is the result of a
+/// network API call.
class 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.
- */
+ /// If the value is `false`, it means the operation is still in progress.
+ /// If `true`, the operation is completed, and either `error` or `response`
+ /// is
+ /// available.
core.bool done;
- /** The error result of the operation in case of failure or cancellation. */
+
+ /// The error result of the operation in case of failure or cancellation.
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.
- */
+
+ /// Service-specific metadata associated with the operation. It typically
+ /// contains progress information and common metadata such as create time.
+ /// Some services might not provide such metadata. Any method that returns a
+ /// long-running operation should document the metadata type, if any.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> metadata;
- /**
- * The server-assigned name, which is only unique within the same service that
- * originally returns it. If you use the default HTTP mapping, the
- * `name` should have the format of `operations/some/unique/name`.
- */
+
+ /// The server-assigned name, which is only unique within the same service
+ /// that
+ /// originally returns it. If you use the default HTTP mapping, the
+ /// `name` should have the format of `operations/some/unique/name`.
core.String name;
- /**
- * The normal response of the operation in case of success. If the original
- * method returns no data on success, such as `Delete`, the response is
- * `google.protobuf.Empty`. If the original method is standard
- * `Get`/`Create`/`Update`, the response should be the resource. For other
- * methods, the response should have the type `XxxResponse`, where `Xxx`
- * is the original method name. For example, if the original method name
- * is `TakeSnapshot()`, the inferred response type is
- * `TakeSnapshotResponse`.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// The normal response of the operation in case of success. If the original
+ /// method returns no data on success, such as `Delete`, the response is
+ /// `google.protobuf.Empty`. If the original method is standard
+ /// `Get`/`Create`/`Update`, the response should be the resource. For other
+ /// methods, the response should have the type `XxxResponse`, where `Xxx`
+ /// is the original method name. For example, if the original method name
+ /// is `TakeSnapshot()`, the inferred response type is
+ /// `TakeSnapshotResponse`.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> response;
GoogleLongrunningOperation();
@@ -4266,7 +3563,8 @@ class GoogleLongrunningOperation {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (done != null) {
_json["done"] = done;
}
@@ -4286,102 +3584,102 @@ class GoogleLongrunningOperation {
}
}
-/**
- * A generic empty message that you can re-use to avoid defining duplicated
- * empty messages in your APIs. A typical example is to use it as the request
- * or the response type of an API method. For instance:
- *
- * service Foo {
- * rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
- * }
- *
- * The JSON representation for `Empty` is empty JSON object `{}`.
- */
+/// A generic empty message that you can re-use to avoid defining duplicated
+/// empty messages in your APIs. A typical example is to use it as the request
+/// or the response type of an API method. For instance:
+///
+/// service Foo {
+/// rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+/// }
+///
+/// The JSON representation for `Empty` is empty JSON object `{}`.
class GoogleProtobufEmpty {
-
GoogleProtobufEmpty();
- GoogleProtobufEmpty.fromJson(core.Map _json) {
- }
+ GoogleProtobufEmpty.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
return _json;
}
}
-/**
- * The `Status` type defines a logical error model that is suitable for
- * different
- * programming environments, including REST APIs and RPC APIs. It is used by
- * [gRPC](https://github.com/grpc). The error model is designed to be:
- *
- * - Simple to use and understand for most users
- * - Flexible enough to meet unexpected needs
- *
- * # Overview
- *
- * The `Status` message contains three pieces of data: error code, error
- * message,
- * and error details. The error code should be an enum value of
- * google.rpc.Code, but it may accept additional error codes if needed. The
- * error message should be a developer-facing English message that helps
- * developers *understand* and *resolve* the error. If a localized user-facing
- * error message is needed, put the localized message in the error details or
- * localize it in the client. The optional error details may contain arbitrary
- * information about the error. There is a predefined set of error detail types
- * in the package `google.rpc` that can be used for common error conditions.
- *
- * # Language mapping
- *
- * The `Status` message is the logical representation of the error model, but it
- * is not necessarily the actual wire format. When the `Status` message is
- * exposed in different client libraries and different wire protocols, it can be
- * mapped differently. For example, it will likely be mapped to some exceptions
- * in Java, but more likely mapped to some error codes in C.
- *
- * # Other uses
- *
- * The error model and the `Status` message can be used in a variety of
- * environments, either with or without APIs, to provide a
- * consistent developer experience across different environments.
- *
- * Example uses of this error model include:
- *
- * - Partial errors. If a service needs to return partial errors to the client,
- * it may embed the `Status` in the normal response to indicate the partial
- * errors.
- *
- * - Workflow errors. A typical workflow has multiple steps. Each step may
- * have a `Status` message for error reporting.
- *
- * - Batch operations. If a client uses batch request and batch response, the
- * `Status` message should be used directly inside batch response, one for
- * each error sub-response.
- *
- * - Asynchronous operations. If an API call embeds asynchronous operation
- * results in its response, the status of those operations should be
- * represented directly using the `Status` message.
- *
- * - Logging. If some API errors are stored in logs, the message `Status` could
- * be used directly after any stripping needed for security/privacy reasons.
- */
+/// The `Status` type defines a logical error model that is suitable for
+/// different
+/// programming environments, including REST APIs and RPC APIs. It is used by
+/// [gRPC](https://github.com/grpc). The error model is designed to be:
+///
+/// - Simple to use and understand for most users
+/// - Flexible enough to meet unexpected needs
+///
+/// # Overview
+///
+/// The `Status` message contains three pieces of data: error code, error
+/// message,
+/// and error details. The error code should be an enum value of
+/// google.rpc.Code, but it may accept additional error codes if needed. The
+/// error message should be a developer-facing English message that helps
+/// developers *understand* and *resolve* the error. If a localized user-facing
+/// error message is needed, put the localized message in the error details or
+/// localize it in the client. The optional error details may contain arbitrary
+/// information about the error. There is a predefined set of error detail
+/// types
+/// in the package `google.rpc` that can be used for common error conditions.
+///
+/// # Language mapping
+///
+/// The `Status` message is the logical representation of the error model, but
+/// it
+/// is not necessarily the actual wire format. When the `Status` message is
+/// exposed in different client libraries and different wire protocols, it can
+/// be
+/// mapped differently. For example, it will likely be mapped to some
+/// exceptions
+/// in Java, but more likely mapped to some error codes in C.
+///
+/// # Other uses
+///
+/// The error model and the `Status` message can be used in a variety of
+/// environments, either with or without APIs, to provide a
+/// consistent developer experience across different environments.
+///
+/// Example uses of this error model include:
+///
+/// - Partial errors. If a service needs to return partial errors to the
+/// client,
+/// it may embed the `Status` in the normal response to indicate the partial
+/// errors.
+///
+/// - Workflow errors. A typical workflow has multiple steps. Each step may
+/// have a `Status` message for error reporting.
+///
+/// - Batch operations. If a client uses batch request and batch response, the
+/// `Status` message should be used directly inside batch response, one for
+/// each error sub-response.
+///
+/// - Asynchronous operations. If an API call embeds asynchronous operation
+/// results in its response, the status of those operations should be
+/// represented directly using the `Status` message.
+///
+/// - Logging. If some API errors are stored in logs, the message `Status`
+/// could
+/// be used directly after any stripping needed for security/privacy reasons.
class GoogleRpcStatus {
- /** The status code, which should be an enum value of google.rpc.Code. */
+ /// The status code, which should be an enum value of google.rpc.Code.
core.int code;
- /**
- * A list of messages that carry the error details. There is a common set of
- * message types for APIs to use.
- *
- * The values for Object must be JSON objects. It can consist of `num`,
- * `String`, `bool` and `null` as well as `Map` and `List` values.
- */
+
+ /// A list of messages that carry the error details. There is a common set
+ /// of
+ /// message types for APIs to use.
+ ///
+ /// The values for Object must be JSON objects. It can consist of `num`,
+ /// `String`, `bool` and `null` as well as `Map` and `List` values.
core.List<core.Map<core.String, core.Object>> details;
- /**
- * A developer-facing error message, which should be in English. Any
- * user-facing error message should be localized and sent in the
- * google.rpc.Status.details field, or localized by the client.
- */
+
+ /// A developer-facing error message, which should be in English. Any
+ /// user-facing error message should be localized and sent in the
+ /// google.rpc.Status.details field, or localized by the client.
core.String message;
GoogleRpcStatus();
@@ -4399,7 +3697,8 @@ class GoogleRpcStatus {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (code != null) {
_json["code"] = code;
}
@@ -4413,37 +3712,30 @@ class GoogleRpcStatus {
}
}
-/**
- * Represents an expression text. Example:
- *
- * title: "User account presence"
- * description: "Determines whether the request has a user account"
- * expression: "size(request.user) > 0"
- */
+/// Represents an expression text. Example:
+///
+/// title: "User account presence"
+/// description: "Determines whether the request has a user account"
+/// expression: "size(request.user) > 0"
class GoogleTypeExpr {
- /**
- * An optional description of the expression. This is a longer text which
- * describes the expression, e.g. when hovered over it in a UI.
- */
+ /// An optional description of the expression. This is a longer text which
+ /// describes the expression, e.g. when hovered over it in a UI.
core.String description;
- /**
- * Textual representation of an expression in
- * Common Expression Language syntax.
- *
- * The application context of the containing message determines which
- * well-known feature set of CEL is supported.
- */
+
+ /// Textual representation of an expression in
+ /// Common Expression Language syntax.
+ ///
+ /// The application context of the containing message determines which
+ /// well-known feature set of CEL is supported.
core.String expression;
- /**
- * An optional string indicating the location of the expression for error
- * reporting, e.g. a file name and a position in the file.
- */
+
+ /// An optional string indicating the location of the expression for error
+ /// reporting, e.g. a file name and a position in the file.
core.String location;
- /**
- * An optional title for the expression, i.e. a short string describing
- * its purpose. This can be used e.g. in UIs which allow to enter the
- * expression.
- */
+
+ /// An optional title for the expression, i.e. a short string describing
+ /// its purpose. This can be used e.g. in UIs which allow to enter the
+ /// expression.
core.String title;
GoogleTypeExpr();
@@ -4464,7 +3756,8 @@ class GoogleTypeExpr {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (description != null) {
_json["description"] = description;
}
« no previous file with comments | « generated/googleapis/lib/mirror/v1.dart ('k') | generated/googleapis/lib/monitoring/v3.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698