Api-roll 41: 2016-08-26

generated/googleapis/lib/servicemanagement/v1.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.servicemanagement.v1;
 
 import 'dart:core' as core;
 import 'dart:async' as async;
 import 'dart:convert' as convert;
 
 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
 import 'package:http/http.dart' as http_1;
 
 export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' show
     ApiRequestError, DetailedApiRequestError;
 
 const core.String USER_AGENT = 'dart-api-client servicemanagement/v1';
 
-/** The service management API for Google Cloud Platform */
+/**
+ * Google Service Management allows service producers to publish their services
+ * on Google Cloud Platform so that they can be discovered and used by service
+ * consumers.
+ */
 class ServicemanagementApi {
   /** View and manage your data across Google Cloud Platform services */
   static const CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform";
 
   /** View your data across Google Cloud Platform services */
   static const CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only";
 
   /** Manage your Google API service configuration */
   static const ServiceManagementScope = "https://www.googleapis.com/auth/service.management";
 
@@ skipping 66 matching lines @@
   final commons.ApiRequester _requester;
 
   ServicesConfigsResourceApi get configs => new ServicesConfigsResourceApi(_requester);
   ServicesRolloutsResourceApi get rollouts => new ServicesRolloutsResourceApi(_requester);
 
   ServicesResourceApi(commons.ApiRequester client) : 
       _requester = client;
 
   /**
    * Creates a new managed service.
+   * Please note one producer project can own no more than 20 services.
    *
    * Operation<response: ManagedService>
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * Completes with a [Operation].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
@@ skipping 29 matching lines @@
   /**
    * Deletes a managed service. This method will change the serivce in the
    * `Soft-Delete` state for 30 days. Within this period, service producers may
    * call UndeleteService to restore the service.
    * After 30 days, the service will be permanently deleted.
    *
    * Operation<response: google.protobuf.Empty>
    *
    * Request parameters:
    *
-   * [serviceName] - The name of the service.  See the `ServiceManager` overview
-   * for naming
-   * requirements.  For example: `example.googleapis.com`.
+   * [serviceName] - The name of the service.  See the
+   * [overview](/service-management/overview)
+   * for naming requirements.  For example: `example.googleapis.com`.
    *
    * Completes with a [Operation].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http_1.Client] completes with an error when making a REST
    * call, this method will complete with the same error.
    */
   async.Future<Operation> delete(core.String serviceName) {
@@ skipping 66 matching lines @@
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Operation.fromJson(data));
   }
 
   /**
    * Enable a managed service for a project with default setting.
    *
    * Operation<response: EnableServiceResponse>
    *
+   * google.rpc.Status errors may contain a
+   * google.rpc.PreconditionFailure error detail.
+   *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [serviceName] - Name of the service to enable. Specifying an unknown
    * service name will
    * cause the request to fail.
    *
    * Completes with a [Operation].
    *
@@ skipping 118 matching lines @@
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new ManagedService.fromJson(data));
   }
 
   /**
    * Gets a service configuration (version) for a managed service.
    *
    * Request parameters:
    *
-   * [serviceName] - The name of the service.  See the `ServiceManager` overview
-   * for naming
-   * requirements.  For example: `example.googleapis.com`.
+   * [serviceName] - The name of the service.  See the
+   * [overview](/service-management/overview)
+   * for naming requirements.  For example: `example.googleapis.com`.
    *
    * [configId] - null
    *
    * Completes with a [Service].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http_1.Client] completes with an error when making a REST
    * call, this method will complete with the same error.
@@ skipping 226 matching lines @@
   /**
    * Revives a previously deleted managed service. The method restores the
    * service using the configuration at the time the service was deleted.
    * The target service must exist and must have been deleted within the
    * last 30 days.
    *
    * Operation<response: UndeleteServiceResponse>
    *
    * Request parameters:
    *
-   * [serviceName] - The name of the service. See the `ServiceManager` overview
-   * for naming
-   * requirements. For example: `example.googleapis.com`.
+   * [serviceName] - The name of the service. See the
+   * [overview](/service-management/overview)
+   * for naming requirements. For example: `example.googleapis.com`.
    *
    * Completes with a [Operation].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http_1.Client] completes with an error when making a REST
    * call, this method will complete with the same error.
    */
   async.Future<Operation> undelete(core.String serviceName) {
@@ skipping 32 matching lines @@
   /**
    * Creates a new service configuration (version) for a managed service.
    * This method only stores the service configuration. To roll out the service
    * configuration to backend systems please call
    * CreateServiceRollout.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
-   * [serviceName] - The name of the service.  See the `ServiceManager` overview
-   * for naming
-   * requirements.  For example: `example.googleapis.com`.
+   * [serviceName] - The name of the service.  See the
+   * [overview](/service-management/overview)
+   * for naming requirements.  For example: `example.googleapis.com`.
    *
    * Completes with a [Service].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http_1.Client] completes with an error when making a REST
    * call, this method will complete with the same error.
    */
   async.Future<Service> create(Service request, core.String serviceName) {
@@ skipping 21 matching lines @@
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Service.fromJson(data));
   }
 
   /**
    * Gets a service configuration (version) for a managed service.
    *
    * Request parameters:
    *
-   * [serviceName] - The name of the service.  See the `ServiceManager` overview
-   * for naming
-   * requirements.  For example: `example.googleapis.com`.
+   * [serviceName] - The name of the service.  See the
+   * [overview](/service-management/overview)
+   * for naming requirements.  For example: `example.googleapis.com`.
    *
    * [configId] - null
    *
    * Completes with a [Service].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http_1.Client] completes with an error when making a REST
    * call, this method will complete with the same error.
@@ skipping 24 matching lines @@
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Service.fromJson(data));
   }
 
   /**
    * Lists the history of the service configuration for a managed service,
    * from the newest to the oldest.
    *
    * Request parameters:
    *
-   * [serviceName] - The name of the service.  See the `ServiceManager` overview
-   * for naming
-   * requirements.  For example: `example.googleapis.com`.
+   * [serviceName] - The name of the service.  See the
+   * [overview](/service-management/overview)
+   * for naming requirements.  For example: `example.googleapis.com`.
    *
    * [pageSize] - The max number of items to include in the response list.
    *
    * [pageToken] - The token of the page to retrieve.
    *
    * Completes with a [ListServiceConfigsResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
@@ skipping 38 matching lines @@
    * generated service configuration. To rollout the service configuration to
    * other services,
    * please call CreateServiceRollout.
    *
    * Operation<response: SubmitConfigSourceResponse>
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
-   * [serviceName] - The name of the service.  See the `ServiceManager` overview
-   * for naming
-   * requirements.  For example: `example.googleapis.com`.
+   * [serviceName] - The name of the service.  See the
+   * [overview](/service-management/overview)
+   * for naming requirements.  For example: `example.googleapis.com`.
    *
    * Completes with a [Operation].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http_1.Client] completes with an error when making a REST
    * call, this method will complete with the same error.
    */
   async.Future<Operation> submit(SubmitConfigSourceRequest request, core.String serviceName) {
@@ skipping 31 matching lines @@
 
   ServicesRolloutsResourceApi(commons.ApiRequester client) : 
       _requester = client;
 
   /**
    * Creates a new service configuration rollout. Based on rollout, the
    * Google Service Management will roll out the service configurations to
    * different backend services. For example, the logging configuration will be
    * pushed to Google Cloud Logging.
    *
+   * Please note that any previous pending and running Rollouts and associated
+   * Operations will be automatically cancelled so that the latest Rollout will
+   * not be blocked by previous Rollouts.
+   *
    * Operation<response: Rollout>
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
-   * [serviceName] - The name of the service.  See the `ServiceManager` overview
-   * for naming
-   * requirements.  For example: `example.googleapis.com`.
+   * [serviceName] - The name of the service.  See the
+   * [overview](/service-management/overview)
+   * for naming requirements.  For example: `example.googleapis.com`.
    *
    * Completes with a [Operation].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http_1.Client] completes with an error when making a REST
    * call, this method will complete with the same error.
    */
   async.Future<Operation> create(Rollout request, core.String serviceName) {
@@ skipping 21 matching lines @@
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Operation.fromJson(data));
   }
 
   /**
    * Gets a service configuration rollout.
    *
    * Request parameters:
    *
-   * [serviceName] - The name of the service.  See the `ServiceManager` overview
-   * for naming
-   * requirements.  For example: `example.googleapis.com`.
+   * [serviceName] - The name of the service.  See the
+   * [overview](/service-management/overview)
+   * for naming requirements.  For example: `example.googleapis.com`.
    *
    * [rolloutId] - The id of the rollout resource.
    *
    * Completes with a [Rollout].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
    * If the used [http_1.Client] completes with an error when making a REST
    * call, this method will complete with the same error.
@@ skipping 24 matching lines @@
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Rollout.fromJson(data));
   }
 
   /**
    * Lists the history of the service configuration rollouts for a managed
    * service, from the newest to the oldest.
    *
    * Request parameters:
    *
-   * [serviceName] - The name of the service.  See the `ServiceManager` overview
-   * for naming
-   * requirements.  For example: `example.googleapis.com`.
+   * [serviceName] - The name of the service.  See the
+   * [overview](/service-management/overview)
+   * for naming requirements.  For example: `example.googleapis.com`.
    *
    * [pageSize] - The max number of items to include in the response list.
    *
    * [pageToken] - The token of the page to retrieve.
    *
    * Completes with a [ListServiceRolloutsResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
@@ skipping 382 matching lines @@
  * By default, if a method has any authentication requirements, every request
  * must include a valid credential matching one of the requirements.
  * It's an error to include more than one kind of credential in a single
  * request.
  *
  * If a method doesn't have any auth requirements, request credentials will be
  * ignored.
  */
 class AuthenticationRule {
   /**
-   * Whether to allow requests without a credential.  If quota is enabled, an
-   * API key is required for such request to pass the quota check.
+   * Whether to allow requests without a credential. The credential can be
+   * an OAuth token, Google cookies (first-party auth) or EndUserCreds.
+   *
+   * For requests without credentials, if the service control environment is
+   * specified, each incoming request **must** be associated with a service
+   * consumer. This can be done by passing an API key that belongs to a consumer
+   * project.
    */
   core.bool allowWithoutCredential;
   /** The requirements for OAuth credentials. */
   OAuthRequirements oauth;
   /** Requirements for additional authentication providers. */
   core.List<AuthRequirement> requirements;
   /**
    * Selects the methods to which this rule applies.
    *
    * Refer to selector for syntax details.
@@ skipping 441 matching lines @@
     if (filePath != null) {
       _json["filePath"] = filePath;
     }
     if (fileType != null) {
       _json["fileType"] = fileType;
     }
     return _json;
   }
 }
 
-/**
- * A set of options to cover use of source config within `ServiceManager`
- * and related tools.
- */
-class ConfigOptions {
-
-  ConfigOptions();
-
-  ConfigOptions.fromJson(core.Map _json) {
-  }
-
-  core.Map toJson() {
-    var _json = new core.Map();
-    return _json;
-  }
-}
-
 /** Represents a service configuration with its name and id. */
 class ConfigRef {
   /**
    * Resource name of a service config. It must have the following
    * format: "services/{service name}/configs/{config id}".
    */
   core.String name;
 
   ConfigRef();
 
@@ skipping 21 matching lines @@
    * Set of source configuration files that are used to generate a service
    * configuration (`google.api.Service`).
    */
   core.List<ConfigFile> files;
   /**
    * A unique ID for a specific instance of this message, typically assigned
    * by the client for tracking purpose. If empty, the server may choose to
    * generate one instead.
    */
   core.String id;
-  /**
-   * Options to cover use of source configuration within ServiceManager and
-   * tools
-   */
-  ConfigOptions options;
 
   ConfigSource();
 
   ConfigSource.fromJson(core.Map _json) {
     if (_json.containsKey("files")) {
       files = _json["files"].map((value) => new ConfigFile.fromJson(value)).toList();
     }
     if (_json.containsKey("id")) {
       id = _json["id"];
     }
-    if (_json.containsKey("options")) {
-      options = new ConfigOptions.fromJson(_json["options"]);
-    }
   }
 
   core.Map toJson() {
     var _json = new core.Map();
     if (files != null) {
       _json["files"] = files.map((value) => (value).toJson()).toList();
     }
     if (id != null) {
       _json["id"] = id;
     }
-    if (options != null) {
-      _json["options"] = (options).toJson();
-    }
     return _json;
   }
 }
 
 /**
  * `Context` defines which contexts an API requests.
  *
  * Example:
  *
  *     context:
@@ skipping 564 matching lines @@
 
   core.Map toJson() {
     var _json = new core.Map();
     if (consumerId != null) {
       _json["consumerId"] = consumerId;
     }
     return _json;
   }
 }
 
+/**
+ * `Endpoint` describes a network endpoint that serves a set of APIs.
+ * A service may expose any number of endpoints, and all endpoints share the
+ * same service configuration, such as quota configuration and monitoring
+ * configuration.
+ *
+ * Example service configuration:
+ *
+ *     name: library-example.googleapis.com
+ *     endpoints:
+ *       # Below entry makes 'google.example.library.v1.Library'
+ *       # API be served from endpoint address library-example.googleapis.com.
+ *       # It also allows HTTP OPTIONS calls to be passed to the backend, for
+ *       # it to decide whether the subsequent cross-origin request is
+ *       # allowed to proceed.
+ *     - name: library-example.googleapis.com
+ *       apis: google.example.library.v1.Library
+ *       allow_cors: true
+ *       # Below entry makes 'google.example.library.v1.Library'
+ *       # API be served from endpoint address
+ *       # google.example.library-example.v1.LibraryManager.
+ *     - name: library-manager.googleapis.com
+ *       apis: google.example.library.v1.LibraryManager
+ *       # BNS address for a borg job. Can specify a task by appending
+ *       # "/taskId" (e.g. "/0") to the job spec.
+ *
+ * Example OpenAPI extension for endpoint with allow_cors set to true:
+ *
+ *     {
+ *       "swagger": "2.0",
+ *       "info": {
+ *         "description": "A simple..."
+ *       },
+ *       "host": "MY_PROJECT_ID.appspot.com",
+ *       "x-google-endpoints": [{
+ *         "name": "MY_PROJECT_ID.appspot.com",
+ *         "allow_cors": "true"
+ *       }]
+ *     }
+ */
+class Endpoint {
+  /**
+   * DEPRECATED: This field is no longer supported. Instead of using aliases,
+   * please specify multiple google.api.Endpoint for each of the intented
+   * alias.
+   *
+   * Additional names that this endpoint will be hosted on.
+   */
+  core.List<core.String> aliases;
+  /**
+   * Allowing
+   * [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
+   * cross-domain traffic, would allow the backends served from this endpoint to
+   * receive and respond to HTTP OPTIONS requests. The response will be used by
+   * the browser to determine whether the subsequent cross-origin request is
+   * allowed to proceed.
+   */
+  core.bool allowCors;
+  /** The list of APIs served by this endpoint. */
+  core.List<core.String> apis;
+  /** The list of features enabled on this endpoint. */
+  core.List<core.String> features;
+  /** The canonical name of this endpoint. */
+  core.String name;
+
+  Endpoint();
+
+  Endpoint.fromJson(core.Map _json) {
+    if (_json.containsKey("aliases")) {
+      aliases = _json["aliases"];
+    }
+    if (_json.containsKey("allowCors")) {
+      allowCors = _json["allowCors"];
+    }
+    if (_json.containsKey("apis")) {
+      apis = _json["apis"];
+    }
+    if (_json.containsKey("features")) {
+      features = _json["features"];
+    }
+    if (_json.containsKey("name")) {
+      name = _json["name"];
+    }
+  }
+
+  core.Map toJson() {
+    var _json = new core.Map();
+    if (aliases != null) {
+      _json["aliases"] = aliases;
+    }
+    if (allowCors != null) {
+      _json["allowCors"] = allowCors;
+    }
+    if (apis != null) {
+      _json["apis"] = apis;
+    }
+    if (features != null) {
+      _json["features"] = features;
+    }
+    if (name != null) {
+      _json["name"] = name;
+    }
+    return _json;
+  }
+}
+
 /** Enum type definition. */
 class Enum {
   /** Enum value definitions. */
   core.List<EnumValue> enumvalue;
   /** Enum type name. */
   core.String name;
   /** Protocol buffer options. */
   core.List<Option> options;
   /** The source context. */
   SourceContext sourceContext;
@@ skipping 1088 matching lines @@
 /**
  * The full representation of a Service that is managed by
  * Google Service Management.
  */
 class ManagedService {
   /** ID of the project that produces and owns this service. */
   core.String producerProjectId;
   /**
    * The name of the service. See the [overview](/service-management/overview)
    * for naming requirements.
-   * This name must match `google.api.Service.name` in the
-   * `service_config` field.
    */
   core.String serviceName;
 
   ManagedService();
 
   ManagedService.fromJson(core.Map _json) {
     if (_json.containsKey("producerProjectId")) {
       producerProjectId = _json["producerProjectId"];
     }
     if (_json.containsKey("serviceName")) {
@@ skipping 459 matching lines @@
  * by the API.
  */
 class MonitoredResourceDescriptor {
   /**
    * Optional. A detailed description of the monitored resource type that might
    * be used in documentation.
    */
   core.String description;
   /**
    * Optional. A concise name for the monitored resource type that might be
-   * displayed in user interfaces. For example, `"Google Cloud SQL Database"`.
+   * displayed in user interfaces. It should be a Title Cased Noun Phrase,
+   * without any article or other determiners. For example,
+   * `"Google Cloud SQL Database"`.
    */
   core.String displayName;
   /**
    * Required. A set of labels used to describe instances of this monitored
    * resource type. For example, an individual Google Cloud SQL database is
    * identified by values for the labels `"database_id"` and `"zone"`.
    */
   core.List<LabelDescriptor> labels;
   /**
    * Optional. The resource name of the monitored resource descriptor:
@@ skipping 619 matching lines @@
    * version. Readonly.
    * Possible string values are:
    * - "ROLLOUT_STATUS_UNSPECIFIED" : No status specified.
    * - "IN_PROGRESS" : The Rollout is in progress.
    * - "SUCCESS" : The Rollout has completed successfully.
    * - "CANCELLED" : The Rollout has been cancelled. This can happen if you have
    * overlapping
    * Rollout pushes, and the previous ones will be cancelled.
    * - "FAILED" : The Rollout has failed. It is typically caused by
    * configuration errors.
-   * - "PENDING" : The Rollout has started yet and is pending for execution.
+   * - "PENDING" : The Rollout has not started yet and is pending for execution.
    */
   core.String status;
   /**
    * Google Service Control selects service configurations based on
    * traffic percentage.
    */
   TrafficPercentStrategy trafficPercentStrategy;
 
   Rollout();
 
@@ skipping 187 matching lines @@
   core.int configVersion;
   /** Context configuration. */
   Context context;
   /** Configuration for the service control plane. */
   Control control;
   /** Custom error configuration. */
   CustomError customError;
   /** Additional API documentation. */
   Documentation documentation;
   /**
+   * Configuration for network endpoints.  If this is empty, then an endpoint
+   * with the same name as the service is automatically generated to service all
+   * defined APIs.
+   */
+  core.List<Endpoint> endpoints;
+  /**
    * A list of all enum types included in this API service.  Enums
    * referenced directly or indirectly by the `apis` are automatically
    * included.  Enums which are not referenced but shall be included
    * should be listed here by name. Example:
    *
    *     enums:
    *     - name: google.someapi.v1.SomeEnum
    */
   core.List<Enum> enums;
   /** HTTP configuration. */
@@ skipping 76 matching lines @@
     }
     if (_json.containsKey("control")) {
       control = new Control.fromJson(_json["control"]);
     }
     if (_json.containsKey("customError")) {
       customError = new CustomError.fromJson(_json["customError"]);
     }
     if (_json.containsKey("documentation")) {
       documentation = new Documentation.fromJson(_json["documentation"]);
     }
+    if (_json.containsKey("endpoints")) {
+      endpoints = _json["endpoints"].map((value) => new Endpoint.fromJson(value)).toList();
+    }
     if (_json.containsKey("enums")) {
       enums = _json["enums"].map((value) => new Enum.fromJson(value)).toList();
     }
     if (_json.containsKey("http")) {
       http = new Http.fromJson(_json["http"]);
     }
     if (_json.containsKey("id")) {
       id = _json["id"];
     }
     if (_json.containsKey("logging")) {
@@ skipping 56 matching lines @@
     }
     if (control != null) {
       _json["control"] = (control).toJson();
     }
     if (customError != null) {
       _json["customError"] = (customError).toJson();
     }
     if (documentation != null) {
       _json["documentation"] = (documentation).toJson();
     }
+    if (endpoints != null) {
+      _json["endpoints"] = endpoints.map((value) => (value).toJson()).toList();
+    }
     if (enums != null) {
       _json["enums"] = enums.map((value) => (value).toJson()).toList();
     }
     if (http != null) {
       _json["http"] = (http).toJson();
     }
     if (id != null) {
       _json["id"] = id;
     }
     if (logging != null) {
@@ skipping 837 matching lines @@
     var _json = new core.Map();
     if (restriction != null) {
       _json["restriction"] = restriction;
     }
     if (selector != null) {
       _json["selector"] = selector;
     }
     return _json;
   }
 }