diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index a6892022775..c373f419575 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -221,6 +221,74 @@ export namespace bigquery_v2 { */ readRowkeyAsString?: boolean; } + export interface Schema$BqmlIterationResult { + /** + * [Output-only, Beta] Time taken to run the training iteration in + * milliseconds. + */ + durationMs?: string; + /** + * [Output-only, Beta] Eval loss computed on the eval data at the end of the + * iteration. The eval loss is used for early stopping to avoid overfitting. + * No eval loss if eval_split_method option is specified as no_split or + * auto_split with input data size less than 500 rows. + */ + evalLoss?: number; + /** + * [Output-only, Beta] Index of the ML training iteration, starting from + * zero for each training run. + */ + index?: number; + /** + * [Output-only, Beta] Learning rate used for this iteration, it varies for + * different training iterations if learn_rate_strategy option is not + * constant. + */ + learnRate?: number; + /** + * [Output-only, Beta] Training loss computed on the training data at the + * end of the iteration. The training loss function is defined by model + * type. + */ + trainingLoss?: number; + } + export interface Schema$BqmlTrainingRun { + /** + * [Output-only, Beta] List of each iteration results. + */ + iterationResults?: Schema$BqmlIterationResult[]; + /** + * [Output-only, Beta] Training run start time in milliseconds since the + * epoch. + */ + startTime?: string; + /** + * [Output-only, Beta] Different state applicable for a training run. IN + * PROGRESS: Training run is in progress. FAILED: Training run ended due to + * a non-retryable failure. SUCCEEDED: Training run successfully completed. + * CANCELLED: Training run cancelled by the user. + */ + state?: string; + /** + * [Output-only, Beta] Training options used by this training run. These + * options are mutable for subsequent training runs. Default values are + * explicitly stored for options not specified in the input query of the + * first training run. For subsequent training runs, any option not + * explicitly specified in the input query will be copied from the previous + * training run. + */ + trainingOptions?: { + earlyStop?: boolean; + l1Reg?: number; + l2Reg?: number; + learnRate?: number; + learnRateStrategy?: string; + lineSearchInitLearnRate?: number; + maxIteration?: string; + minRelProgress?: number; + warmStart?: boolean; + }; + } export interface Schema$Clustering { /** * [Repeated] One or more fields on which data should be clustered. Only @@ -786,37 +854,6 @@ export namespace bigquery_v2 { */ skipLeadingRows?: string; } - export interface Schema$IterationResult { - /** - * [Output-only, Beta] Time taken to run the training iteration in - * milliseconds. - */ - durationMs?: string; - /** - * [Output-only, Beta] Eval loss computed on the eval data at the end of the - * iteration. The eval loss is used for early stopping to avoid overfitting. - * No eval loss if eval_split_method option is specified as no_split or - * auto_split with input data size less than 500 rows. - */ - evalLoss?: number; - /** - * [Output-only, Beta] Index of the ML training iteration, starting from - * zero for each training run. - */ - index?: number; - /** - * [Output-only, Beta] Learning rate used for this iteration, it varies for - * different training iterations if learn_rate_strategy option is not - * constant. - */ - learnRate?: number; - /** - * [Output-only, Beta] Training loss computed on the training data at the - * end of the iteration. The training loss function is defined by model - * type. - */ - trainingLoss?: number; - } export interface Schema$Job { /** * [Required] Describes the job configuration. @@ -1469,6 +1506,11 @@ export namespace bigquery_v2 { * the DDL target. */ ddlOperationPerformed?: string; + /** + * The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE + * queries. + */ + ddlTargetRoutine?: Schema$RoutineReference; /** * The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries. */ @@ -1527,8 +1569,10 @@ export namespace bigquery_v2 { * "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS * SELECT ... . "DROP_TABLE": DROP TABLE query. * "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . - * "DROP_VIEW": DROP VIEW query. "ALTER_TABLE": ALTER - * TABLE query. "ALTER_VIEW": ALTER VIEW query. + * "DROP_VIEW": DROP VIEW query. "CREATE_FUNCTION": + * CREATE FUNCTION query. "DROP_FUNCTION" : DROP FUNCTION query. + * "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER + * VIEW query. */ statementType?: string; /** @@ -1653,7 +1697,7 @@ export namespace bigquery_v2 { * for the model if warm start is used or if a user decides to continue a * previously cancelled query. */ - trainingRuns?: Schema$TrainingRun[]; + trainingRuns?: Schema$BqmlTrainingRun[]; } export interface Schema$ProjectList { /** @@ -1915,6 +1959,22 @@ export namespace bigquery_v2 { */ range?: {end?: string; interval?: string; start?: string;}; } + export interface Schema$RoutineReference { + /** + * [Required] The ID of the dataset containing this routine. + */ + datasetId?: string; + /** + * [Required] The ID of the project containing this routine. + */ + projectId?: string; + /** + * [Required] The ID of the routine. The ID must contain only letters (a-z, + * A-Z), numbers (0-9), or underscores (_). The maximum length is 256 + * characters. + */ + routineId?: string; + } export interface Schema$Streamingbuffer { /** * [Output-only] A lower-bound estimate of the number of bytes currently in @@ -2272,43 +2332,6 @@ export namespace bigquery_v2 { */ type?: string; } - export interface Schema$TrainingRun { - /** - * [Output-only, Beta] List of each iteration results. - */ - iterationResults?: Schema$IterationResult[]; - /** - * [Output-only, Beta] Training run start time in milliseconds since the - * epoch. - */ - startTime?: string; - /** - * [Output-only, Beta] Different state applicable for a training run. IN - * PROGRESS: Training run is in progress. FAILED: Training run ended due to - * a non-retryable failure. SUCCEEDED: Training run successfully completed. - * CANCELLED: Training run cancelled by the user. - */ - state?: string; - /** - * [Output-only, Beta] Training options used by this training run. These - * options are mutable for subsequent training runs. Default values are - * explicitly stored for options not specified in the input query of the - * first training run. For subsequent training runs, any option not - * explicitly specified in the input query will be copied from the previous - * training run. - */ - trainingOptions?: { - earlyStop?: boolean; - l1Reg?: number; - l2Reg?: number; - learnRate?: number; - learnRateStrategy?: string; - lineSearchInitLearnRate?: number; - maxIteration?: string; - minRelProgress?: number; - warmStart?: boolean; - }; - } export interface Schema$UserDefinedFunctionResource { /** * [Pick one] An inline resource that contains code for a user-defined @@ -3845,7 +3868,6 @@ export namespace bigquery_v2 { * @param {integer=} params.maxResults Maximum number of results to return * @param {string=} params.minCreationTime Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned * @param {string=} params.pageToken Page token, returned by a previous call, to request the next page of results - * @param {string=} params.parentJobId If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent. * @param {string} params.projectId Project ID of the jobs to list * @param {string=} params.projection Restrict information returned to a set of selected fields * @param {string=} params.stateFilter Filter for job state @@ -4172,11 +4194,6 @@ export namespace bigquery_v2 { * results */ pageToken?: string; - /** - * If set, retrieves only jobs whose parent is this job. Otherwise, - * retrieves only jobs which have no parent. - */ - parentJobId?: string; /** * Project ID of the jobs to list */ diff --git a/src/apis/cloudbilling/v1.ts b/src/apis/cloudbilling/v1.ts index f754e3acaaa..92d46fea5e8 100644 --- a/src/apis/cloudbilling/v1.ts +++ b/src/apis/cloudbilling/v1.ts @@ -234,8 +234,8 @@ export namespace cloudbilling_v1 { * * `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, + * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain + * (primary) that represents all the users of that domain. For example, * `google.com` or `example.com`. */ members?: string[]; diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index e0202b07bed..62f48c61e50 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -291,8 +291,10 @@ export namespace cloudfunctions_v1 { */ network?: string; /** - * The runtime in which the function is going to run. If empty, defaults to - * Node.js 6. + * The runtime in which the function is going to run. Example values + * include: `go111`: for Go 1.11 `nodejs6`: for Node.js 6 `nodejs8`: for + * Node.js 8 `nodejs10`: for Node.js 10 `python37`: for Python 3.7 `ruby25`: + * for Ruby 2.5 If empty, defaults to `nodejs6`. */ runtime?: string; /** diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 3a740c4baeb..2c17ada9f6e 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -1938,8 +1938,8 @@ export namespace cloudsearch_v1 { objectDefinitions?: Schema$ObjectDefinition[]; /** * IDs of the Long Running Operations (LROs) currently running for this - * schema. After modifying the schema, wait for opeations to complete before - * indexing additional content. + * schema. After modifying the schema, wait for operations to complete + * before indexing additional content. */ operationIds?: string[]; } diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 22f7dbfeeee..0a98243913a 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -187,6 +187,10 @@ export namespace composer_v1beta1 { * run this environment. */ nodeCount?: number; + /** + * The configuration used for the private Composer environment. + */ + privateEnvironmentConfig?: Schema$PrivateEnvironmentConfig; /** * The configuration settings for software inside the environment. */ @@ -211,6 +215,55 @@ export namespace composer_v1beta1 { */ supportedPythonVersions?: string[]; } + /** + * Configuration for controlling how IPs are allocated in the GKE cluster. + */ + export interface Schema$IPAllocationPolicy { + /** + * Optional. The IP address range used to allocate IP addresses to pods in + * the cluster. This field is applicable only when `use_ip_aliases` is + * true. Set to blank to have GKE choose a range with the default size. Set + * to /netmask (e.g. `/14`) to have GKE choose a range with a specific + * netmask. Set to a + * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. + * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range + * to use. Specify `cluster_secondary_range_name` or + * `cluster_ipv4_cidr_block` but not both. + */ + clusterIpv4CidrBlock?: string; + /** + * Optional. The name of the cluster's secondary range used to allocate + * IP addresses to pods. Specify either `cluster_secondary_range_name` or + * `cluster_ipv4_cidr_block` but not both. + */ + clusterSecondaryRangeName?: string; + /** + * Optional. The IP address range of the services IP addresses in this + * cluster. This field is applicable only when `use_ip_aliases` is true. + * Set to blank to have GKE choose a range with the default size. Set to + * /netmask (e.g. `/14`) to have GKE choose a range with a specific netmask. + * Set to a + * [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + * notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. + * `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range + * to use. Specify `services_secondary_range_name` or + * `services_ipv4_cidr_block` but not both. + */ + servicesIpv4CidrBlock?: string; + /** + * Optional. The name of the services' secondary range used to allocate + * IP addresses to the cluster. Specify either + * `services_secondary_range_name` or `services_ipv4_cidr_block` but not + * both. + */ + servicesSecondaryRangeName?: string; + /** + * Optional. Whether or not to enable Alias IPs in the GKE cluster. If true + * or if left blank, a VPC-native cluster is created. + */ + useIpAliases?: boolean; + } /** * The environments in a project and location. */ @@ -260,6 +313,10 @@ export namespace composer_v1beta1 { * unspecified, defaults to 100GB. Cannot be updated. */ diskSizeGb?: number; + /** + * Optional. The IPAllocationPolicy fields for the GKE cluster. + */ + ipAllocationPolicy?: Schema$IPAllocationPolicy; /** * Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which * to deploy the VMs used to run the Apache Airflow software, specified as a @@ -408,6 +465,41 @@ export namespace composer_v1beta1 { */ state?: string; } + /** + * Configuration options for private cluster of Composer environment. + */ + export interface Schema$PrivateClusterConfig { + /** + * Optional. If true, access to public endpoint of gke cluster will be + * denied. `IPAllocationPolicy.use_ip_aliases` must be true if this field is + * set to true. Default value is false. + */ + enablePrivateEndpoint?: boolean; + /** + * The IP range in CIDR notation to use for the hosted master network. This + * range will be used for assigning internal IP addresses to the cluster + * master or set of masters, as well as the ILB VIP (Internal Load Balance + * Virtual IP).This range must not overlap with any other ranges in use + * within the cluster's network. If left blank, default value of + * '172.16.0.0/28' will be used. + */ + masterIpv4CidrBlock?: string; + } + /** + * The configuration information for configuring a private Composer + * environment. + */ + export interface Schema$PrivateEnvironmentConfig { + /** + * Optional. If `true`, a private Composer environment is created. + */ + enablePrivateEnvironment?: boolean; + /** + * Optional. Configuration for private cluster for a private Composer + * environment. + */ + privateClusterConfig?: Schema$PrivateClusterConfig; + } /** * Specifies the selection and configuration of software inside the * environment. diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index cb6c1a4fc70..c3f32147292 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -1589,6 +1589,12 @@ export namespace containeranalysis_v1alpha1 { * severity. */ cvssScore?: number; + /** + * The distro assigned severity for this vulnerability when that is + * available and note provider assigned severity when distro has not yet + * assigned a severity for this vulnerability. + */ + effectiveSeverity?: string; /** * The set of affected locations and their fixes (if available) within the * associated resource. diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index 0e2d676b94a..c5bc894f769 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -177,6 +177,8 @@ export namespace dns_v1 { name?: string; nameServers?: string[]; nameServerSet?: string; + privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig; + visibility?: string; } export interface Schema$ManagedZoneDnsSecConfig { defaultKeySpecs?: Schema$DnsKeySpec[]; @@ -197,6 +199,22 @@ export namespace dns_v1 { nextPageToken?: string; operations?: Schema$Operation[]; } + export interface Schema$ManagedZonePrivateVisibilityConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#managedZonePrivateVisibilityConfig". + */ + kind?: string; + networks?: Schema$ManagedZonePrivateVisibilityConfigNetwork[]; + } + export interface Schema$ManagedZonePrivateVisibilityConfigNetwork { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#managedZonePrivateVisibilityConfigNetwork". + */ + kind?: string; + networkUrl?: string; + } export interface Schema$ManagedZonesListResponse { header?: Schema$ResponseHeader; /** @@ -246,6 +264,8 @@ export namespace dns_v1 { */ kind?: string; managedZones?: number; + managedZonesPerNetwork?: number; + networksPerManagedZone?: number; resourceRecordsPerRrset?: number; rrsetAdditionsPerChange?: number; rrsetDeletionsPerChange?: number; diff --git a/src/apis/dns/v2beta1.ts b/src/apis/dns/v2beta1.ts index 7be97d75611..ef005de2282 100644 --- a/src/apis/dns/v2beta1.ts +++ b/src/apis/dns/v2beta1.ts @@ -177,6 +177,8 @@ export namespace dns_v2beta1 { name?: string; nameServers?: string[]; nameServerSet?: string; + privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig; + visibility?: string; } export interface Schema$ManagedZoneDnsSecConfig { defaultKeySpecs?: Schema$DnsKeySpec[]; @@ -197,6 +199,22 @@ export namespace dns_v2beta1 { nextPageToken?: string; operations?: Schema$Operation[]; } + export interface Schema$ManagedZonePrivateVisibilityConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#managedZonePrivateVisibilityConfig". + */ + kind?: string; + networks?: Schema$ManagedZonePrivateVisibilityConfigNetwork[]; + } + export interface Schema$ManagedZonePrivateVisibilityConfigNetwork { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#managedZonePrivateVisibilityConfigNetwork". + */ + kind?: string; + networkUrl?: string; + } export interface Schema$ManagedZonesListResponse { header?: Schema$ResponseHeader; /** @@ -246,6 +264,8 @@ export namespace dns_v2beta1 { */ kind?: string; managedZones?: number; + managedZonesPerNetwork?: number; + networksPerManagedZone?: number; resourceRecordsPerRrset?: number; rrsetAdditionsPerChange?: number; rrsetDeletionsPerChange?: number; diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 3568b1a260b..59f55ac1db5 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -7209,7 +7209,10 @@ export namespace drive_v2 { /** * drive.revisions.delete - * @desc Removes a revision. + * @desc Permanently deletes a file version. You can only delete revisions + * for files with binary content, like images or videos. Revisions for other + * files, like Google Docs or Sheets, and the last remaining file version + * can't be deleted. * @alias drive.revisions.delete * @memberOf! () * diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 21fab935f20..94cbb3d4241 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -4070,8 +4070,10 @@ export namespace drive_v3 { /** * drive.revisions.delete - * @desc Permanently deletes a revision. This method is only applicable to - * files with binary content in Drive. + * @desc Permanently deletes a file version. You can only delete revisions + * for files with binary content, like images or videos. Revisions for other + * files, like Google Docs or Sheets, and the last remaining file version + * can't be deleted. * @alias drive.revisions.delete * @memberOf! () * diff --git a/src/apis/fitness/v1.ts b/src/apis/fitness/v1.ts index 037a13d9f41..9be5cf9e65a 100644 --- a/src/apis/fitness/v1.ts +++ b/src/apis/fitness/v1.ts @@ -1740,7 +1740,7 @@ export namespace fitness_v1 { * @param {object} params Parameters for request * @param {string=} params.endTime An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. * @param {boolean=} params.includeDeleted If true, deleted sessions will be returned. When set to true, sessions returned in this response will only have an ID and will not have any other fields. - * @param {string=} params.pageToken The continuation token, which is used for incremental syncing. To get the next batch of changes, set this parameter to the value of nextPageToken from the previous response. This token is treated as a timestamp (in millis since epoch). If specified, the API returns sessions modified since this time. The page token is ignored if either start or end time is specified. If none of start time, end time, and the page token is specified, sessions modified in the last 7 days are returned. + * @param {string=} params.pageToken The continuation token, which is used for incremental syncing. To get the next batch of changes, set this parameter to the value of nextPageToken from the previous response. This token is treated as a timestamp (in millis since epoch). If specified, the API returns sessions modified since this time. The page token is ignored if either start or end time is specified. If none of start time, end time, and the page token is specified, sessions modified in the last 30 days are returned. * @param {string=} params.startTime An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. * @param {string} params.userId List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1917,7 +1917,7 @@ export namespace fitness_v1 { * millis since epoch). If specified, the API returns sessions modified * since this time. The page token is ignored if either start or end time is * specified. If none of start time, end time, and the page token is - * specified, sessions modified in the last 7 days are returned. + * specified, sessions modified in the last 30 days are returned. */ pageToken?: string; /** diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 2d103753a50..f8b71316c4e 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -481,6 +481,13 @@ export namespace iam_v1 { */ nextPageToken?: string; } + /** + * The patch service account request. + */ + export interface Schema$PatchServiceAccountRequest { + serviceAccount?: Schema$ServiceAccount; + updateMask?: string; + } /** * A permission which can be included by a role. */ @@ -718,6 +725,11 @@ export namespace iam_v1 { * value can be the `email` address or the `unique_id` of the service account. */ export interface Schema$ServiceAccount { + /** + * Optional. A user-specified opaque description of the service account. + * Must be less than or equal to 256 UTF-8 bytes. + */ + description?: string; /** * @OutputOnly A bool indicate if the service account is disabled. The field * is currently in alpha phase. @@ -2787,6 +2799,76 @@ export namespace iam_v1 { } + /** + * iam.projects.serviceAccounts.patch + * @desc Patches a ServiceAccount. Currently, only the following fields are + * updatable: `display_name` and `description`. Only fields specified in + * the request are guaranteed to be returned in the response. Other fields + * in the response may be empty. Note: The field mask is required. + * @alias iam.projects.serviceAccounts.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as a wildcard for the `PROJECT_ID` will infer the project from the `account` and the `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + * @param {().PatchServiceAccountRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Serviceaccounts$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Projects$Serviceaccounts$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Serviceaccounts$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Serviceaccounts$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Serviceaccounts$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Serviceaccounts$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * iam.projects.serviceAccounts.setIamPolicy * @desc Sets the Cloud IAM access control policy for a ServiceAccount. @@ -3365,6 +3447,28 @@ export namespace iam_v1 { */ pageToken?: string; } + export interface Params$Resource$Projects$Serviceaccounts$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the service account in the following format: + * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as + * a wildcard for the `PROJECT_ID` will infer the project from the `account` + * and the `ACCOUNT` value can be the `email` address or the `unique_id` of + * the service account. In responses the resource name will always be in + * the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PatchServiceAccountRequest; + } export interface Params$Resource$Projects$Serviceaccounts$Setiampolicy extends StandardParameters { /** diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 33fc8552a16..48503b55175 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -199,6 +199,28 @@ export namespace ml_v1 { */ minNodes?: number; } + /** + * Represents output related to a built-in algorithm Job. + */ + export interface Schema$GoogleCloudMlV1__BuiltInAlgorithmOutput { + /** + * Framework on which the built-in algorithm was trained on. + */ + framework?: string; + /** + * Built-in algorithm's saved model path. Only set for non-hptuning + * succeeded jobs. + */ + modelPath?: string; + /** + * Python version on which the built-in algorithm was trained on. + */ + pythonVersion?: string; + /** + * CMLE runtime version on which the built-in algorithm was trained on. + */ + runtimeVersion?: string; + } /** * Request message for the CancelJob method. */ @@ -243,6 +265,11 @@ export namespace ml_v1 { */ allMetrics?: Schema$GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric[]; + /** + * Details related to built-in algorithms job. Only set this for built-in + * algorithms jobs and for trials that succeeded. + */ + builtInAlgorithmOutput?: Schema$GoogleCloudMlV1__BuiltInAlgorithmOutput; /** * The final objective metric seen for this trial. */ @@ -938,6 +965,11 @@ export namespace ml_v1 { * Represents results of a training job. Output only. */ export interface Schema$GoogleCloudMlV1__TrainingOutput { + /** + * Details related to built-in algorithms job. Only set for built-in + * algorithms jobs. + */ + builtInAlgorithmOutput?: Schema$GoogleCloudMlV1__BuiltInAlgorithmOutput; /** * The number of hyperparameter tuning trials that completed successfully. * Only set for hyperparameter tuning jobs. @@ -947,6 +979,10 @@ export namespace ml_v1 { * The amount of ML units consumed by the job. */ consumedMLUnits?: number; + /** + * Whether this job is a built-in Algorithm job. + */ + isBuiltInAlgorithmJob?: boolean; /** * Whether this job is a hyperparameter tuning job. */ diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 45d71a233e8..8be1f9bdacd 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -597,8 +597,8 @@ export namespace monitoring_v3 { */ export interface Schema$Exemplar { /** - * Contextual information about the example value. Examples are:Trace ID: - * type.googleapis.com/google.devtools.cloudtrace.v1.TraceLiteral string: + * Contextual information about the example value. Examples are:Trace: + * type.googleapis.com/google.monitoring.v3.SpanContextLiteral string: * type.googleapis.com/google.protobuf.StringValueLabels dropped during * aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabelsThere * may be only a single attachment of any given message type in a single diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index fe6a3a74622..b57d3589c07 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -1881,7 +1881,9 @@ export namespace people_v1 { /** * people.contactGroups.members.modify * @desc Modify the members of a contact group owned by the authenticated - * user. + * user.
The only system contact groups that can have members added are + * `contactGroups/myContacts` and `contactGroups/starred`. Other system + * contact groups are deprecated and can only have contacts removed. * @alias people.contactGroups.members.modify * @memberOf! () * diff --git a/src/apis/remotebuildexecution/v1.ts b/src/apis/remotebuildexecution/v1.ts index 1bc3b67404d..694e61eb6ba 100644 --- a/src/apis/remotebuildexecution/v1.ts +++ b/src/apis/remotebuildexecution/v1.ts @@ -1657,6 +1657,13 @@ export namespace remotebuildexecution_v1 { * communications between itself and the remote CAS server. */ inlineBlobs?: Schema$GoogleDevtoolsRemoteworkersV1test2Blob[]; + /** + * Directory from which a command is executed. It is a relative directory + * with respect to the bot's working directory (i.e., "./"). + * If it is non-empty, then it must exist under "./". Otherwise, + * "./" will be used. + */ + workingDirectory?: string; } /** * An environment variable required by this task. diff --git a/src/apis/remotebuildexecution/v1alpha.ts b/src/apis/remotebuildexecution/v1alpha.ts index dece0d4771d..58aeaab752e 100644 --- a/src/apis/remotebuildexecution/v1alpha.ts +++ b/src/apis/remotebuildexecution/v1alpha.ts @@ -1642,6 +1642,13 @@ export namespace remotebuildexecution_v1alpha { * communications between itself and the remote CAS server. */ inlineBlobs?: Schema$GoogleDevtoolsRemoteworkersV1test2Blob[]; + /** + * Directory from which a command is executed. It is a relative directory + * with respect to the bot's working directory (i.e., "./"). + * If it is non-empty, then it must exist under "./". Otherwise, + * "./" will be used. + */ + workingDirectory?: string; } /** * An environment variable required by this task. diff --git a/src/apis/remotebuildexecution/v2.ts b/src/apis/remotebuildexecution/v2.ts index c5ac784a83f..72619a128dc 100644 --- a/src/apis/remotebuildexecution/v2.ts +++ b/src/apis/remotebuildexecution/v2.ts @@ -1947,6 +1947,13 @@ export namespace remotebuildexecution_v2 { * communications between itself and the remote CAS server. */ inlineBlobs?: Schema$GoogleDevtoolsRemoteworkersV1test2Blob[]; + /** + * Directory from which a command is executed. It is a relative directory + * with respect to the bot's working directory (i.e., "./"). + * If it is non-empty, then it must exist under "./". Otherwise, + * "./" will be used. + */ + workingDirectory?: string; } /** * An environment variable required by this task. diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 0ba4d688675..c5632f6cc2c 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -337,7 +337,7 @@ export namespace servicemanagement_v1 { * Optional if the key set document: - can be retrieved from [OpenID * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of * the issuer. - can be inferred from the email domain of the issuer (e.g. - * a Google service account). Example: + * a Google service account). Example: * https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string; @@ -520,7 +520,7 @@ export namespace servicemanagement_v1 { * '.' character. For repeated fields, an applicable unique * identifier field is used for the index (usually selector, name, or id). * For maps, the term 'key' is used. If the field has no unique - * identifier, the numeric index is used. Examples: - + * identifier, the numeric index is used. ## Examples: * visibility.rules[selector=="google.LibraryService.CreateBook"].restriction * - * quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value diff --git a/src/apis/servicenetworking/index.ts b/src/apis/servicenetworking/index.ts index f6ff55b21bf..2f4ba9e69bd 100644 --- a/src/apis/servicenetworking/index.ts +++ b/src/apis/servicenetworking/index.ts @@ -14,20 +14,28 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {servicenetworking_v1} from './v1'; import {servicenetworking_v1beta} from './v1beta'; export const VERSIONS = { + 'v1': servicenetworking_v1.Servicenetworking, 'v1beta': servicenetworking_v1beta.Servicenetworking, }; +export function servicenetworking(version: 'v1'): + servicenetworking_v1.Servicenetworking; +export function servicenetworking(options: servicenetworking_v1.Options): + servicenetworking_v1.Servicenetworking; export function servicenetworking(version: 'v1beta'): servicenetworking_v1beta.Servicenetworking; export function servicenetworking(options: servicenetworking_v1beta.Options): servicenetworking_v1beta.Servicenetworking; -export function -servicenetworking( +export function servicenetworking< + T = servicenetworking_v1.Servicenetworking | + servicenetworking_v1beta.Servicenetworking>( this: GoogleConfigurable, - versionOrOptions: 'v1beta'|servicenetworking_v1beta.Options) { + versionOrOptions: 'v1'| + servicenetworking_v1.Options|'v1beta'|servicenetworking_v1beta.Options) { return getAPI('servicenetworking', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts new file mode 100644 index 00000000000..494c19155c1 --- /dev/null +++ b/src/apis/servicenetworking/v1.ts @@ -0,0 +1,3036 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {GaxiosPromise} from 'gaxios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {APIRequestContext, BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace servicenetworking_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + let context: APIRequestContext; + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API + * access, quota, and reports. Required unless you provide an OAuth 2.0 + * token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Service Networking API + * + * Provides automatic management of network configurations necessary for + * certain services. + * + * @example + * const {google} = require('googleapis'); + * const servicenetworking = google.servicenetworking('v1'); + * + * @namespace servicenetworking + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Servicenetworking + */ + export class Servicenetworking { + operations: Resource$Operations; + services: Resource$Services; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + context = {_options: options || {}, google}; + + this.operations = new Resource$Operations(); + this.services = new Resource$Services(); + } + } + + /** + * Request to create a subnetwork in a previously peered service network. + */ + export interface Schema$AddSubnetworkRequest { + /** + * Required. A resource that represents the service consumer, such as + * `projects/123456`. The project number can be different from the value in + * the consumer network parameter. For example, the network might be part of + * a Shared VPC network. In those cases, Service Networking validates that + * this resource belongs to that Shared VPC. + */ + consumer?: string; + /** + * Required. The name of the service consumer's VPC network. The network + * must have an existing private connection that was provisioned through the + * connections.create method. The name must be in the following format: + * `projects/{project}/global/networks/{network}`, where {project} is a + * project number, such as `12345`. {network} is the name of a VPC network + * in the project. + */ + consumerNetwork?: string; + /** + * An optional description of the subnet. + */ + description?: string; + /** + * Required. The prefix length of the subnet's IP address range. Use + * CIDR range notation, such as `30` to provision a subnet with an + * `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of + * available ranges in the service consumer's allocated range. + */ + ipPrefixLength?: number; + /** + * Required. The name of a [region](/compute/docs/regions-zones) for the + * subnet, such `europe-west1`. + */ + region?: string; + /** + * Optional. The starting address of a range. The address must be a valid + * IPv4 address in the x.x.x.x format. This value combined with the IP + * prefix range is the CIDR range for the subnet. The range must be within + * the allocated range that is assigned to the private connection. If the + * CIDR range isn't available, the call fails. + */ + requestedAddress?: string; + /** + * Required. A name for the new subnet. For information about the naming + * requirements, see + * [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute + * API documentation. + */ + subnetwork?: string; + /** + * A list of members that are granted the `compute.networkUser` role on the + * subnet. + */ + subnetworkUsers?: string[]; + } + /** + * Api is a light-weight descriptor for an API Interface. Interfaces are also + * described as "protocol buffer services" in some contexts, such as + * by the "service" keyword in a .proto file, but they are different + * from API Services, which represent a concrete implementation of an + * interface as opposed to simply a description of methods and bindings. They + * are also sometimes simply referred to as "APIs" in other + * contexts, such as the name of this message itself. See + * https://cloud.google.com/apis/design/glossary for detailed terminology. + */ + export interface Schema$Api { + /** + * The methods of this interface, in unspecified order. + */ + methods?: Schema$Method[]; + /** + * Included interfaces. See Mixin. + */ + mixins?: Schema$Mixin[]; + /** + * The fully qualified name of this interface, including package name + * followed by the interface's simple name. + */ + name?: string; + /** + * Any metadata attached to the interface. + */ + options?: Schema$Option[]; + /** + * Source context for the protocol buffer service represented by this + * message. + */ + sourceContext?: Schema$SourceContext; + /** + * The source syntax of the service. + */ + syntax?: string; + /** + * A version string for this interface. If specified, must have the form + * `major-version.minor-version`, as in `1.10`. If the minor version is + * omitted, it defaults to zero. If the entire version field is empty, the + * major version is derived from the package name, as outlined below. If the + * field is not empty, the version in the package name will be verified to + * be consistent with what is provided here. The versioning schema uses + * [semantic versioning](http://semver.org) where the major version number + * indicates a breaking change and the minor version an additive, + * non-breaking change. Both version numbers are signals to users what to + * expect from different versions, and should be carefully chosen based on + * the product plan. The major version is also reflected in the package + * name of the interface, which must end in `v<major-version>`, as in + * `google.feature.v1`. For major versions 0 and 1, the suffix can be + * omitted. Zero major versions must only be used for experimental, non-GA + * interfaces. + */ + version?: string; + } + /** + * `Authentication` defines the authentication configuration for an API. + * Example for an API targeted for external use: name: + * calendar.googleapis.com authentication: providers: - id: + * google_calendar_auth jwks_uri: + * https://www.googleapis.com/oauth2/v1/certs issuer: + * https://securetoken.google.com rules: - selector: "*" + * requirements: provider_id: google_calendar_auth + */ + export interface Schema$Authentication { + /** + * Defines a set of authentication providers that a service supports. + */ + providers?: Schema$AuthProvider[]; + /** + * A list of authentication rules that apply to individual API methods. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$AuthenticationRule[]; + } + /** + * Authentication rules for the service. 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. + */ + export interface Schema$AuthenticationRule { + /** + * If true, the service accepts API keys without any other credential. + */ + allowWithoutCredential?: boolean; + /** + * The requirements for OAuth credentials. + */ + oauth?: Schema$OAuthRequirements; + /** + * Requirements for additional authentication providers. + */ + requirements?: Schema$AuthRequirement[]; + /** + * Selects the methods to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * Configuration of authorization. This section determines the authorization + * provider, if unspecified, then no authorization check will be done. + * Example: experimental: authorization: provider: + * firebaserules.googleapis.com + */ + export interface Schema$AuthorizationConfig { + /** + * The name of the authorization provider, such as + * firebaserules.googleapis.com. + */ + provider?: string; + } + /** + * Configuration for an anthentication provider, including support for [JSON + * Web Token + * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + */ + export interface Schema$AuthProvider { + /** + * The list of JWT + * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + * that are allowed to access. A JWT containing any of these audiences will + * be accepted. When this setting is absent, only JWTs with audience + * "https://Service_name/API_name" will be accepted. For example, + * if no audiences are in the setting, LibraryService API will only accept + * JWTs with the following audience + * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + * Example: audiences: bookstore_android.apps.googleusercontent.com, + * bookstore_web.apps.googleusercontent.com + */ + audiences?: string; + /** + * Redirect URL if JWT token is required but not present or is expired. + * Implement authorizationUrl of securityDefinitions in OpenAPI spec. + */ + authorizationUrl?: string; + /** + * The unique identifier of the auth provider. It will be referred to by + * `AuthRequirement.provider_id`. Example: "bookstore_auth". + */ + id?: string; + /** + * Identifies the principal that issued the JWT. See + * https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + * Usually a URL or an email address. Example: + * https://securetoken.google.com Example: + * 1234567-compute@developer.gserviceaccount.com + */ + issuer?: string; + /** + * URL of the provider's public key set to validate signature of the + * JWT. See [OpenID + * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). + * Optional if the key set document: - can be retrieved from [OpenID + * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of + * the issuer. - can be inferred from the email domain of the issuer (e.g. + * a Google service account). Example: + * https://www.googleapis.com/oauth2/v1/certs + */ + jwksUri?: string; + } + /** + * User-defined authentication requirements, including support for [JSON Web + * Token + * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + */ + export interface Schema$AuthRequirement { + /** + * NOTE: This will be deprecated soon, once AuthProvider.audiences is + * implemented and accepted in all the runtime components. The list of JWT + * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). + * that are allowed to access. A JWT containing any of these audiences will + * be accepted. When this setting is absent, only JWTs with audience + * "https://Service_name/API_name" will be accepted. For example, + * if no audiences are in the setting, LibraryService API will only accept + * JWTs with the following audience + * "https://library-example.googleapis.com/google.example.library.v1.LibraryService". + * Example: audiences: bookstore_android.apps.googleusercontent.com, + * bookstore_web.apps.googleusercontent.com + */ + audiences?: string; + /** + * id from authentication provider. Example: provider_id: + * bookstore_auth + */ + providerId?: string; + } + /** + * `Backend` defines the backend configuration for a service. + */ + export interface Schema$Backend { + /** + * A list of API backend rules that apply to individual API methods. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$BackendRule[]; + } + /** + * A backend rule provides configuration for an individual API element. + */ + export interface Schema$BackendRule { + /** + * The address of the API backend. + */ + address?: string; + /** + * The number of seconds to wait for a response from a request. The default + * deadline for gRPC is infinite (no deadline) and HTTP requests is 5 + * seconds. + */ + deadline?: number; + /** + * The JWT audience is used when generating a JWT id token for the backend. + */ + jwtAudience?: string; + /** + * Minimum deadline in seconds needed for this method. Calls having deadline + * value lower than this will be rejected. + */ + minDeadline?: number; + /** + * The number of seconds to wait for the completion of a long running + * operation. The default is no deadline. + */ + operationDeadline?: number; + pathTranslation?: string; + /** + * Selects the methods to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * Billing related configuration of the service. The following example shows + * how to configure monitored resources and metrics for billing: + * monitored_resources: - type: library.googleapis.com/branch labels: - + * key: /city description: The city where the library branch is + * located in. - key: /name description: The name of the branch. + * metrics: - name: library.googleapis.com/book/borrowed_count + * metric_kind: DELTA value_type: INT64 billing: + * consumer_destinations: - monitored_resource: + * library.googleapis.com/branch metrics: - + * library.googleapis.com/book/borrowed_count + */ + export interface Schema$Billing { + /** + * Billing configurations for sending metrics to the consumer project. There + * can be multiple consumer destinations per service, each one must have a + * different monitored resource type. A metric can be used in at most one + * consumer destination. + */ + consumerDestinations?: Schema$BillingDestination[]; + } + /** + * Configuration of a specific billing destination (Currently only support + * bill against consumer project). + */ + export interface Schema$BillingDestination { + /** + * Names of the metrics to report to this billing destination. Each name + * must be defined in Service.metrics section. + */ + metrics?: string[]; + /** + * The monitored resource type. The type must be defined in + * Service.monitored_resources section. + */ + monitoredResource?: string; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * Represents a private connection resource. A private connection is + * implemented as a VPC Network Peering connection between a service + * producer's VPC network and a service consumer's VPC network. + */ + export interface Schema$Connection { + /** + * The name of service consumer's VPC network that's connected with + * service producer network, in the following format: + * `projects/{project}/global/networks/{network}`. `{project}` is a project + * number, such as in `12345` that includes the VPC service consumer's + * VPC network. `{network}` is the name of the service consumer's VPC + * network. + */ + network?: string; + /** + * Output only. The name of the VPC Network Peering connection that was + * created by the service producer. + */ + peering?: string; + /** + * The name of one or more allocated IP address ranges for this service + * producer of type `PEERING`. Note that invoking CreateConnection method + * with a different range when connection is already established will not + * modify already provisioned service producer subnetworks. If + * CreateConnection method is invoked repeatedly to reconnect when peering + * connection had been disconnected on the consumer side, leaving this field + * empty will restore previously allocated IP ranges. + */ + reservedPeeringRanges?: string[]; + /** + * Output only. The name of the peering service that's associated with + * this connection, in the following format: `services/{service name}`. + */ + service?: string; + } + /** + * `Context` defines which contexts an API requests. Example: context: + * rules: - selector: "*" requested: - + * google.rpc.context.ProjectContext - + * google.rpc.context.OriginContext The above specifies that all methods in + * the API request `google.rpc.context.ProjectContext` and + * `google.rpc.context.OriginContext`. Available context types are defined in + * package `google.rpc.context`. This also provides mechanism to whitelist + * any protobuf message extension that can be sent in grpc metadata using + * “x-goog-ext-<extension_id>-bin” and + * “x-goog-ext-<extension_id>-jspb” format. For example, list any + * service specific protobuf types that can appear in grpc metadata as follows + * in your yaml file: Example: context: rules: - selector: + * "google.example.library.v1.LibraryService.CreateBook" + * allowed_request_extensions: - google.foo.v1.NewExtension + * allowed_response_extensions: - google.foo.v1.NewExtension You can + * also specify extension ID instead of fully qualified extension name here. + */ + export interface Schema$Context { + /** + * A list of RPC context rules that apply to individual API methods. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$ContextRule[]; + } + /** + * A context rule provides information about the context for an individual API + * element. + */ + export interface Schema$ContextRule { + /** + * A list of full type names or extension IDs of extensions allowed in grpc + * side channel from client to backend. + */ + allowedRequestExtensions?: string[]; + /** + * A list of full type names or extension IDs of extensions allowed in grpc + * side channel from backend to client. + */ + allowedResponseExtensions?: string[]; + /** + * A list of full type names of provided contexts. + */ + provided?: string[]; + /** + * A list of full type names of requested contexts. + */ + requested?: string[]; + /** + * Selects the methods to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * Selects and configures the service controller used by the service. The + * service controller handles features like abuse, quota, billing, logging, + * monitoring, etc. + */ + export interface Schema$Control { + /** + * The service control environment to use. If empty, no control plane + * feature (like quota and billing) will be enabled. + */ + environment?: string; + } + /** + * Customize service error responses. For example, list any service specific + * protobuf types that can appear in error detail lists of error responses. + * Example: custom_error: types: - google.foo.v1.CustomError + * - google.foo.v1.AnotherError + */ + export interface Schema$CustomError { + /** + * The list of custom error rules that apply to individual API messages. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$CustomErrorRule[]; + /** + * The list of custom error detail types, e.g. + * 'google.foo.v1.CustomError'. + */ + types?: string[]; + } + /** + * A custom error rule. + */ + export interface Schema$CustomErrorRule { + /** + * Mark this message as possible payload in error response. Otherwise, + * objects of this type will be filtered when they appear in error payload. + */ + isErrorType?: boolean; + /** + * Selects messages to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * A custom pattern is used for defining custom HTTP verb. + */ + export interface Schema$CustomHttpPattern { + /** + * The name of this custom HTTP verb. + */ + kind?: string; + /** + * The path matched by this custom verb. + */ + path?: string; + } + /** + * `Documentation` provides the information for describing a service. Example: + * <pre><code>documentation: summary: > The Google + * Calendar API gives access to most calendar features. pages: - name: + * Overview content: &#40;== include google/foo/overview.md + * ==&#41; - name: Tutorial content: &#40;== include + * google/foo/tutorial.md ==&#41; subpages; - name: Java content: + * &#40;== include google/foo/tutorial_java.md ==&#41; rules: - + * selector: google.calendar.Calendar.Get description: > ... - + * selector: google.calendar.Calendar.Put description: > ... + * </code></pre> Documentation is provided in markdown syntax. In + * addition to standard markdown features, definition lists, tables and fenced + * code blocks are supported. Section headers can be provided and are + * interpreted relative to the section nesting of the context where a + * documentation fragment is embedded. Documentation from the IDL is merged + * with documentation defined via the config at normalization time, where + * documentation provided by config rules overrides IDL provided. A number of + * constructs specific to the API platform are supported in documentation + * text. In order to reference a proto element, the following notation can be + * used: + * <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre> + * To override the display text used for the link, this can be used: + * <pre><code>&#91;display + * text]&#91;fully.qualified.proto.name]</code></pre> Text can + * be excluded from doc using the following notation: + * <pre><code>&#40;-- internal comment + * --&#41;</code></pre> A few directives are available in + * documentation. Note that directives must appear on a single line to be + * properly identified. The `include` directive includes a markdown file from + * an external source: <pre><code>&#40;== include path/to/file + * ==&#41;</code></pre> The `resource_for` directive marks a + * message to be the resource of a collection in REST view. If it is not + * specified, tools attempt to infer the resource from the operations in a + * collection: <pre><code>&#40;== resource_for + * v1.shelves.books ==&#41;</code></pre> The directive + * `suppress_warning` does not directly affect documentation and is documented + * together with service config validation. + */ + export interface Schema$Documentation { + /** + * The URL to the root of documentation. + */ + documentationRootUrl?: string; + /** + * Declares a single overview page. For example: + * <pre><code>documentation: summary: ... overview: + * &#40;== include overview.md ==&#41; </code></pre> + * This is a shortcut for the following declaration (using pages style): + * <pre><code>documentation: summary: ... pages: - name: + * Overview content: &#40;== include overview.md ==&#41; + * </code></pre> Note: you cannot specify both `overview` field + * and `pages` field. + */ + overview?: string; + /** + * The top level pages for the documentation set. + */ + pages?: Schema$Page[]; + /** + * A list of documentation rules that apply to individual API elements. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$DocumentationRule[]; + /** + * A short summary of what the service does. Can only be provided by plain + * text. + */ + summary?: string; + } + /** + * A documentation rule provides information about individual API elements. + */ + export interface Schema$DocumentationRule { + /** + * Deprecation description of the selected element(s). It can be provided if + * an element is marked as `deprecated`. + */ + deprecationDescription?: string; + /** + * Description of the selected API(s). + */ + description?: string; + /** + * The selector is a comma-separated list of patterns. Each pattern is a + * qualified name of the element which may end in "*", indicating + * a wildcard. Wildcards are only allowed at the end and for a whole + * component of the qualified name, i.e. "foo.*" is ok, but not + * "foo.b*" or "foo.*.bar". To specify a default for all + * applicable elements, the whole pattern "*" is used. + */ + selector?: string; + } + /** + * 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 `{}`. + */ + export interface Schema$Empty {} + /** + * `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 allow_cors: true + */ + export interface Schema$Endpoint { + /** + * DEPRECATED: This field is no longer supported. Instead of using aliases, + * please specify multiple google.api.Endpoint for each of the intended + * aliases. Additional names that this endpoint will be hosted on. + */ + aliases?: string[]; + /** + * 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. + */ + allowCors?: boolean; + /** + * The list of features enabled on this endpoint. + */ + features?: string[]; + /** + * The canonical name of this endpoint. + */ + name?: string; + /** + * The specification of an Internet routable address of API frontend that + * will handle requests to this [API + * Endpoint](https://cloud.google.com/apis/design/glossary). It should be + * either a valid IPv4 address or a fully-qualified domain name. For + * example, "8.8.8.8" or "myservice.appspot.com". + */ + target?: string; + } + /** + * Enum type definition. + */ + export interface Schema$Enum { + /** + * Enum value definitions. + */ + enumvalue?: Schema$EnumValue[]; + /** + * Enum type name. + */ + name?: string; + /** + * Protocol buffer options. + */ + options?: Schema$Option[]; + /** + * The source context. + */ + sourceContext?: Schema$SourceContext; + /** + * The source syntax. + */ + syntax?: string; + } + /** + * Enum value definition. + */ + export interface Schema$EnumValue { + /** + * Enum value name. + */ + name?: string; + /** + * Enum value number. + */ + number?: number; + /** + * Protocol buffer options. + */ + options?: Schema$Option[]; + } + /** + * Experimental service configuration. These configuration options can only be + * used by whitelisted users. + */ + export interface Schema$Experimental { + /** + * Authorization configuration. + */ + authorization?: Schema$AuthorizationConfig; + } + /** + * A single field of a message type. + */ + export interface Schema$Field { + /** + * The field cardinality. + */ + cardinality?: string; + /** + * The string value of the default value of this field. Proto2 syntax only. + */ + defaultValue?: string; + /** + * The field JSON name. + */ + jsonName?: string; + /** + * The field type. + */ + kind?: string; + /** + * The field name. + */ + name?: string; + /** + * The field number. + */ + number?: number; + /** + * The index of the field type in `Type.oneofs`, for message or enumeration + * types. The first type has index 1; zero means the type is not in the + * list. + */ + oneofIndex?: number; + /** + * The protocol buffer options. + */ + options?: Schema$Option[]; + /** + * Whether to use alternative packed wire representation. + */ + packed?: boolean; + /** + * The field type URL, without the scheme, for message or enumeration types. + * Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + */ + typeUrl?: string; + } + /** + * Represents a subnet that was created or discovered by a private access + * management service. + */ + export interface Schema$GoogleCloudServicenetworkingV1betaSubnetwork { + /** + * Subnetwork CIDR range in `10.x.x.x/y` format. + */ + ipCidrRange?: string; + /** + * Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + */ + name?: string; + /** + * In the Shared VPC host project, the VPC network that's peered with + * the consumer network. For example: + * `projects/1234321/global/networks/host-network` + */ + network?: string; + /** + * This is a discovered subnet that is not within the current consumer + * allocated ranges. + */ + outsideAllocation?: boolean; + } + /** + * Defines the HTTP configuration for an API service. It contains a list of + * HttpRule, each specifying the mapping of an RPC method to one or more HTTP + * REST API methods. + */ + export interface Schema$Http { + /** + * When set to true, URL path parameters will be fully URI-decoded except in + * cases of single segment matches in reserved expansion, where + * "%2F" will be left encoded. The default behavior is to not + * decode RFC 6570 reserved characters in multi segment matches. + */ + fullyDecodeReservedExpansion?: boolean; + /** + * A list of HTTP configuration rules that apply to individual API methods. + * **NOTE:** All service configuration rules follow "last one + * wins" order. + */ + rules?: Schema$HttpRule[]; + } + /** + * # gRPC Transcoding gRPC Transcoding is a feature for mapping between a + * gRPC method and one or more HTTP REST endpoints. It allows developers to + * build a single API service that supports both gRPC APIs and REST APIs. Many + * systems, including [Google APIs](https://github.com/googleapis/googleapis), + * [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC + * Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and + * [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and + * use it for large scale production services. `HttpRule` defines the schema + * of the gRPC/REST mapping. The mapping specifies how different portions of + * the gRPC request message are mapped to the URL path, URL query parameters, + * and HTTP request body. It also controls how the gRPC response message is + * mapped to the HTTP response body. `HttpRule` is typically specified as an + * `google.api.http` annotation on the gRPC method. Each mapping specifies a + * URL path template and an HTTP method. The path template may refer to one or + * more fields in the gRPC request message, as long as each field is a + * non-repeated field with a primitive (non-message) type. The path template + * controls how fields of the request message are mapped to the URL path. + * Example: service Messaging { rpc GetMessage(GetMessageRequest) + * returns (Message) { option (google.api.http) = { get: + * "/v1/{name=messages/*}" }; } } message + * GetMessageRequest { string name = 1; // Mapped to URL path. } + * message Message { string text = 1; // The resource content. } + * This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC + * -----|----- `GET /v1/messages/123456` | `GetMessage(name: + * "messages/123456")` Any fields in the request message which are + * not bound by the path template automatically become HTTP query parameters + * if there is no HTTP request body. For example: service Messaging { rpc + * GetMessage(GetMessageRequest) returns (Message) { option + * (google.api.http) = { get:"/v1/messages/{message_id}" + * }; } } message GetMessageRequest { message SubMessage { + * string subfield = 1; } string message_id = 1; // Mapped to URL + * path. int64 revision = 2; // Mapped to URL query parameter + * `revision`. SubMessage sub = 3; // Mapped to URL query parameter + * `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: + * HTTP | gRPC -----|----- `GET + * /v1/messages/123456?revision=2&sub.subfield=foo` | + * `GetMessage(message_id: "123456" revision: 2 sub: + * SubMessage(subfield: "foo"))` Note that fields which are mapped + * to URL query parameters must have a primitive type or a repeated primitive + * type or a non-repeated message type. In the case of a repeated type, the + * parameter can be repeated in the URL as `...?param=A&param=B`. In the + * case of a message type, each field of the message is mapped to a separate + * parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods + * that allow a request body, the `body` field specifies the mapping. Consider + * a REST update method on the message resource collection: service + * Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) + * { option (google.api.http) = { patch: + * "/v1/messages/{message_id}" body: "message" + * }; } } message UpdateMessageRequest { string message_id + * = 1; // mapped to the URL Message message = 2; // mapped to the + * body } The following HTTP JSON to RPC mapping is enabled, where the + * representation of the JSON in the request body is determined by protos JSON + * encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 { + * "text": "Hi!" }` | `UpdateMessage(message_id: + * "123456" message { text: "Hi!" })` The special name + * `*` can be used in the body mapping to define that every field not bound by + * the path template should be mapped to the request body. This enables the + * following alternative definition of the update method: service + * Messaging { rpc UpdateMessage(Message) returns (Message) { option + * (google.api.http) = { patch: + * "/v1/messages/{message_id}" body: "*" }; } } + * message Message { string message_id = 1; string text = 2; } + * The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- + * `PATCH /v1/messages/123456 { "text": "Hi!" }` | + * `UpdateMessage(message_id: "123456" text: "Hi!")` Note + * that when using `*` in the body mapping, it is not possible to have HTTP + * parameters, as all fields not bound by the path end in the body. This makes + * this option more rarely used in practice when defining REST APIs. The + * common usage of `*` is in custom methods which don't use the URL at all + * for transferring data. It is possible to define multiple HTTP methods for + * one RPC by using the `additional_bindings` option. Example: service + * Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { + * option (google.api.http) = { get: + * "/v1/messages/{message_id}" additional_bindings { get: + * "/v1/users/{user_id}/messages/{message_id}" } }; } } + * message GetMessageRequest { string message_id = 1; string + * user_id = 2; } This enables the following two alternative HTTP JSON to + * RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` | + * `GetMessage(message_id: "123456")` `GET + * /v1/users/me/messages/123456` | `GetMessage(user_id: "me" + * message_id: "123456")` ## Rules for HTTP mapping 1. Leaf + * request fields (recursive expansion nested messages in the request message) + * are classified into three categories: - Fields referred by the path + * template. They are passed via the URL path. - Fields referred by the + * HttpRule.body. They are passed via the HTTP request body. - All + * other fields are passed via the URL query parameters, and the parameter + * name is the field path in the request message. A repeated field can be + * represented as multiple query parameters under the same name. 2. If + * HttpRule.body is "*", there is no URL query parameter, all fields + * are passed via URL path and HTTP request body. 3. If HttpRule.body is + * omitted, there is no HTTP request body, all fields are passed via URL + * path and URL query parameters. ### Path template syntax Template = + * "/" Segments [ Verb ] ; Segments = Segment { "/" + * Segment } ; Segment = "*" | "**" | LITERAL | + * Variable ; Variable = "{" FieldPath [ "=" Segments + * ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb + * = ":" LITERAL ; The syntax `*` matches a single URL path + * segment. The syntax `**` matches zero or more URL path segments, which must + * be the last part of the URL path except the `Verb`. The syntax `Variable` + * matches part of the URL path as specified by its template. A variable + * template must not contain other variables. If a variable matches a single + * path segment, its template may be omitted, e.g. `{var}` is equivalent to + * `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If + * the `LITERAL` contains any reserved character, such characters should be + * percent-encoded before the matching. If a variable contains exactly one + * path segment, such as `"{var}"` or `"{var=*}"`, when + * such a variable is expanded into a URL path on the client side, all + * characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side + * does the reverse decoding. Such variables show up in the [Discovery + * Document](https://developers.google.com/discovery/v1/reference/apis) as + * `{var}`. If a variable contains multiple path segments, such as + * `"{var=foo/*}"` or `"{var=**}"`, when such a variable + * is expanded into a URL path on the client side, all characters except + * `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse + * decoding, except "%2F" and "%2f" are left unchanged. + * Such variables show up in the [Discovery + * Document](https://developers.google.com/discovery/v1/reference/apis) as + * `{+var}`. ## Using gRPC API Service Configuration gRPC API Service + * Configuration (service config) is a configuration language for configuring + * a gRPC service to become a user-facing product. The service config is + * simply the YAML representation of the `google.api.Service` proto message. + * As an alternative to annotating your proto file, you can configure gRPC + * transcoding in your service config YAML files. You do this by specifying a + * `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same + * effect as the proto annotation. This can be particularly useful if you have + * a proto that is reused in multiple services. Note that any transcoding + * specified in the service config will override any matching transcoding + * configuration in the proto. Example: http: rules: # + * Selects a gRPC method and applies HttpRule to it. - selector: + * example.v1.Messaging.GetMessage get: + * /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC + * Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON + * conversion must follow the [proto3 + * specification](https://developers.google.com/protocol-buffers/docs/proto3#json). + * While the single segment variable follows the semantics of [RFC + * 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + * Expansion, the multi segment variable **does not** follow RFC 6570 + * Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion + * does not expand special characters like `?` and `#`, which would lead to + * invalid URLs. As the result, gRPC Transcoding uses a custom encoding for + * multi segment variables. The path variables **must not** refer to any + * repeated or mapped field, because client libraries are not capable of + * handling such variable expansion. The path variables **must not** capture + * the leading "/" character. The reason is that the most common use + * case "{var}" does not capture the leading "/" + * character. For consistency, all path variables must share the same + * behavior. Repeated message fields must not be mapped to URL query + * parameters, because no client library can support such complicated mapping. + * If an API needs to use a JSON array for request or response body, it can + * map the request or response body to a repeated field. However, some gRPC + * Transcoding implementations may not support this feature. + */ + export interface Schema$HttpRule { + /** + * Additional HTTP bindings for the selector. Nested bindings must not + * contain an `additional_bindings` field themselves (that is, the nesting + * may only be one level deep). + */ + additionalBindings?: Schema$HttpRule[]; + /** + * The name of the request field whose value is mapped to the HTTP request + * body, or `*` for mapping all request fields not captured by the path + * pattern to the HTTP body, or omitted for not having any HTTP request + * body. NOTE: the referred field must be present at the top-level of the + * request message type. + */ + body?: string; + /** + * The custom pattern is used for specifying an HTTP method that is not + * included in the `pattern` field, such as HEAD, or "*" to leave + * the HTTP method unspecified for this rule. The wild-card rule is useful + * for services that provide content to Web (HTML) clients. + */ + custom?: Schema$CustomHttpPattern; + /** + * Maps to HTTP DELETE. Used for deleting a resource. + */ + delete?: string; + /** + * Maps to HTTP GET. Used for listing and getting information about + * resources. + */ + get?: string; + /** + * Maps to HTTP PATCH. Used for updating a resource. + */ + patch?: string; + /** + * Maps to HTTP POST. Used for creating a resource or performing an action. + */ + post?: string; + /** + * Maps to HTTP PUT. Used for replacing a resource. + */ + put?: string; + /** + * Optional. The name of the response field whose value is mapped to the + * HTTP response body. When omitted, the entire response message will be + * used as the HTTP response body. NOTE: The referred field must be present + * at the top-level of the response message type. + */ + responseBody?: string; + /** + * Selects a method to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * A description of a label. + */ + export interface Schema$LabelDescriptor { + /** + * A human-readable description for the label. + */ + description?: string; + /** + * The label key. + */ + key?: string; + /** + * The type of data that can be assigned to the label. + */ + valueType?: string; + } + /** + * ListConnectionsResponse is the response to list peering states for the + * given service and consumer project. + */ + export interface Schema$ListConnectionsResponse { + /** + * The list of Connections. + */ + connections?: Schema$Connection[]; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * A description of a log type. Example in YAML format: - name: + * library.googleapis.com/activity_history description: The history of + * borrowing and returning library items. display_name: Activity labels: + * - key: /customer_id description: Identifier of a library customer + */ + export interface Schema$LogDescriptor { + /** + * A human-readable description of this log. This information appears in the + * documentation and can contain details. + */ + description?: string; + /** + * The human-readable name for this log. This information appears on the + * user interface and should be concise. + */ + displayName?: string; + /** + * The set of labels that are available to describe a specific log entry. + * Runtime requests that contain labels not specified here are considered + * invalid. + */ + labels?: Schema$LabelDescriptor[]; + /** + * The name of the log. It must be less than 512 characters long and can + * include the following characters: upper- and lower-case alphanumeric + * characters [A-Za-z0-9], and punctuation characters including slash, + * underscore, hyphen, period [/_-.]. + */ + name?: string; + } + /** + * Logging configuration of the service. The following example shows how to + * configure logs to be sent to the producer and consumer projects. In the + * example, the `activity_history` log is sent to both the producer and + * consumer projects, whereas the `purchase_history` log is only sent to the + * producer project. monitored_resources: - type: + * library.googleapis.com/branch labels: - key: /city description: + * The city where the library branch is located in. - key: /name + * description: The name of the branch. logs: - name: activity_history + * labels: - key: /customer_id - name: purchase_history logging: + * producer_destinations: - monitored_resource: + * library.googleapis.com/branch logs: - activity_history - + * purchase_history consumer_destinations: - monitored_resource: + * library.googleapis.com/branch logs: - activity_history + */ + export interface Schema$Logging { + /** + * Logging configurations for sending logs to the consumer project. There + * can be multiple consumer destinations, each one must have a different + * monitored resource type. A log can be used in at most one consumer + * destination. + */ + consumerDestinations?: Schema$LoggingDestination[]; + /** + * Logging configurations for sending logs to the producer project. There + * can be multiple producer destinations, each one must have a different + * monitored resource type. A log can be used in at most one producer + * destination. + */ + producerDestinations?: Schema$LoggingDestination[]; + } + /** + * Configuration of a specific logging destination (the producer project or + * the consumer project). + */ + export interface Schema$LoggingDestination { + /** + * Names of the logs to be sent to this destination. Each name must be + * defined in the Service.logs section. If the log name is not a domain + * scoped name, it will be automatically prefixed with the service name + * followed by "/". + */ + logs?: string[]; + /** + * The monitored resource type. The type must be defined in the + * Service.monitored_resources section. + */ + monitoredResource?: string; + } + /** + * Method represents a method of an API interface. + */ + export interface Schema$Method { + /** + * The simple name of this method. + */ + name?: string; + /** + * Any metadata attached to the method. + */ + options?: Schema$Option[]; + /** + * If true, the request is streamed. + */ + requestStreaming?: boolean; + /** + * A URL of the input message type. + */ + requestTypeUrl?: string; + /** + * If true, the response is streamed. + */ + responseStreaming?: boolean; + /** + * The URL of the output message type. + */ + responseTypeUrl?: string; + /** + * The source syntax of this method. + */ + syntax?: string; + } + /** + * Defines a metric type and its schema. Once a metric descriptor is created, + * deleting or altering it stops data collection and makes the metric + * type's existing data unusable. + */ + export interface Schema$MetricDescriptor { + /** + * A detailed description of the metric, which can be used in documentation. + */ + description?: string; + /** + * A concise name for the metric, which can be displayed in user interfaces. + * Use sentence case without an ending period, for example "Request + * count". This field is optional but it is recommended to be set for + * any metrics associated with user-visible concepts, such as Quota. + */ + displayName?: string; + /** + * The set of labels that can be used to describe a specific instance of + * this metric type. For example, the + * `appengine.googleapis.com/http/server/response_latencies` metric type has + * a label for the HTTP response code, `response_code`, so you can look at + * latencies for successful responses or just for responses that failed. + */ + labels?: Schema$LabelDescriptor[]; + /** + * Optional. Metadata which can be used to guide usage of the metric. + */ + metadata?: Schema$MetricDescriptorMetadata; + /** + * Whether the metric records instantaneous values, changes to a value, etc. + * Some combinations of `metric_kind` and `value_type` might not be + * supported. + */ + metricKind?: string; + /** + * The resource name of the metric descriptor. + */ + name?: string; + /** + * The metric type, including its DNS name prefix. The type is not + * URL-encoded. All user-defined metric types have the DNS name + * `custom.googleapis.com` or `external.googleapis.com`. Metric types + * should use a natural hierarchical grouping. For example: + * "custom.googleapis.com/invoice/paid/amount" + * "external.googleapis.com/prometheus/up" + * "appengine.googleapis.com/http/server/response_latencies" + */ + type?: string; + /** + * The unit in which the metric value is reported. It is only applicable if + * the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported + * units are a subset of [The Unified Code for Units of + * Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units + * (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute + * * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo + * (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera + * (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z` + * zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) * + * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico + * (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` + * zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) * + * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40) + * **Grammar** The grammar also includes these connectors: * `/` division + * (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix + * operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression + * = Component { "." Component } { "/" Component } ; + * Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | + * Annotation | "1" ; Annotation + * = "{" NAME "}" ; Notes: * `Annotation` is just a + * comment if it follows a `UNIT` and is equivalent to `1` if it is used + * alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == + * By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not + * containing '{' or '}'. * `1` represents dimensionless + * value 1, such as in `1/s`. * `%` represents dimensionless value 1/100, + * and annotates values giving a percentage. + */ + unit?: string; + /** + * Whether the measurement is an integer, a floating-point number, etc. Some + * combinations of `metric_kind` and `value_type` might not be supported. + */ + valueType?: string; + } + /** + * Additional annotations that can be used to guide the usage of a metric. + */ + export interface Schema$MetricDescriptorMetadata { + /** + * The delay of data points caused by ingestion. Data points older than this + * age are guaranteed to be ingested and available to be read, excluding + * data loss due to errors. + */ + ingestDelay?: string; + /** + * The launch stage of the metric definition. + */ + launchStage?: string; + /** + * The sampling period of metric data points. For metrics which are written + * periodically, consecutive data points are stored at this time interval, + * excluding data loss due to errors. Metrics with a higher granularity have + * a smaller sampling period. + */ + samplePeriod?: string; + } + /** + * Bind API methods to metrics. Binding a method to a metric causes that + * metric's configured quota behaviors to apply to the method call. + */ + export interface Schema$MetricRule { + /** + * Metrics to update when the selected methods are called, and the + * associated cost applied to each metric. The key of the map is the metric + * name, and the values are the amount increased for the metric against + * which the quota limits are defined. The value must not be negative. + */ + metricCosts?: {[key: string]: string;}; + /** + * Selects the methods to which this rule applies. Refer to selector for + * syntax details. + */ + selector?: string; + } + /** + * Declares an API Interface to be included in this interface. The including + * interface must redeclare all the methods from the included interface, but + * documentation and options are inherited as follows: - If after comment and + * whitespace stripping, the documentation string of the redeclared method + * is empty, it will be inherited from the original method. - Each + * annotation belonging to the service config (http, visibility) which is + * not set in the redeclared method will be inherited. - If an http + * annotation is inherited, the path pattern will be modified as follows. + * Any version prefix will be replaced by the version of the including + * interface plus the root path if specified. Example of a simple mixin: + * package google.acl.v1; service AccessControl { // Get the + * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { + * option (google.api.http).get = "/v1/{resource=**}:getAcl"; } } + * package google.storage.v2; service Storage { // rpc + * GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc + * GetData(GetDataRequest) returns (Data) { option + * (google.api.http).get = "/v2/{resource=**}"; } } + * Example of a mixin configuration: apis: - name: + * google.storage.v2.Storage mixins: - name: + * google.acl.v1.AccessControl The mixin construct implies that all methods + * in `AccessControl` are also declared with same name and request/response + * types in `Storage`. A documentation generator or annotation processor will + * see the effective `Storage.GetAcl` method after inherting documentation and + * annotations as follows: service Storage { // Get the underlying + * ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option + * (google.api.http).get = "/v2/{resource=**}:getAcl"; } ... + * } Note how the version in the path pattern changed from `v1` to `v2`. If + * the `root` field in the mixin is specified, it should be a relative path + * under which inherited HTTP paths are placed. Example: apis: - + * name: google.storage.v2.Storage mixins: - name: + * google.acl.v1.AccessControl root: acls This implies the following + * inherited HTTP annotation: service Storage { // Get the + * underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { + * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl"; + * } ... } + */ + export interface Schema$Mixin { + /** + * The fully qualified name of the interface which is included. + */ + name?: string; + /** + * If non-empty specifies a path under which inherited HTTP paths are + * rooted. + */ + root?: string; + } + /** + * An object that describes the schema of a MonitoredResource object using a + * type name and a set of labels. For example, the monitored resource + * descriptor for Google Compute Engine VM instances has a type of + * `"gce_instance"` and specifies the use of the labels + * `"instance_id"` and `"zone"` to identify particular VM + * instances. Different APIs can support different monitored resource types. + * APIs generally provide a `list` method that returns the monitored resource + * descriptors used by the API. + */ + export interface Schema$MonitoredResourceDescriptor { + /** + * Optional. A detailed description of the monitored resource type that + * might be used in documentation. + */ + description?: string; + /** + * Optional. A concise name for the monitored resource type that might be + * displayed in user interfaces. It should be a Title Cased Noun Phrase, + * without any article or other determiners. For example, `"Google + * Cloud SQL Database"`. + */ + displayName?: string; + /** + * 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"`. + */ + labels?: Schema$LabelDescriptor[]; + /** + * Optional. The resource name of the monitored resource descriptor: + * `"projects/{project_id}/monitoredResourceDescriptors/{type}"` + * where {type} is the value of the `type` field in this object and + * {project_id} is a project ID that provides API-specific context for + * accessing the type. APIs that do not use project information can use the + * resource name format `"monitoredResourceDescriptors/{type}"`. + */ + name?: string; + /** + * Required. The monitored resource type. For example, the type + * `"cloudsql_database"` represents databases in Google Cloud SQL. + * The maximum length of this value is 256 characters. + */ + type?: string; + } + /** + * Monitoring configuration of the service. The example below shows how to + * configure monitored resources and metrics for monitoring. In the example, a + * monitored resource and two metrics are defined. The + * `library.googleapis.com/book/returned_count` metric is sent to both + * producer and consumer projects, whereas the + * `library.googleapis.com/book/overdue_count` metric is only sent to the + * consumer project. monitored_resources: - type: + * library.googleapis.com/branch labels: - key: /city description: + * The city where the library branch is located in. - key: /name + * description: The name of the branch. metrics: - name: + * library.googleapis.com/book/returned_count metric_kind: DELTA + * value_type: INT64 labels: - key: /customer_id - name: + * library.googleapis.com/book/overdue_count metric_kind: GAUGE + * value_type: INT64 labels: - key: /customer_id monitoring: + * producer_destinations: - monitored_resource: + * library.googleapis.com/branch metrics: - + * library.googleapis.com/book/returned_count consumer_destinations: - + * monitored_resource: library.googleapis.com/branch metrics: - + * library.googleapis.com/book/returned_count - + * library.googleapis.com/book/overdue_count + */ + export interface Schema$Monitoring { + /** + * Monitoring configurations for sending metrics to the consumer project. + * There can be multiple consumer destinations. A monitored resouce type may + * appear in multiple monitoring destinations if different aggregations are + * needed for different sets of metrics associated with that monitored + * resource type. A monitored resource and metric pair may only be used once + * in the Monitoring configuration. + */ + consumerDestinations?: Schema$MonitoringDestination[]; + /** + * Monitoring configurations for sending metrics to the producer project. + * There can be multiple producer destinations. A monitored resouce type may + * appear in multiple monitoring destinations if different aggregations are + * needed for different sets of metrics associated with that monitored + * resource type. A monitored resource and metric pair may only be used once + * in the Monitoring configuration. + */ + producerDestinations?: Schema$MonitoringDestination[]; + } + /** + * Configuration of a specific monitoring destination (the producer project or + * the consumer project). + */ + export interface Schema$MonitoringDestination { + /** + * Types of the metrics to report to this monitoring destination. Each type + * must be defined in Service.metrics section. + */ + metrics?: string[]; + /** + * The monitored resource type. The type must be defined in + * Service.monitored_resources section. + */ + monitoredResource?: string; + } + /** + * OAuth scopes are a way to define data and permissions on data. For example, + * there are scopes defined for "Read-only access to Google + * Calendar" and "Access to Cloud Platform". Users can consent + * to a scope for an application, giving it permission to access that data on + * their behalf. OAuth scope specifications should be fairly coarse grained; + * a user will need to see and understand the text description of what your + * scope means. In most cases: use one or at most two OAuth scopes for an + * entire family of products. If your product has multiple APIs, you should + * probably be sharing the OAuth scope across all of those APIs. When you + * need finer grained OAuth consent screens: talk with your product management + * about how developers will use them in practice. Please note that even + * though each of the canonical scopes is enough for a request to be accepted + * and passed to the backend, a request can still fail due to the backend + * requiring additional scopes or permissions. + */ + export interface Schema$OAuthRequirements { + /** + * The list of publicly documented OAuth scopes that are allowed access. An + * OAuth token containing any of these scopes will be accepted. Example: + * canonical_scopes: https://www.googleapis.com/auth/calendar, + * https://www.googleapis.com/auth/calendar.read + */ + canonicalScopes?: string; + } + /** + * This resource represents a long-running operation that is the result of a + * network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If + * `true`, the operation is completed, and either `error` or `response` is + * available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * 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. + */ + metadata?: {[key: string]: any;}; + /** + * 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`. + */ + name?: string; + /** + * 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`. + */ + response?: {[key: string]: any;}; + } + /** + * A protocol buffer option, which can be attached to a message, field, + * enumeration, etc. + */ + export interface Schema$Option { + /** + * The option's name. For protobuf built-in options (options defined in + * descriptor.proto), this is the short name. For example, + * `"map_entry"`. For custom options, it should be the + * fully-qualified name. For example, `"google.api.http"`. + */ + name?: string; + /** + * The option's value packed in an Any message. If the value is a + * primitive, the corresponding wrapper type defined in + * google/protobuf/wrappers.proto should be used. If the value is an enum, + * it should be stored as an int32 value using the + * google.protobuf.Int32Value type. + */ + value?: {[key: string]: any;}; + } + /** + * Represents a documentation page. A page can contain subpages to represent + * nested documentation set structure. + */ + export interface Schema$Page { + /** + * The Markdown content of the page. You can use <code>&#40;== + * include {path} ==&#41;</code> to include content from a + * Markdown file. + */ + content?: string; + /** + * The name of the page. It will be used as an identity of the page to + * generate URI of the page, text of the link to this page in navigation, + * etc. The full page name (start from the root page name to this page + * concatenated with `.`) can be used as reference to the page in your + * documentation. For example: <pre><code>pages: - name: + * Tutorial content: &#40;== include tutorial.md ==&#41; subpages: + * - name: Java content: &#40;== include tutorial_java.md + * ==&#41; </code></pre> You can reference `Java` page using + * Markdown reference link syntax: `Java`. + */ + name?: string; + /** + * Subpages of this page. The order of subpages specified here will be + * honored in the generated docset. + */ + subpages?: Schema$Page[]; + } + export interface Schema$Quota { + /** + * List of `QuotaLimit` definitions for the service. + */ + limits?: Schema$QuotaLimit[]; + /** + * List of `MetricRule` definitions, each one mapping a selected method to + * one or more metrics. + */ + metricRules?: Schema$MetricRule[]; + } + /** + * `QuotaLimit` defines a specific limit that applies over a specified + * duration for a limit type. There can be at most one limit for a duration + * and limit type combination defined within a `QuotaGroup`. + */ + export interface Schema$QuotaLimit { + /** + * Default number of tokens that can be consumed during the specified + * duration. This is the number of tokens assigned when a client application + * developer activates the service for his/her project. Specifying a value + * of 0 will block all requests. This can be used if you are provisioning + * quota to selected consumers and blocking others. Similarly, a value of -1 + * will indicate an unlimited quota. No other negative values are allowed. + * Used by group-based quotas only. + */ + defaultLimit?: string; + /** + * Optional. User-visible, extended description for this quota limit. Should + * be used only when more context is needed to understand this limit than + * provided by the limit's display name (see: `display_name`). + */ + description?: string; + /** + * User-visible display name for this limit. Optional. If not set, the UI + * will provide a default display name based on the quota configuration. + * This field can be used to override the default display name generated + * from the configuration. + */ + displayName?: string; + /** + * Duration of this limit in textual notation. Example: "100s", + * "24h", "1d". For duration longer than a day, only + * multiple of days is supported. We support only "100s" and + * "1d" for now. Additional support will be added in the future. + * "0" indicates indefinite duration. Used by group-based quotas + * only. + */ + duration?: string; + /** + * Free tier value displayed in the Developers Console for this limit. The + * free tier is the number of tokens that will be subtracted from the billed + * amount when billing is enabled. This field can only be set on a limit + * with duration "1d", in a billable group; it is invalid on any + * other limit. If this field is not set, it defaults to 0, indicating that + * there is no free tier for this service. Used by group-based quotas only. + */ + freeTier?: string; + /** + * Maximum number of tokens that can be consumed during the specified + * duration. Client application developers can override the default limit up + * to this maximum. If specified, this value cannot be set to a value less + * than the default limit. If not specified, it is set to the default limit. + * To allow clients to apply overrides with no upper bound, set this to -1, + * indicating unlimited maximum quota. Used by group-based quotas only. + */ + maxLimit?: string; + /** + * The name of the metric this quota limit applies to. The quota limits with + * the same metric will be checked together during runtime. The metric must + * be defined within the service config. + */ + metric?: string; + /** + * Name of the quota limit. The name must be provided, and it must be + * unique within the service. The name can only include alphanumeric + * characters as well as '-'. The maximum length of the limit name + * is 64 characters. + */ + name?: string; + /** + * Specify the unit of the quota limit. It uses the same syntax as + * Metric.unit. The supported unit kinds are determined by the quota backend + * system. Here are some examples: * "1/min/{project}" for quota + * per minute per project. Note: the order of unit components is + * insignificant. The "1" at the beginning is required to follow + * the metric unit syntax. + */ + unit?: string; + /** + * Tiered limit values. You must specify this as a key:value pair, with an + * integer value that is the maximum number of requests allowed for the + * specified unit. Currently only STANDARD is supported. + */ + values?: {[key: string]: string;}; + } + /** + * Represents a found unused range. + */ + export interface Schema$Range { + /** + * CIDR range in "10.x.x.x/y" format that is within the allocated + * ranges and currently unused. + */ + ipCidrRange?: string; + /** + * In the Shared VPC host project, the VPC network that's peered with + * the consumer network. For example: + * `projects/1234321/global/networks/host-network` + */ + network?: string; + } + /** + * Request to search for an unused range within allocated ranges. + */ + export interface Schema$SearchRangeRequest { + /** + * Required. The prefix length of the IP range. Use usual CIDR range + * notation. For example, '30' to find unused x.x.x.x/30 CIDR range. + * Actual range will be determined using allocated range for the consumer + * peered network and returned in the result. + */ + ipPrefixLength?: number; + /** + * Network name in the consumer project. This network must have been + * already peered with a shared VPC network using CreateConnection method. + * Must be in a form 'projects/{project}/global/networks/{network}'. + * {project} is a project number, as in '12345' {network} is network + * name. + */ + network?: string; + } + /** + * `Service` is the root object of Google service configuration schema. It + * describes basic information about a service, such as the name and the + * title, and delegates other aspects to sub-sections. Each sub-section is + * either a proto message or a repeated proto message that configures a + * specific aspect, such as auth. See each proto message definition for + * details. Example: type: google.api.Service config_version: 3 + * name: calendar.googleapis.com title: Google Calendar API apis: - + * name: google.calendar.v3.Calendar authentication: providers: - + * id: google_calendar_auth jwks_uri: + * https://www.googleapis.com/oauth2/v1/certs issuer: + * https://securetoken.google.com rules: - selector: "*" + * requirements: provider_id: google_calendar_auth + */ + export interface Schema$Service { + /** + * A list of API interfaces exported by this service. Only the `name` field + * of the google.protobuf.Api needs to be provided by the configuration + * author, as the remaining fields will be derived from the IDL during the + * normalization process. It is an error to specify an API interface here + * which cannot be resolved against the associated IDL files. + */ + apis?: Schema$Api[]; + /** + * Auth configuration. + */ + authentication?: Schema$Authentication; + /** + * API backend configuration. + */ + backend?: Schema$Backend; + /** + * Billing configuration. + */ + billing?: Schema$Billing; + /** + * The semantic version of the service configuration. The config version + * affects the interpretation of the service configuration. For example, + * certain features are enabled by default for certain config versions. The + * latest config version is `3`. + */ + configVersion?: number; + /** + * Context configuration. + */ + context?: Schema$Context; + /** + * Configuration for the service control plane. + */ + control?: Schema$Control; + /** + * Custom error configuration. + */ + customError?: Schema$CustomError; + /** + * Additional API documentation. + */ + documentation?: Schema$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. + */ + endpoints?: Schema$Endpoint[]; + /** + * 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 + */ + enums?: Schema$Enum[]; + /** + * Experimental configuration. + */ + experimental?: Schema$Experimental; + /** + * HTTP configuration. + */ + http?: Schema$Http; + /** + * 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. Must be no longer than 60 characters. + */ + id?: string; + /** + * Logging configuration. + */ + logging?: Schema$Logging; + /** + * Defines the logs used by this service. + */ + logs?: Schema$LogDescriptor[]; + /** + * Defines the metrics used by this service. + */ + metrics?: Schema$MetricDescriptor[]; + /** + * Defines the monitored resources used by this service. This is required by + * the Service.monitoring and Service.logging configurations. + */ + monitoredResources?: Schema$MonitoredResourceDescriptor[]; + /** + * Monitoring configuration. + */ + monitoring?: Schema$Monitoring; + /** + * The service name, which is a DNS-like logical identifier for the service, + * such as `calendar.googleapis.com`. The service name typically goes + * through DNS verification to make sure the owner of the service also owns + * the DNS name. + */ + name?: string; + /** + * The Google project that owns this service. + */ + producerProjectId?: string; + /** + * Quota configuration. + */ + quota?: Schema$Quota; + /** + * Output only. The source information for this configuration if available. + */ + sourceInfo?: Schema$SourceInfo; + /** + * System parameter configuration. + */ + systemParameters?: Schema$SystemParameters; + /** + * A list of all proto message types included in this API service. It serves + * similar purpose as [google.api.Service.types], except that these types + * are not needed by user-defined APIs. Therefore, they will not show up in + * the generated discovery doc. This field should only be used to define + * system APIs in ESF. + */ + systemTypes?: Schema$Type[]; + /** + * The product title for this service. + */ + title?: string; + /** + * A list of all proto message types included in this API service. Types + * referenced directly or indirectly by the `apis` are automatically + * included. Messages which are not referenced but shall be included, such + * as types used by the `google.protobuf.Any` type, should be listed here by + * name. Example: types: - name: google.protobuf.Int32 + */ + types?: Schema$Type[]; + /** + * Configuration controlling usage of this service. + */ + usage?: Schema$Usage; + } + /** + * `SourceContext` represents information about the source of a protobuf + * element, like the file in which it is defined. + */ + export interface Schema$SourceContext { + /** + * The path-qualified name of the .proto file that contained the associated + * protobuf element. For example: + * `"google/protobuf/source_context.proto"`. + */ + fileName?: string; + } + /** + * Source information used to create a Service Config + */ + export interface Schema$SourceInfo { + /** + * All files used during config generation. + */ + sourceFiles?: Array<{[key: string]: any;}>; + } + /** + * 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. + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number; + /** + * A list of messages that carry the error details. There is a common set + * of message types for APIs to use. + */ + details?: Array<{[key: string]: any;}>; + /** + * 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. + */ + message?: string; + } + /** + * Represents a subnet that was created or discovered by a private access + * management service. + */ + export interface Schema$Subnetwork { + /** + * Subnetwork CIDR range in `10.x.x.x/y` format. + */ + ipCidrRange?: string; + /** + * Subnetwork name. See https://cloud.google.com/compute/docs/vpc/ + */ + name?: string; + /** + * In the Shared VPC host project, the VPC network that's peered with + * the consumer network. For example: + * `projects/1234321/global/networks/host-network` + */ + network?: string; + /** + * This is a discovered subnet that is not within the current consumer + * allocated ranges. + */ + outsideAllocation?: boolean; + } + /** + * Define a parameter's name and location. The parameter may be passed as + * either an HTTP header or a URL query parameter, and if both are passed the + * behavior is implementation-dependent. + */ + export interface Schema$SystemParameter { + /** + * Define the HTTP header name to use for the parameter. It is case + * insensitive. + */ + httpHeader?: string; + /** + * Define the name of the parameter, such as "api_key" . It is + * case sensitive. + */ + name?: string; + /** + * Define the URL query parameter name to use for the parameter. It is case + * sensitive. + */ + urlQueryParameter?: string; + } + /** + * Define a system parameter rule mapping system parameter definitions to + * methods. + */ + export interface Schema$SystemParameterRule { + /** + * Define parameters. Multiple names may be defined for a parameter. For a + * given method call, only one of them should be used. If multiple names are + * used the behavior is implementation-dependent. If none of the specified + * names are present the behavior is parameter-dependent. + */ + parameters?: Schema$SystemParameter[]; + /** + * Selects the methods to which this rule applies. Use '*' to + * indicate all methods in all APIs. Refer to selector for syntax details. + */ + selector?: string; + } + /** + * ### System parameter configuration A system parameter is a special kind of + * parameter defined by the API system, not by an individual API. It is + * typically mapped to an HTTP header and/or a URL query parameter. This + * configuration specifies which methods change the names of the system + * parameters. + */ + export interface Schema$SystemParameters { + /** + * Define system parameters. The parameters defined here will override the + * default parameters implemented by the system. If this field is missing + * from the service config, default system parameters will be used. Default + * system parameters and names is implementation-dependent. Example: define + * api key for all methods system_parameters rules: - + * selector: "*" parameters: - name: api_key + * url_query_parameter: api_key Example: define 2 api key names for a + * specific method. system_parameters rules: - selector: + * "/ListShelves" parameters: - name: + * api_key http_header: Api-Key1 - name: api_key + * http_header: Api-Key2 **NOTE:** All service configuration rules follow + * "last one wins" order. + */ + rules?: Schema$SystemParameterRule[]; + } + /** + * A protocol buffer message type. + */ + export interface Schema$Type { + /** + * The list of fields. + */ + fields?: Schema$Field[]; + /** + * The fully qualified message name. + */ + name?: string; + /** + * The list of types appearing in `oneof` definitions in this type. + */ + oneofs?: string[]; + /** + * The protocol buffer options. + */ + options?: Schema$Option[]; + /** + * The source context. + */ + sourceContext?: Schema$SourceContext; + /** + * The source syntax. + */ + syntax?: string; + } + /** + * Configuration controlling usage of a service. + */ + export interface Schema$Usage { + /** + * The full resource name of a channel used for sending notifications to the + * service producer. Google Service Management currently only supports + * [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification + * channel. To use Google Cloud Pub/Sub as the channel, this must be the + * name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name + * format documented in https://cloud.google.com/pubsub/docs/overview. + */ + producerNotificationChannel?: string; + /** + * Requirements that must be satisfied before a consumer project can use the + * service. Each requirement is of the form + * <service.name>/<requirement-id>; for example + * 'serviceusage.googleapis.com/billing-enabled'. + */ + requirements?: string[]; + /** + * A list of usage rules that apply to individual API methods. **NOTE:** + * All service configuration rules follow "last one wins" order. + */ + rules?: Schema$UsageRule[]; + } + /** + * Usage configuration rules for the service. NOTE: Under development. Use + * this rule to configure unregistered calls for the service. Unregistered + * calls are calls that do not contain consumer project identity. (Example: + * calls that do not contain an API key). By default, API methods do not allow + * unregistered calls, and each method call must be identified by a consumer + * project identity. Use this rule to allow/disallow unregistered calls. + * Example of an API that wants to allow unregistered calls for entire + * service. usage: rules: - selector: "*" + * allow_unregistered_calls: true Example of a method that wants to allow + * unregistered calls. usage: rules: - selector: + * "google.example.library.v1.LibraryService.CreateBook" + * allow_unregistered_calls: true + */ + export interface Schema$UsageRule { + /** + * If true, the selected method allows unregistered calls, e.g. calls that + * don't identify any user or application. + */ + allowUnregisteredCalls?: boolean; + /** + * Selects the methods to which this rule applies. Use '*' to + * indicate all methods in all APIs. Refer to selector for syntax details. + */ + selector?: string; + /** + * If true, the selected method should skip service control and the control + * plane features, such as quota and billing, will not be available. This + * flag is used by Google Cloud Endpoints to bypass checks for internal + * methods, such as service health check methods. + */ + skipServiceControl?: boolean; + } + + + export class Resource$Operations { + constructor() {} + + + /** + * servicenetworking.operations.cancel + * @desc 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`. + * @alias servicenetworking.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {().CancelOperationRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel(params?: Params$Resource$Operations$Cancel, options?: MethodOptions): + GaxiosPromise; + cancel( + params: Params$Resource$Operations$Cancel, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + cancel( + params: Params$Resource$Operations$Cancel, + callback: BodyResponseCallback): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: Params$Resource$Operations$Cancel| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * servicenetworking.operations.delete + * @desc 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`. + * @alias servicenetworking.operations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be deleted. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete(params?: Params$Resource$Operations$Delete, options?: MethodOptions): + GaxiosPromise; + delete( + params: Params$Resource$Operations$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Operations$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Operations$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * servicenetworking.operations.get + * @desc 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. + * @alias servicenetworking.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Operations$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Operations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Operations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Operations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * servicenetworking.operations.list + * @desc 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/x/operations`. To + * override the binding, API services can add a binding such as + * `"/v1/{name=users/x}/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. + * @alias servicenetworking.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Operations$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Operations$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Operations$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Operations$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operations$Cancel extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Operations$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Operations$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Operations$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + + export class Resource$Services { + connections: Resource$Services$Connections; + constructor() { + this.connections = new Resource$Services$Connections(); + } + + + /** + * servicenetworking.services.addSubnetwork + * @desc For service producers, provisions a new subnet in a peered + * service's shared VPC network in the requested region and with the + * requested size that's expressed as a CIDR range (number of leading bits + * of ipV4 network mask). The method checks against the assigned allocated + * ranges to find a non-conflicting IP address range. The method will reuse + * a subnet if subsequent calls contain the same subnet name, region, and + * prefix length. This method will make producer's tenant project to be a + * shared VPC service project as needed. The response from the `get` + * operation will be of type `Subnetwork` if the operation successfully + * completes. + * @alias servicenetworking.services.addSubnetwork + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. A tenant project in the service producer organization, in the following format: services/{service}/{collection-id}/{resource-id}. {collection-id} is the cloud resource collection type that represents the tenant project. Only `projects` are supported. {resource-id} is the tenant project numeric id, such as `123456`. {service} the name of the peering service, such as `service-peering.example.com`. This service must already be enabled in the service consumer's project. + * @param {().AddSubnetworkRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + addSubnetwork( + params?: Params$Resource$Services$Addsubnetwork, + options?: MethodOptions): GaxiosPromise; + addSubnetwork( + params: Params$Resource$Services$Addsubnetwork, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + addSubnetwork( + params: Params$Resource$Services$Addsubnetwork, + callback: BodyResponseCallback): void; + addSubnetwork(callback: BodyResponseCallback): void; + addSubnetwork( + paramsOrCallback?: Params$Resource$Services$Addsubnetwork| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Services$Addsubnetwork; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Addsubnetwork; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:addSubnetwork') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * servicenetworking.services.searchRange + * @desc Service producers can use this method to find a currently unused + * range within consumer allocated ranges. This returned range is not + * reserved, and not guaranteed to remain unused. It will validate + * previously provided allocated ranges, find non-conflicting sub-range of + * requested size (expressed in number of leading bits of ipv4 network mask, + * as in CIDR range notation). Operation + * @alias servicenetworking.services.searchRange + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. This is in a form services/{service}. {service} the name of the private access management service, for example 'service-peering.example.com'. + * @param {().SearchRangeRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + searchRange( + params?: Params$Resource$Services$Searchrange, + options?: MethodOptions): GaxiosPromise; + searchRange( + params: Params$Resource$Services$Searchrange, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + searchRange( + params: Params$Resource$Services$Searchrange, + callback: BodyResponseCallback): void; + searchRange(callback: BodyResponseCallback): void; + searchRange( + paramsOrCallback?: Params$Resource$Services$Searchrange| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Services$Searchrange; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Searchrange; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:searchRange') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Services$Addsubnetwork extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. A tenant project in the service producer organization, in the + * following format: services/{service}/{collection-id}/{resource-id}. + * {collection-id} is the cloud resource collection type that represents the + * tenant project. Only `projects` are supported. {resource-id} is the + * tenant project numeric id, such as `123456`. {service} the name of the + * peering service, such as `service-peering.example.com`. This service must + * already be enabled in the service consumer's project. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddSubnetworkRequest; + } + export interface Params$Resource$Services$Searchrange extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. This is in a form services/{service}. {service} the name of the + * private access management service, for example + * 'service-peering.example.com'. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchRangeRequest; + } + + export class Resource$Services$Connections { + constructor() {} + + + /** + * servicenetworking.services.connections.create + * @desc Creates a private connection that establishes a VPC Network Peering + * connection to a VPC network in the service producer's organization. The + * administrator of the service consumer's VPC network invokes this method. + * The administrator must assign one or more allocated IP ranges for + * provisioning subnetworks in the service producer's VPC network. This + * connection is used for all supported services in the service producer's + * organization, so it only needs to be invoked once. The response from the + * `get` operation will be of type `Connection` if the operation + * successfully completes. + * @alias servicenetworking.services.connections.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. + * @param {().Connection} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Services$Connections$Create, + options?: MethodOptions): GaxiosPromise; + create( + params: Params$Resource$Services$Connections$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Services$Connections$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Services$Connections$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Services$Connections$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Connections$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/connections') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * servicenetworking.services.connections.list + * @desc List the private connections that are configured in a service + * consumer's VPC network. + * @alias servicenetworking.services.connections.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.network The name of service consumer's VPC network that's connected with service producer network through a private connection. The network name must be in the following format: `projects/{project}/global/networks/{network}`. {project} is a project number, such as in `12345` that includes the VPC service consumer's VPC network. {network} is the name of the service consumer's VPC network. + * @param {string} params.parent The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. If you specify `services/-` as the parameter value, all configured peering services are listed. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Services$Connections$List, + options?: MethodOptions): GaxiosPromise; + list( + params: Params$Resource$Services$Connections$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Services$Connections$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Services$Connections$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Services$Connections$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Connections$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/connections') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * servicenetworking.services.connections.patch + * @desc Updates the allocated ranges that are assigned to a connection. The + * response from the `get` operation will be of type `Connection` if the + * operation successfully completes. + * @alias servicenetworking.services.connections.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.force If a previously defined allocated range is removed, force flag must be set to true. + * @param {string} params.name The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of `services/{peering_service_name}/connections/{vpc_peering_name}`. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`. + * @param {string=} params.updateMask The update mask. If this is omitted, it defaults to "*". You can only update the listed peering ranges. + * @param {().Connection} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Services$Connections$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Services$Connections$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Services$Connections$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Services$Connections$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Services$Connections$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Connections$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Services$Connections$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The service that is managing peering connectivity for a service + * producer's organization. For Google services that support this + * functionality, this value is `services/servicenetworking.googleapis.com`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Connection; + } + export interface Params$Resource$Services$Connections$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of service consumer's VPC network that's connected with service + * producer network through a private connection. The network name must be + * in the following format: `projects/{project}/global/networks/{network}`. + * {project} is a project number, such as in `12345` that includes the VPC + * service consumer's VPC network. {network} is the name of the service + * consumer's VPC network. + */ + network?: string; + /** + * The service that is managing peering connectivity for a service + * producer's organization. For Google services that support this + * functionality, this value is `services/servicenetworking.googleapis.com`. + * If you specify `services/-` as the parameter value, all configured + * peering services are listed. + */ + parent?: string; + } + export interface Params$Resource$Services$Connections$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If a previously defined allocated range is removed, force flag must be + * set to true. + */ + force?: boolean; + /** + * The private service connection that connects to a service producer + * organization. The name includes both the private service name and the VPC + * network peering name in the format of + * `services/{peering_service_name}/connections/{vpc_peering_name}`. For + * Google services that support this functionality, this is + * `services/servicenetworking.googleapis.com/connections/servicenetworking-googleapis-com`. + */ + name?: string; + /** + * The update mask. If this is omitted, it defaults to "*". You can only + * update the listed peering ranges. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Connection; + } +} diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index b38e4af71a9..768648debab 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -595,6 +595,10 @@ export namespace vault_v1 { * The export file format. */ exportFormat?: string; + /** + * Set to true to export confidential mode content. + */ + showConfidentialModeContent?: boolean; } /** * Mail search advanced options diff --git a/src/index.ts b/src/index.ts index 09c006e8d19..b0ccdcebfcc 100644 --- a/src/index.ts +++ b/src/index.ts @@ -206,6 +206,7 @@ export {servicebroker_v1beta1} from './apis/servicebroker/v1beta1'; export {serviceconsumermanagement_v1} from './apis/serviceconsumermanagement/v1'; export {servicecontrol_v1} from './apis/servicecontrol/v1'; export {servicemanagement_v1} from './apis/servicemanagement/v1'; +export {servicenetworking_v1} from './apis/servicenetworking/v1'; export {servicenetworking_v1beta} from './apis/servicenetworking/v1beta'; export {serviceusage_v1} from './apis/serviceusage/v1'; export {serviceusage_v1beta1} from './apis/serviceusage/v1beta1';