diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index eab470224a..328767ec1e 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -1041,409 +1041,6 @@ } } }, - "companies": { - "methods": { - "create": { - "description": "Creates an app for a company. Note that you must first create a profile\nfor the company in your organization before you can register apps that\nare associated with the company.", - "flatPath": "v1/organizations/{organizationsId}/companies", - "httpMethod": "POST", - "id": "apigee.organizations.companies.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Name of org that the company will be created in\n`{parent=organizations/*}`", - "location": "path", - "pattern": "^organizations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/companies", - "request": { - "$ref": "GoogleCloudApigeeV1Company" - }, - "response": { - "$ref": "GoogleCloudApigeeV1Company" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an existing company.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}", - "httpMethod": "DELETE", - "id": "apigee.organizations.companies.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The company resource name\n`organizations/{org}/companies/{company}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudApigeeV1Company" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "List details for a company.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}", - "httpMethod": "GET", - "id": "apigee.organizations.companies.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The company resource name\n`organizations/{org}/companies/{company}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudApigeeV1Company" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "List all companies in an organization, and optionally returns an\nexpanded list of companies, displaying a full profile for each company in\nthe organization.", - "flatPath": "v1/organizations/{organizationsId}/companies", - "httpMethod": "GET", - "id": "apigee.organizations.companies.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "count": { - "description": "Limits the list to the number you specify. The limit is 100.", - "format": "int64", - "location": "query", - "type": "string" - }, - "expand": { - "description": "Set expand to true to return a full profile for each company.", - "location": "query", - "type": "boolean" - }, - "includeDevelopers": { - "description": "Optional. include developers in the response.", - "location": "query", - "type": "boolean" - }, - "parent": { - "description": "The parent organization name\n`organizations/{org}`", - "location": "path", - "pattern": "^organizations/[^/]+$", - "required": true, - "type": "string" - }, - "startKey": { - "description": "To filter the keys that are returned, enter the email of a developer\nthat the list will start with.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/companies", - "response": { - "$ref": "GoogleCloudApigeeV1ListCompaniesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "update": { - "description": "Updates an existing company.\nSend the complete company record as a payload with any changes you want to\nmake. Note that to change the status of the Company you use Set the Status\nof a Company. The attributes in the sample payload below apply to company\nconfiguration in monetization. For non-monetized companies, you need send\nonly displayName.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}", - "httpMethod": "PUT", - "id": "apigee.organizations.companies.update", - "parameterOrder": [ - "name" - ], - "parameters": { - "action": { - "description": "Specify the status as active or inactive.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Name of the company to be updated.\n`{name=organizations/*/companies/*}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudApigeeV1Company" - }, - "response": { - "$ref": "GoogleCloudApigeeV1Company" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "apps": { - "methods": { - "create": { - "description": "Creates an app for a company.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps", - "httpMethod": "POST", - "id": "apigee.organizations.companies.apps.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Resource path of the parent: `organizations/{org}/companies/{company_name}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/apps", - "request": { - "$ref": "GoogleCloudApigeeV1CompanyApp" - }, - "response": { - "$ref": "GoogleCloudApigeeV1CompanyApp" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a company app.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}", - "httpMethod": "DELETE", - "id": "apigee.organizations.companies.apps.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "name of the app resource:\n`organizations/{org}/companies/{company_name}/apps/{app_name}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudApigeeV1CompanyApp" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the profile of a specific company app.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}", - "httpMethod": "GET", - "id": "apigee.organizations.companies.apps.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "name of the app resource:\n`organizations/{org}/companies/{company_name}/apps/{app_name}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudApigeeV1CompanyApp" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "List company apps in an organization. You can optionally expand the\nresponse to include the profile for each app.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps", - "httpMethod": "GET", - "id": "apigee.organizations.companies.apps.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "count": { - "description": "Limits the list to the number you specify. The limit is 100.", - "format": "int64", - "location": "query", - "type": "string" - }, - "expand": { - "description": "Set expand to true to return a full profile", - "location": "query", - "type": "boolean" - }, - "parent": { - "description": "The name of a company resource:\n`organizations/{org}/companies/{company_name}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+$", - "required": true, - "type": "string" - }, - "startKey": { - "description": "Lets you return a list of app starting with a specific app name in the\nlist.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/apps", - "response": { - "$ref": "GoogleCloudApigeeV1ListCompanyAppsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "update": { - "description": "Updates an existing company app.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}", - "httpMethod": "PUT", - "id": "apigee.organizations.companies.apps.update", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource path of the app:\n`organizations/{org}/companies/{company_name}/apps/{app_name}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudApigeeV1CompanyApp" - }, - "response": { - "$ref": "GoogleCloudApigeeV1CompanyApp" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "keys": { - "methods": { - "delete": { - "description": "Deletes a key for a company app and removes all API products associated\nwith the app. The key can no longer be used to access any APIs.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}/keys/{keysId}", - "httpMethod": "DELETE", - "id": "apigee.organizations.companies.apps.keys.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name of a company app key\n`organizations/{org}/companies/{company}/apps/{app}/keys/{key}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+/keys/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudApigeeV1CompanyAppKey" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets information about the consumer key issued to a specific company app.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}/keys/{keysId}", - "httpMethod": "GET", - "id": "apigee.organizations.companies.apps.keys.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name of a company app key\n`organizations/{org}/companies/{company}/apps/{app}/keys/{key}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+/keys/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudApigeeV1CompanyAppKey" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "updateCompanyAppKey": { - "description": "Updates an existing company app key to add additional API products or\nattributes. Note that only a single API product can be resolved per app\nkey at runtime. API products are resolved by name, in alphabetical order.\nThe first API product found in the list will be returned.", - "flatPath": "v1/organizations/{organizationsId}/companies/{companiesId}/apps/{appsId}/keys/{keysId}", - "httpMethod": "POST", - "id": "apigee.organizations.companies.apps.keys.updateCompanyAppKey", - "parameterOrder": [ - "name" - ], - "parameters": { - "action": { - "description": "Set action to approve or revoke.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Resource name of a company app key\n`organizations/{org}/companies/{company}/apps/{app}/keys/{key}`", - "location": "path", - "pattern": "^organizations/[^/]+/companies/[^/]+/apps/[^/]+/keys/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudApigeeV1CompanyAppKey" - }, - "response": { - "$ref": "GoogleCloudApigeeV1CompanyAppKey" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - }, "deployments": { "methods": { "list": { @@ -2468,51 +2065,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getDatalocation": { - "description": "Get Google Cloud Storage (GCS) signed url for specific organization and\nenvironment. Collection agent uses this signed url to upload data\nto GCS bucket.", - "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/datalocation", - "httpMethod": "GET", - "id": "apigee.organizations.environments.getDatalocation", - "parameterOrder": [ - "name" - ], - "parameters": { - "contentType": { - "description": "Content-Type for uploaded file.", - "location": "query", - "type": "string" - }, - "dataset": { - "description": "Required. Dataset could be one of `api`, `mint`, `trace` and `event`", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The parent organization and environment names. Must be of the\nform `organizations/{org}/environments/{env}/datalocation`.", - "location": "path", - "pattern": "^organizations/[^/]+/environments/[^/]+/datalocation$", - "required": true, - "type": "string" - }, - "relativeFilePath": { - "description": "Required. Relative path to the GCS bucket", - "location": "query", - "type": "string" - }, - "repo": { - "description": "Required. Repository name", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudApigeeV1DataLocation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "getDebugmask": { "description": "Gets the debug mask singleton resource for an environment.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/debugmask", @@ -2573,7 +2125,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -2984,6 +2536,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "get": { + "description": "Retrieves a debug session.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions/{debugsessionsId}", + "httpMethod": "GET", + "id": "apigee.organizations.environments.apis.revisions.debugsessions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the debug session to retrieve.\nMust be of the form:\n `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/apis/[^/]+/revisions/[^/]+/debugsessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1DebugSession" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists debug sessions that are currently active in the given API Proxy\nrevision.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apis/{apisId}/revisions/{revisionsId}/debugsessions", @@ -3716,31 +3293,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getResultView": { - "description": "", - "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries/{queriesId}/resultView", - "httpMethod": "GET", - "id": "apigee.organizations.environments.queries.getResultView", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the asynchronous query result view to get. Must be of the\nform `organizations/{org}/environments/{env}/queries/{queryId}/resultView`.", - "location": "path", - "pattern": "^organizations/[^/]+/environments/[^/]+/queries/[^/]+/resultView$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudApigeeV1AsyncQueryResultView" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Return a list of Asynchronous Queries", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/queries", @@ -4991,7 +4543,7 @@ } } }, - "revision": "20200502", + "revision": "20200507", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5525,36 +5077,6 @@ }, "type": "object" }, - "GoogleCloudApigeeV1AsyncQueryResultView": { - "id": "GoogleCloudApigeeV1AsyncQueryResultView", - "properties": { - "code": { - "description": "Error code when there is a failure.", - "format": "int32", - "type": "integer" - }, - "error": { - "description": "Error message when there is a failure.", - "type": "string" - }, - "metadata": { - "$ref": "GoogleCloudApigeeV1QueryMetadata", - "description": "Metadata contains information like metrics, dimenstions etc\nof the AsyncQuery" - }, - "rows": { - "description": "Rows of query result. Each row is a JSON object.\n\nExample: {sum(message_count): 1, developer_app: \"(not set)\",…}", - "items": { - "type": "any" - }, - "type": "array" - }, - "state": { - "description": "State of retrieving ResultView.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudApigeeV1Attribute": { "description": "Key-value pair to store extra metadata.", "id": "GoogleCloudApigeeV1Attribute", @@ -5665,172 +5187,6 @@ }, "type": "object" }, - "GoogleCloudApigeeV1Company": { - "id": "GoogleCloudApigeeV1Company", - "properties": { - "apps": { - "items": { - "type": "string" - }, - "type": "array" - }, - "attributes": { - "description": "A list of attributes", - "items": { - "$ref": "GoogleCloudApigeeV1Attribute" - }, - "type": "array" - }, - "createdAt": { - "description": "Output only. Created time as milliseconds since epoch.\njson key: createdAt", - "format": "int64", - "type": "string" - }, - "displayName": { - "description": "company name displayed in the UI", - "type": "string" - }, - "lastModifiedAt": { - "description": "Output only. Modified time as milliseconds since epoch.\njson key: lastModifiedAt", - "format": "int64", - "type": "string" - }, - "name": { - "description": "Name of the company. Characters you can use in the name are restricted to:\nA-Z0-9._\\-$ %.", - "type": "string" - }, - "organization": { - "description": "the org that the company is created", - "type": "string" - }, - "status": { - "description": "The status of the company", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudApigeeV1CompanyApp": { - "id": "GoogleCloudApigeeV1CompanyApp", - "properties": { - "apiProducts": { - "description": "Any API Products the app consumes", - "items": { - "type": "string" - }, - "type": "array" - }, - "appFamily": { - "type": "string" - }, - "appId": { - "description": "The id of the app.", - "type": "string" - }, - "attributes": { - "description": "A list of attributes.", - "items": { - "$ref": "GoogleCloudApigeeV1Attribute" - }, - "type": "array" - }, - "callbackUrl": { - "description": "The callbackUrl is used by OAuth 2.0 authorization servers to communicate\nauthorization codes back to apps.", - "type": "string" - }, - "companyName": { - "description": "The name of the company owns the app", - "type": "string" - }, - "createdAt": { - "description": "Output only. created time of this environment as milliseconds since epoch.\nJSON key: createdAt", - "format": "int64", - "type": "string" - }, - "credentials": { - "description": "Output only. A set of credentials for the app\ncredentials are key/secret pairs", - "items": { - "$ref": "GoogleCloudApigeeV1Credential" - }, - "type": "array" - }, - "keyExpiresIn": { - "description": "A setting, in milliseconds, for the lifetime of the consumer key that will\nbe generated for the developer app. The default value, -1, indicates an\ninfinite validity period. Once set, the expiration can't be updated.\njson key: keyExpiresIn", - "format": "int64", - "type": "string" - }, - "lastModifiedAt": { - "description": "Output only. Modified time as milliseconds since epoch.\njson key: lastModifiedAt", - "format": "int64", - "type": "string" - }, - "name": { - "description": "The resoure id of the app.\nJSON key: name", - "type": "string" - }, - "scopes": { - "description": "The scopes to apply to the app. The specified scope names must already\nexist on the API product that you associate with the app.", - "items": { - "type": "string" - }, - "type": "array" - }, - "status": { - "description": "The status of the credential.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudApigeeV1CompanyAppKey": { - "id": "GoogleCloudApigeeV1CompanyAppKey", - "properties": { - "apiProducts": { - "description": "A list of api products this credential can be used for.", - "items": { - "type": "any" - }, - "type": "array" - }, - "attributes": { - "description": "A list of attributes tied to the credential.", - "items": { - "$ref": "GoogleCloudApigeeV1Attribute" - }, - "type": "array" - }, - "consumerKey": { - "description": "The consumer key.", - "type": "string" - }, - "consumerSecret": { - "description": "The secret key.", - "type": "string" - }, - "expiresAt": { - "description": "Unix time when the app was created\njson key: expiresAt", - "format": "int64", - "type": "string" - }, - "issuedAt": { - "description": "Unix time when the app was issued\njson key: issuedAt", - "format": "int64", - "type": "string" - }, - "scopes": { - "description": "The scopes to apply to the app. The specified scope names must already\nexist on the API product that you associate with the app.", - "items": { - "type": "string" - }, - "type": "array" - }, - "status": { - "description": "The status of the credential.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudApigeeV1ConfigVersion": { "description": "Version of the API proxy configuration schema. Currently, only 4.0 is\nsupported.", "id": "GoogleCloudApigeeV1ConfigVersion", @@ -6027,16 +5383,6 @@ }, "type": "object" }, - "GoogleCloudApigeeV1DataLocation": { - "id": "GoogleCloudApigeeV1DataLocation", - "properties": { - "url": { - "description": "GCS signed url. Signed URLs provide a way to give time-limited\nread or write access to anyone in possession of the URL, regardless of\nwhether they have a Google account.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudApigeeV1DebugMask": { "id": "GoogleCloudApigeeV1DebugMask", "properties": { @@ -6732,32 +6078,6 @@ }, "type": "object" }, - "GoogleCloudApigeeV1ListCompaniesResponse": { - "id": "GoogleCloudApigeeV1ListCompaniesResponse", - "properties": { - "company": { - "description": "A list of company.", - "items": { - "$ref": "GoogleCloudApigeeV1Company" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudApigeeV1ListCompanyAppsResponse": { - "id": "GoogleCloudApigeeV1ListCompanyAppsResponse", - "properties": { - "app": { - "description": "A list of apps for a company.", - "items": { - "$ref": "GoogleCloudApigeeV1CompanyApp" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudApigeeV1ListCustomReportsResponse": { "description": "This message encapsulates a list of custom report definitions", "id": "GoogleCloudApigeeV1ListCustomReportsResponse", @@ -7045,7 +6365,7 @@ "type": "string" }, "name": { - "description": "Required. Name of the Apigee organization.", + "description": "Output only. Name of the Apigee organization.", "type": "string" }, "properties": { @@ -7958,7 +7278,7 @@ "properties": { "condition": { "$ref": "GoogleTypeExpr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -7975,7 +7295,7 @@ "type": "object" }, "GoogleIamV1Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "GoogleIamV1Policy", "properties": { "auditConfigs": { @@ -7998,7 +7318,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index adf5ac93dc..41225c089a 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -211,7 +211,7 @@ ] }, "searchAssignments": { - "description": "Looks up assignments for a specified resource for a particular region.\nIf the request is about a project:\n 1) Assignments created on the project will be returned if they exist.\n 2) Otherwise assignments created on the closest ancestor will be\n returned. 3) Assignments for different JobTypes will all be returned.\nSame logic applies if the request is about a folder.\nIf the request is about an organization, then assignments created on the\norganization will be returned (organization doesn't have ancestors).\nComparing to ListAssignments, there are some behavior\ndifferences:\n 1) permission on the assignee will be verified in this API.\n 2) Hierarchy lookup (project->folder->organization) happens in this API.\n 3) Parent here is projects/*/locations/*, instead of\n projects/*/locations/*reservations/*.\nNote \"-\" cannot be used for projects\nnor locations.", + "description": "Looks up assignments for a specified resource for a particular region.\nIf the request is about a project:\n\n1. Assignments created on the project will be returned if they exist.\n2. Otherwise assignments created on the closest ancestor will be\n returned.\n3. Assignments for different JobTypes will all be returned.\n\nThe same logic applies if the request is about a folder.\n\nIf the request is about an organization, then assignments created on the\norganization will be returned (organization doesn't have ancestors).\n\nComparing to ListAssignments, there are some behavior\ndifferences:\n\n1. permission on the assignee will be verified in this API.\n2. Hierarchy lookup (project->folder->organization) happens in this API.\n3. Parent here is `projects/*/locations/*`, instead of\n `projects/*/locations/*reservations/*`.\n\n**Note** \"-\" cannot be used for projects\nnor locations.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchAssignments", "httpMethod": "GET", "id": "bigqueryreservation.projects.locations.searchAssignments", @@ -220,7 +220,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of items to return.", + "description": "The maximum number of items to return per page.", "format": "int32", "location": "query", "type": "integer" @@ -238,7 +238,7 @@ "type": "string" }, "query": { - "description": "Please specify resource name as assignee in the query.\ne.g., \"assignee=projects/myproject\"\n \"assignee=folders/123\"\n \"assignee=organizations/456\"", + "description": "Please specify resource name as assignee in the query.\n\nExamples:\n\n* `assignee=projects/myproject`\n* `assignee=folders/123`\n* `assignee=organizations/456`", "location": "query", "type": "string" } @@ -253,7 +253,7 @@ ] }, "updateBiReservation": { - "description": "Updates a BI reservation.\nOnly fields specified in the field_mask are updated.\nSingleton BI reservation always exists with default size 0.\nIn order to reserve BI capacity it needs to be updated to an amount\ngreater than 0. In order to release BI capacity reservation size\nmust be set to 0.", + "description": "Updates a BI reservation.\n\nOnly fields specified in the `field_mask` are updated.\n\nA singleton BI reservation always exists with default size 0.\nIn order to reserve BI capacity it needs to be updated to an amount\ngreater than 0. In order to release BI capacity reservation size\nmust be set to 0.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/biReservation", "httpMethod": "PATCH", "id": "bigqueryreservation.projects.locations.updateBiReservation", @@ -415,7 +415,7 @@ ] }, "merge": { - "description": "Merges capacity commitments of the same plan into one. Resulting capacity\ncommitment has the longer commitment_end_time out of the two. Attempting to\nmerge capacity commitments of different plan will fail with the error code\n`google.rpc.Code.FAILED_PRECONDITION`.", + "description": "Merges capacity commitments of the same plan into a single commitment.\n\nThe resulting capacity commitment has the greater commitment_end_time\nout of the to-be-merged capacity commitments.\n\nAttempting to merge capacity commitments of different plan will fail\nwith the error code `google.rpc.Code.FAILED_PRECONDITION`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments:merge", "httpMethod": "POST", "id": "bigqueryreservation.projects.locations.capacityCommitments.merge", @@ -444,7 +444,7 @@ ] }, "patch": { - "description": "Updates an existing capacity commitment.\n\nOnly plan and renewal_plan fields can be updated.\nPlan can only be changed to a plan of a longer commitment period.\nAttempting to change to a plan with shorter commitment period will fail\nwith the error code `google.rpc.Code.FAILED_PRECONDITION`.", + "description": "Updates an existing capacity commitment.\n\nOnly `plan` and `renewal_plan` fields can be updated.\n\nPlan can only be changed to a plan of a longer commitment period.\nAttempting to change to a plan with shorter commitment period will fail\nwith the error code `google.rpc.Code.FAILED_PRECONDITION`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments/{capacityCommitmentsId}", "httpMethod": "PATCH", "id": "bigqueryreservation.projects.locations.capacityCommitments.patch", @@ -453,7 +453,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the capacity commitment, e.g.,\n projects/myproject/locations/US/capacityCommitments/123", + "description": "Output only. The resource name of the capacity commitment, e.g.,\n`projects/myproject/locations/US/capacityCommitments/123`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$", "required": true, @@ -479,7 +479,7 @@ ] }, "split": { - "description": "Splits capacity commitment to two commitments of the same plan and\ncommitment_end_time. A common use case to do that is to perform a downgrade\ne.g., in order to downgrade from 10000 slots to 8000, one might split 10000\ncapacity commitment to 2000 and 8000, change the plan of the first one to\nflex and then delete it.", + "description": "Splits capacity commitment to two commitments of the same plan and\n`commitment_end_time`.\n\nA common use case is to enable downgrading commitments.\n\nFor example, in order to downgrade from 10000 slots to 8000, you might\nsplit a 10000 capacity commitment into commitments of 2000 and 8000. Then,\nyou would change the plan of the first one to `FLEX` and then delete it.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments/{capacityCommitmentsId}:split", "httpMethod": "POST", "id": "bigqueryreservation.projects.locations.capacityCommitments.split", @@ -521,7 +521,7 @@ ], "parameters": { "parent": { - "description": "Required. Project, location. E.g.,\n projects/myproject/locations/US", + "description": "Required. Project, location. E.g.,\n`projects/myproject/locations/US`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -555,7 +555,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the reservation to retrieve. E.g.,\n projects/myproject/locations/US/reservations/team1-prod", + "description": "Required. Resource name of the reservation to retrieve. E.g.,\n `projects/myproject/locations/US/reservations/team1-prod`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$", "required": true, @@ -581,7 +581,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the reservation to retrieve. E.g.,\n projects/myproject/locations/US/reservations/team1-prod", + "description": "Required. Resource name of the reservation to retrieve. E.g.,\n `projects/myproject/locations/US/reservations/team1-prod`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$", "required": true, @@ -607,7 +607,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of items to return.", + "description": "The maximum number of items to return per page.", "format": "int32", "location": "query", "type": "integer" @@ -644,7 +644,7 @@ ], "parameters": { "name": { - "description": "The resource name of the reservation, e.g.,\n\"projects/*/locations/*/reservations/team1-prod\".", + "description": "The resource name of the reservation, e.g.,\n`projects/*/locations/*/reservations/team1-prod`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$", "required": true, @@ -674,7 +674,7 @@ "assignments": { "methods": { "create": { - "description": "Creates an object which allows the given project to submit jobs\nof a certain type using slots from the specified reservation. Currently a\nresource (project, folder, organization) can only have one assignment per\n{job_type, location}, and that reservation will be used for all jobs of the\nmatching type. Within the organization, different assignments can be\ncreated on projects, folders or organization level. During query execution,\nthe assignment is looked up at the project, folder and organization levels\nin that order. The first assignment found is applied to the query. When\ncreating assignments, it does not matter if other assignments exist at\nhigher levels. E.g: organizationA contains project1, project2. Assignments\nfor organizationA, project1 and project2 could all be created, mapping to\nthe same or different reservations.\nReturns `google.rpc.Code.PERMISSION_DENIED` if user does not have\n'bigquery.admin' permissions on the project using the reservation\nand the project that owns this reservation.\nReturns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment\ndoes not match location of the reservation.", + "description": "Creates an assignment object which allows the given project to submit jobs\nof a certain type using slots from the specified reservation.\n\nCurrently a\nresource (project, folder, organization) can only have one assignment per\neach (job_type, location) combination, and that reservation will be used\nfor all jobs of the matching type.\n\nDifferent assignments can be created on different levels of the\nprojects, folders or organization hierarchy. During query execution,\nthe assignment is looked up at the project, folder and organization levels\nin that order. The first assignment found is applied to the query.\n\nWhen creating assignments, it does not matter if other assignments exist at\nhigher levels.\n\nExample:\n\n* The organization `organizationA` contains two projects, `project1`\n and `project2`.\n* Assignments for all three entities (`organizationA`, `project1`, and\n `project2`) could all be created and mapped to the same or different\n reservations.\n\nReturns `google.rpc.Code.PERMISSION_DENIED` if user does not have\n'bigquery.admin' permissions on the project using the reservation\nand the project that owns this reservation.\n\nReturns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment\ndoes not match location of the reservation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments", "httpMethod": "POST", "id": "bigqueryreservation.projects.locations.reservations.assignments.create", @@ -683,7 +683,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name of the assignment\nE.g.: projects/myproject/locations/US/reservations/team1-prod", + "description": "Required. The parent resource name of the assignment\nE.g. `projects/myproject/locations/US/reservations/team1-prod`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$", "required": true, @@ -703,7 +703,7 @@ ] }, "delete": { - "description": "Deletes a assignment. No expansion will happen.\nE.g:\norganizationA contains project1 and project2. Reservation res1 exists.\nCreateAssignment was invoked previously and following assignments were\ncreated explicitly:\n \n \nThen deletion of won't affect . After\ndeletion of , queries from project1 will still use\nres1, while queries from project2 will use on-demand mode.", + "description": "Deletes a assignment. No expansion will happen.\n\nExample:\n\n* Organization `organizationA` contains two projects, `project1` and\n `project2`.\n* Reservation `res1` exists and was created previously.\n* CreateAssignment was used previously to define the following\n associations between entities and reservations: ``\n and ``\n\nIn this example, deletion of the `` assignment won't\naffect the other assignment ``. After said deletion,\nqueries from `project1` will still use `res1` while queries from\n`project2` will switch to use on-demand mode.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}", "httpMethod": "DELETE", "id": "bigqueryreservation.projects.locations.reservations.assignments.delete", @@ -712,7 +712,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource, e.g.:\n projects/myproject/locations/US/reservations/team1-prod/assignments/123", + "description": "Required. Name of the resource, e.g.\n `projects/myproject/locations/US/reservations/team1-prod/assignments/123`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/assignments/[^/]+$", "required": true, @@ -729,7 +729,7 @@ ] }, "list": { - "description": "Lists assignments.\nOnly explicitly created assignments will be returned. E.g:\norganizationA contains project1 and project2. Reservation res1 exists.\nCreateAssignment was invoked previously and following assignments were\ncreated explicitly:\n \n \nThen this API will just return the above two assignments for reservation\nres1, and no expansion/merge will happen. Wildcard \"-\" can be used for\nreservations in the request. In that case all assignments belongs to the\nspecified project and location will be listed. Note\n\"-\" cannot be used for projects nor locations.", + "description": "Lists assignments.\n\nOnly explicitly created assignments will be returned.\n\nExample:\n\n* Organization `organizationA` contains two projects, `project1` and\n `project2`.\n* Reservation `res1` exists and was created previously.\n* CreateAssignment was used previously to define the following\n associations between entities and reservations: ``\n and ``\n\nIn this example, ListAssignments will just return the above two assignments\nfor reservation `res1`, and no expansion/merge will happen.\n\nThe wildcard \"-\" can be used for\nreservations in the request. In that case all assignments belongs to the\nspecified project and location will be listed.\n\n**Note** \"-\" cannot be used for projects nor locations.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments", "httpMethod": "GET", "id": "bigqueryreservation.projects.locations.reservations.assignments.list", @@ -738,7 +738,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of items to return.", + "description": "The maximum number of items to return per page.", "format": "int32", "location": "query", "type": "integer" @@ -749,7 +749,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource name e.g.:\nprojects/myproject/locations/US/reservations/team1-prod\nOr:\nprojects/myproject/locations/US/reservations/-", + "description": "Required. The parent resource name e.g.:\n\n`projects/myproject/locations/US/reservations/team1-prod`\n\nOr:\n\n`projects/myproject/locations/US/reservations/-`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$", "required": true, @@ -766,7 +766,7 @@ ] }, "move": { - "description": "Moves a assignment under a new reservation. Customers can do this by\ndeleting the existing assignment followed by creating another assignment\nunder the new reservation, but this method provides a transactional way to\ndo so, to make sure the assignee always has an associated reservation.\nWithout the method customers might see some queries run on-demand which\nmight be unexpected.", + "description": "Moves an assignment under a new reservation.\n\nThis differs from removing an existing assignment and recreating a new one\nby providing a transactional change that ensures an assignee always has an\nassociated reservation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/assignments/{assignmentsId}:move", "httpMethod": "POST", "id": "bigqueryreservation.projects.locations.reservations.assignments.move", @@ -775,7 +775,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the assignment,\ne.g.:\n projects/myproject/locations/US/reservations/team1-prod/assignments/123", + "description": "Required. The resource name of the assignment,\ne.g.\n`projects/myproject/locations/US/reservations/team1-prod/assignments/123`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/assignments/[^/]+$", "required": true, @@ -803,7 +803,7 @@ } } }, - "revision": "20200410", + "revision": "20200509", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -811,7 +811,7 @@ "id": "Assignment", "properties": { "assignee": { - "description": "The resource which will use the reservation. E.g.\nprojects/myproject, folders/123, organizations/456.", + "description": "The resource which will use the reservation. E.g.\n`projects/myproject`, `folders/123`, or `organizations/456`.", "type": "string" }, "jobType": { @@ -829,7 +829,7 @@ "type": "string" }, "name": { - "description": "Output only. Name of the resource. E.g.:\nprojects/myproject/locations/US/reservations/team1-prod/assignments/123.", + "description": "Output only. Name of the resource. E.g.:\n`projects/myproject/locations/US/reservations/team1-prod/assignments/123`.", "type": "string" }, "state": { @@ -871,7 +871,7 @@ "type": "object" }, "CapacityCommitment": { - "description": "Capacity commitment is a way to purchase compute capacity for BigQuery jobs\n(in the form of slots) with some committed period of usage. Annual\ncommitments renew by default. Commitments can be removed after their\ncommitment end time passes. In order to remove annual commitment, its plan\nneeds to be changed to monthly or flex first.\n\nA capacity commitment resource exists as a child resource of the admin\nproject.", + "description": "Capacity commitment is a way to purchase compute capacity for BigQuery jobs\n(in the form of slots) with some committed period of usage. Annual\ncommitments renew by default. Commitments can be removed after their\ncommitment end time passes.\n\nIn order to remove annual commitment, its plan needs to be changed\nto monthly or flex first.\n\nA capacity commitment resource exists as a child resource of the admin\nproject.", "id": "CapacityCommitment", "properties": { "commitmentEndTime": { @@ -884,7 +884,7 @@ "description": "Output only. For FAILED commitment plan, provides the reason of failure." }, "name": { - "description": "Output only. The resource name of the capacity commitment, e.g.,\n projects/myproject/locations/US/capacityCommitments/123", + "description": "Output only. The resource name of the capacity commitment, e.g.,\n`projects/myproject/locations/US/capacityCommitments/123`", "type": "string" }, "plan": { @@ -892,28 +892,32 @@ "enum": [ "COMMITMENT_PLAN_UNSPECIFIED", "FLEX", + "TRIAL", "MONTHLY", "ANNUAL" ], "enumDescriptions": [ "Invalid plan value. Requests with this value will be rejected with\nerror code `google.rpc.Code.INVALID_ARGUMENT`.", "Flex commitments have committed period of 1 minute after becoming ACTIVE.\nAfter that, they are not in a committed period anymore and can be removed\nany time.", + "Trial commitments have a committed period of 182 days after becoming\nACTIVE. After that, they are converted to a new commitment based on the\n`renewal_plan`. Default `renewal_plan` for Trial commitment is Flex so\nthat it can be deleted right after committed period ends.", "Monthly commitments have a committed period of 30 days after becoming\nACTIVE. After that, they are not in a committed period anymore and can be\nremoved any time.", "Annual commitments have a committed period of 365 days after becoming\nACTIVE. After that they are converted to a new commitment based on the\nrenewal_plan." ], "type": "string" }, "renewalPlan": { - "description": "The plan this capacity commitment is converted to after commitment_end_time\npasses. Once the plan is changed, committed period is extended according to\ncommitment plan. Only applicable for ANNUAL commitments.", + "description": "The plan this capacity commitment is converted to after commitment_end_time\npasses. Once the plan is changed, committed period is extended according to\ncommitment plan. Only applicable for ANNUAL and TRIAL commitments.", "enum": [ "COMMITMENT_PLAN_UNSPECIFIED", "FLEX", + "TRIAL", "MONTHLY", "ANNUAL" ], "enumDescriptions": [ "Invalid plan value. Requests with this value will be rejected with\nerror code `google.rpc.Code.INVALID_ARGUMENT`.", "Flex commitments have committed period of 1 minute after becoming ACTIVE.\nAfter that, they are not in a committed period anymore and can be removed\nany time.", + "Trial commitments have a committed period of 182 days after becoming\nACTIVE. After that, they are converted to a new commitment based on the\n`renewal_plan`. Default `renewal_plan` for Trial commitment is Flex so\nthat it can be deleted right after committed period ends.", "Monthly commitments have a committed period of 30 days after becoming\nACTIVE. After that, they are not in a committed period anymore and can be\nremoved any time.", "Annual commitments have a committed period of 365 days after becoming\nACTIVE. After that they are converted to a new commitment based on the\nrenewal_plan." ], @@ -1047,11 +1051,11 @@ "type": "object" }, "MoveAssignmentRequest": { - "description": "The request for\nReservationService.MoveAssignment.\nNote: \"bigquery.reservationAssignments.create\" permission is required on the\ndestination_id. Note: \"bigquery.reservationAssignments.create\" and\n\"bigquery.reservationAssignments.delete\" permission is required on the\nrelated assignee.", + "description": "The request for\nReservationService.MoveAssignment.\n\n**Note**: \"bigquery.reservationAssignments.create\" permission is required on\nthe destination_id.\n\n**Note**: \"bigquery.reservationAssignments.create\" and\n\"bigquery.reservationAssignments.delete\" permission are required on the\nrelated assignee.", "id": "MoveAssignmentRequest", "properties": { "destinationId": { - "description": "The new reservation ID, e.g.:\n projects/myotherproject/locations/US/reservations/team2-prod", + "description": "The new reservation ID, e.g.:\n `projects/myotherproject/locations/US/reservations/team2-prod`", "type": "string" } }, @@ -1101,11 +1105,11 @@ "type": "boolean" }, "name": { - "description": "The resource name of the reservation, e.g.,\n\"projects/*/locations/*/reservations/team1-prod\".", + "description": "The resource name of the reservation, e.g.,\n`projects/*/locations/*/reservations/team1-prod`.", "type": "string" }, "slotCapacity": { - "description": "Minimum slots available to this reservation. A slot is a unit of\ncomputational power in BigQuery, and serves as the unit of parallelism.\nQueries using this reservation might use more slots during runtime if\nignore_idle_slots is set to false.\nIf the new reservation's slot capacity exceed the parent's slot capacity or\nif total slot capacity of the new reservation and its siblings exceeds the\nparent's slot capacity, the request will fail with\n`google.rpc.Code.RESOURCE_EXHAUSTED`.", + "description": "Minimum slots available to this reservation. A slot is a unit of\ncomputational power in BigQuery, and serves as the unit of parallelism.\n\nQueries using this reservation might use more slots during runtime if\nignore_idle_slots is set to false.\n\nIf the new reservation's slot capacity exceed the parent's slot capacity or\nif total slot capacity of the new reservation and its siblings exceeds the\nparent's slot capacity, the request will fail with\n`google.rpc.Code.RESOURCE_EXHAUSTED`.", "format": "int64", "type": "string" } diff --git a/discovery/bigqueryreservation-v1alpha2.json b/discovery/bigqueryreservation-v1alpha2.json index 621d94651e..5c3723b1d3 100644 --- a/discovery/bigqueryreservation-v1alpha2.json +++ b/discovery/bigqueryreservation-v1alpha2.json @@ -614,7 +614,7 @@ } } }, - "revision": "20200410", + "revision": "20200509", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "CreateSlotPoolMetadata": { @@ -830,12 +830,14 @@ "enum": [ "COMMITMENT_PLAN_UNSPECIFIED", "FLEX", + "TRIAL", "MONTHLY", "ANNUAL" ], "enumDescriptions": [ "Invalid plan value. Requests with this value will be rejected with\nerror code `google.rpc.Code.INVALID_ARGUMENT`.", "Slot pool can be removed at any point, even after becoming ACTIVE.", + "Trial commitments have a committed period of 182 days after becoming\nACTIVE. After that, they are converted to a new commitment based on the\nrenewal_plan. Default renewal_plan for Trial commitment is Flex so that\nit can be deleted right after committed period ends.", "Slot pool cannot be removed for 30 days after becoming ACTIVE.", "Slot pool cannot be removed for 365 days after becoming ACTIVE.\nNote: annual commitments are automatically downgraded to monthly after\n365 days." ], diff --git a/discovery/bigqueryreservation-v1beta1.json b/discovery/bigqueryreservation-v1beta1.json index 584cf452a7..92bb5deb39 100644 --- a/discovery/bigqueryreservation-v1beta1.json +++ b/discovery/bigqueryreservation-v1beta1.json @@ -736,7 +736,7 @@ } } }, - "revision": "20200410", + "revision": "20200509", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -782,23 +782,6 @@ }, "type": "object" }, - "Autoscale": { - "description": "Auto scaling settings and current situation.\nSystem will create a dedicated FLEX capacity commitment to hold the slots\nfor auto-scale. Users won't be able to manage it,to avoid conflicts.\nScale-up will happen, if there are always pending tasks for the past 10\nminutes.\nScale-down will happen, if the system knows that scale-up won't be\ntriggered again.\nNote this is an alpha feature.", - "id": "Autoscale", - "properties": { - "currentSlots": { - "description": "Output only. The slot capacity added to this reservation when autoscale happens. Will\nbe between [0, max_slots].", - "format": "int64", - "type": "string" - }, - "maxSlots": { - "description": "Number of slots to be scaled when needed.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, "BiReservation": { "description": "Represents a BI Reservation.", "id": "BiReservation", @@ -842,12 +825,14 @@ "enum": [ "COMMITMENT_PLAN_UNSPECIFIED", "FLEX", + "TRIAL", "MONTHLY", "ANNUAL" ], "enumDescriptions": [ "Invalid plan value. Requests with this value will be rejected with\nerror code `google.rpc.Code.INVALID_ARGUMENT`.", "Flex commitments have committed period of 1 minute after becoming ACTIVE.\nAfter that, they are not in a committed period anymore and can be removed\nany time.", + "Trial commitments have a committed period of 182 days after becoming\nACTIVE. After that, they are converted to a new commitment based on the\nrenewal_plan. Default renewal_plan for Trial commitment is Flex so that\nit can be deleted right after committed period ends.", "Monthly commitments have a committed period of 30 days after becoming\nACTIVE. After that, they are not in a committed period anymore and can be\nremoved any time.", "Annual commitments have a committed period of 365 days after becoming\nACTIVE. After that they are converted to a new commitment based on the\nrenewal_plan." ], @@ -858,12 +843,14 @@ "enum": [ "COMMITMENT_PLAN_UNSPECIFIED", "FLEX", + "TRIAL", "MONTHLY", "ANNUAL" ], "enumDescriptions": [ "Invalid plan value. Requests with this value will be rejected with\nerror code `google.rpc.Code.INVALID_ARGUMENT`.", "Flex commitments have committed period of 1 minute after becoming ACTIVE.\nAfter that, they are not in a committed period anymore and can be removed\nany time.", + "Trial commitments have a committed period of 182 days after becoming\nACTIVE. After that, they are converted to a new commitment based on the\nrenewal_plan. Default renewal_plan for Trial commitment is Flex so that\nit can be deleted right after committed period ends.", "Monthly commitments have a committed period of 30 days after becoming\nACTIVE. After that, they are not in a committed period anymore and can be\nremoved any time.", "Annual commitments have a committed period of 365 days after becoming\nACTIVE. After that they are converted to a new commitment based on the\nrenewal_plan." ], @@ -993,10 +980,6 @@ "description": "A reservation is a mechanism used to guarantee slots to users.", "id": "Reservation", "properties": { - "autoscale": { - "$ref": "Autoscale", - "description": "The configuration parameters for the auto scaling feature. Note this is an\nalpha feature." - }, "ignoreIdleSlots": { "description": "If false, any query using this reservation will use idle slots from other\nreservations within the same admin project. If true, a query using this\nreservation will execute with the slot capacity specified above at most.", "type": "boolean" diff --git a/discovery/cloudsearch-v1.json b/discovery/cloudsearch-v1.json index 7480c12e6e..69cd6019df 100644 --- a/discovery/cloudsearch-v1.json +++ b/discovery/cloudsearch-v1.json @@ -1805,7 +1805,7 @@ } } }, - "revision": "20200421", + "revision": "20200505", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "BooleanOperatorOptions": { @@ -2396,7 +2396,7 @@ "type": "integer" }, "percentage": { - "description": "Percent of results that match the bucket value. This value is between\n(0-100]. Percentages are returned for all searches, but are an estimate.\nBecause percentages are always returned, you should render percentages\ninstead of counts.", + "description": "Percent of results that match the bucket value. The returned value is\nbetween (0-100], and is rounded down to an integer if fractional. If the\nvalue is not explicitly returned, it represents a percentage value that\nrounds to 0. Percentages are returned for all searches, but are an\nestimate. Because percentages are always returned, you should render\npercentages instead of counts.", "format": "int32", "type": "integer" }, @@ -3367,7 +3367,7 @@ "type": "array" }, "objectDisplayLabel": { - "description": "The user friendly label to display in the search result to indicate the\ntype of the item. This is OPTIONAL; if not provided, an object label isn't\ndisplayed on the context line of the search results. The maximum length\nis 32 characters.", + "description": "The user friendly label to display in the search result to indicate the\ntype of the item. This is OPTIONAL; if not provided, an object label isn't\ndisplayed on the context line of the search results. The maximum length\nis 64 characters.", "type": "string" } }, @@ -3690,7 +3690,7 @@ "id": "PropertyDisplayOptions", "properties": { "displayLabel": { - "description": "The user friendly label for the property that is used if the property\nis specified to be displayed in ObjectDisplayOptions. If provided, the\ndisplay label is shown in front of the property values when the property is\npart of the object display options. For example, if the property value is\n'1', the value by itself may not be useful context for the user. If the\ndisplay name given was 'priority', then the user sees 'priority : 1' in\nthe search results which provides clear context to search users. This is\nOPTIONAL; if not given, only the property values are displayed.\nThe maximum length is 32 characters.", + "description": "The user friendly label for the property that is used if the property\nis specified to be displayed in ObjectDisplayOptions. If provided, the\ndisplay label is shown in front of the property values when the property is\npart of the object display options. For example, if the property value is\n'1', the value by itself may not be useful context for the user. If the\ndisplay name given was 'priority', then the user sees 'priority : 1' in\nthe search results which provides clear context to search users. This is\nOPTIONAL; if not given, only the property values are displayed.\nThe maximum length is 64 characters.", "type": "string" } }, diff --git a/discovery/container-v1.json b/discovery/container-v1.json index 9aea0b3f81..ff1281fc79 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -2459,7 +2459,7 @@ } } }, - "revision": "20200425", + "revision": "20200501", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3862,7 +3862,7 @@ "type": "object" }, "NodeTaint": { - "description": "Kubernetes taint is comprised of three fields: key, value, and effect. Effect\ncan only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/", + "description": "Kubernetes taint is comprised of three fields: key, value, and effect. Effect\ncan only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.\n\nSee\n[here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration)\nfor more information, including usage and the valid values.", "id": "NodeTaint", "properties": { "effect": { diff --git a/discovery/datastore-v1.json b/discovery/datastore-v1.json index 0367bcf3e6..36add5db16 100644 --- a/discovery/datastore-v1.json +++ b/discovery/datastore-v1.json @@ -625,7 +625,7 @@ } } }, - "revision": "20200405", + "revision": "20200510", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "AllocateIdsRequest": { @@ -2038,7 +2038,7 @@ "type": "string" }, "stringValue": { - "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.", + "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at most 1,000,000 bytes.", "type": "string" }, "timestampValue": { diff --git a/discovery/datastore-v1beta3.json b/discovery/datastore-v1beta3.json index d2ee820a86..26c9aa00f3 100644 --- a/discovery/datastore-v1beta3.json +++ b/discovery/datastore-v1beta3.json @@ -307,7 +307,7 @@ } } }, - "revision": "20200405", + "revision": "20200510", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "AllocateIdsRequest": { @@ -1489,7 +1489,7 @@ "type": "string" }, "stringValue": { - "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.", + "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at most 1,000,000 bytes.", "type": "string" }, "timestampValue": { diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index aa417414cf..bc72192e36 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -3659,7 +3659,7 @@ "type": "array" }, "value": { - "description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.", + "description": "Optional. The definition of the parameter value. It can be:\n\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.", "type": "string" } }, @@ -5748,7 +5748,7 @@ "type": "array" }, "value": { - "description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.", + "description": "Optional. The definition of the parameter value. It can be:\n\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.", "type": "string" } }, diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index 60b04d242c..6ee744d925 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -5475,7 +5475,7 @@ "type": "array" }, "value": { - "description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.", + "description": "Optional. The definition of the parameter value. It can be:\n\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.", "type": "string" } }, @@ -7827,7 +7827,7 @@ "type": "array" }, "value": { - "description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.", + "description": "Optional. The definition of the parameter value. It can be:\n\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.", "type": "string" } }, diff --git a/discovery/file-v1.json b/discovery/file-v1.json index dde9fe7206..ea15f802b6 100644 --- a/discovery/file-v1.json +++ b/discovery/file-v1.json @@ -477,21 +477,198 @@ } } }, - "revision": "20200413", + "revision": "20200513", "rootUrl": "https://file.googleapis.com/", "schemas": { + "AttributeValue": { + "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.", + "id": "AttributeValue", + "properties": { + "boolValue": { + "description": "A Boolean value represented by `true` or `false`.", + "type": "boolean" + }, + "intValue": { + "description": "A 64-bit signed integer.", + "format": "int64", + "type": "string" + }, + "stringValue": { + "$ref": "TruncatableString", + "description": "A string up to 256 bytes long." + } + }, + "type": "object" + }, + "Attributes": { + "description": "A set of attributes, each in the format `[KEY]:[VALUE]`.", + "id": "Attributes", + "properties": { + "attributeMap": { + "additionalProperties": { + "$ref": "AttributeValue" + }, + "description": "The set of attributes. Each attribute's key can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, a signed 64-bit integer,\nor the Boolean values `true` and `false`. For example:\n\n \"/instance_id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes\": 300\n \"abc.com/myattribute\": true", + "type": "object" + }, + "droppedAttributesCount": { + "description": "The number of attributes that were discarded. Attributes can be discarded\nbecause their keys are too long or because there are too many attributes.\nIf this value is 0 then all attributes are valid.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "BillingView": { + "description": "Message for reporting billing requests through Eventstream.", + "id": "BillingView", + "properties": { + "reportRequests": { + "description": "Billing requests to be reported for an [Eventstream\nresource](http://google3/cloud/eventstream/v2/resource_event.proto).\n\nEach request contains billing operations to be reported under a service\nname. See go/billing-view-construction for documentation on constructing\nbilling view report requests.", + "items": { + "$ref": "ReportRequest" + }, + "type": "array" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, + "Distribution": { + "description": "Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points", + "id": "Distribution", + "properties": { + "bucketCounts": { + "description": "The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "count": { + "description": "The total number of samples in the distribution. Must be >= 0.", + "format": "int64", + "type": "string" + }, + "exemplars": { + "description": "Example points. Must be in increasing order of `value` field.", + "items": { + "$ref": "Exemplar" + }, + "type": "array" + }, + "explicitBuckets": { + "$ref": "ExplicitBuckets", + "description": "Buckets with arbitrary user-provided width." + }, + "exponentialBuckets": { + "$ref": "ExponentialBuckets", + "description": "Buckets with exponentially growing width." + }, + "linearBuckets": { + "$ref": "LinearBuckets", + "description": "Buckets with constant width." + }, + "maximum": { + "description": "The maximum of the population of values. Ignored if `count` is zero.", + "format": "double", + "type": "number" + }, + "mean": { + "description": "The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "The minimum of the population of values. Ignored if `count` is zero.", + "format": "double", + "type": "number" + }, + "sumOfSquaredDeviation": { + "description": "The sum of squared deviations from the mean:\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `count` is zero then this field\nmust be zero, otherwise validation of the request fails.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, + "Exemplar": { + "description": "Exemplars are example points that may be used to annotate aggregated\ndistribution values. They are metadata that gives information about a\nparticular value added to a Distribution bucket, such as a trace ID that\nwas active when a value was added. They may contain further information,\nsuch as a example values and timestamps, origin, etc.", + "id": "Exemplar", + "properties": { + "attachments": { + "description": "Contextual information about the example value. Examples are:\n\n Trace: type.googleapis.com/google.monitoring.v3.SpanContext\n\n Literal string: type.googleapis.com/google.protobuf.StringValue\n\n Labels dropped during aggregation:\n type.googleapis.com/google.monitoring.v3.DroppedLabels\n\nThere may be only a single attachment of any given message type in a\nsingle exemplar, and this is enforced by the system.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "timestamp": { + "description": "The observation (sampling) time of the above value.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "description": "Value of the exemplar point. This value determines to which bucket the\nexemplar belongs.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ExplicitBuckets": { + "description": "Describing buckets with arbitrary user-provided width.", + "id": "ExplicitBuckets", + "properties": { + "bounds": { + "description": "'bound' is a list of strictly increasing boundaries between\nbuckets. Note that a list of length N-1 defines N buckets because\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th finite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from 1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound' only contains a single element; in\nthat special case the single bound defines the boundary between the\nunderflow and overflow buckets.\n\nbucket number lower bound upper bound\n i == 0 (underflow) -inf bound[i]\n 0 < i < bound_size() bound[i-1] bound[i]\n i == bound_size() (overflow) bound[i-1] +inf", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExponentialBuckets": { + "description": "Describing buckets with exponentially growing width.", + "id": "ExponentialBuckets", + "properties": { + "growthFactor": { + "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.", + "format": "double", + "type": "number" + }, + "numFiniteBuckets": { + "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.", + "format": "int32", + "type": "integer" + }, + "scale": { + "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be > 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "FileShareConfig": { "description": "File share configuration for the instance.", "id": "FileShareConfig", @@ -508,6 +685,95 @@ }, "type": "object" }, + "GoogleApiServicecontrolV1Operation": { + "description": "Represents information regarding an operation.", + "id": "GoogleApiServicecontrolV1Operation", + "properties": { + "consumerId": { + "description": "Identity of the consumer who is using the service.\nThis field should be filled in for the operations initiated by a\nconsumer, but not for service-initiated operations that are\nnot related to a specific consumer.\n\n- This can be in one of the following formats:\n - project:PROJECT_ID,\n - project`_`number:PROJECT_NUMBER,\n - projects/PROJECT_ID or PROJECT_NUMBER,\n - folders/FOLDER_NUMBER,\n - organizations/ORGANIZATION_NUMBER,\n - api`_`key:API_KEY.", + "type": "string" + }, + "endTime": { + "description": "End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.", + "format": "google-datetime", + "type": "string" + }, + "importance": { + "description": "DO NOT USE. This is an experimental field.", + "enum": [ + "LOW", + "HIGH", + "DEBUG" + ], + "enumDescriptions": [ + "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.", + "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.", + "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level." + ], + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served, such as App Engine, Compute Engine, or\n Kubernetes Engine.", + "type": "object" + }, + "logEntries": { + "description": "Represents information to be logged.", + "items": { + "$ref": "LogEntry" + }, + "type": "array" + }, + "metricValueSets": { + "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.", + "items": { + "$ref": "MetricValueSet" + }, + "type": "array" + }, + "operationId": { + "description": "Identity of the operation. This must be unique within the scope of the\nservice that generated the operation. If the service calls\nCheck() and Report() on the same operation, the two calls should carry\nthe same id.\n\nUUID version 4 is recommended, though not required.\nIn scenarios where an operation is computed from existing information\nand an idempotent id is desirable for deduplication purpose, UUID version 5\nis recommended. See RFC 4122 for details.", + "type": "string" + }, + "operationName": { + "description": "Fully qualified name of the operation. Reserved for future use.", + "type": "string" + }, + "quotaProperties": { + "$ref": "QuotaProperties", + "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request. If this is not specified, no quota\ncheck will be performed." + }, + "resources": { + "description": "The resources that are involved in the operation.\nThe maximum supported number of entries in this field is 100.", + "items": { + "$ref": "ResourceInfo" + }, + "type": "array" + }, + "startTime": { + "description": "Required. Start time of the operation.", + "format": "google-datetime", + "type": "string" + }, + "traceSpans": { + "description": "Unimplemented. A list of Cloud Trace spans. The span names shall contain\nthe id of the destination project which can be either the produce or the\nconsumer project.", + "items": { + "$ref": "TraceSpan" + }, + "type": "array" + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "User defined labels for the resource that this operation is associated\nwith. Only a combination of 1000 user labels per consumer project are\nallowed.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudSaasacceleratorManagementProvidersV1Instance": { "id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance", "properties": { @@ -739,6 +1005,78 @@ }, "type": "object" }, + "HttpRequest": { + "description": "A common proto for logging HTTP requests. Only contains semantics\ndefined by the HTTP specification. Product-specific logging\ninformation MUST be defined in a separate message.", + "id": "HttpRequest", + "properties": { + "cacheFillBytes": { + "description": "The number of HTTP response bytes inserted into cache. Set only when a\ncache fill was attempted.", + "format": "int64", + "type": "string" + }, + "cacheHit": { + "description": "Whether or not an entity was served from cache\n(with or without validation).", + "type": "boolean" + }, + "cacheLookup": { + "description": "Whether or not a cache lookup was attempted.", + "type": "boolean" + }, + "cacheValidatedWithOriginServer": { + "description": "Whether or not the response was validated with the origin server before\nbeing served from cache. This field is only meaningful if `cache_hit` is\nTrue.", + "type": "boolean" + }, + "latency": { + "description": "The request processing latency on the server, from the time the request was\nreceived until the response was sent.", + "format": "google-duration", + "type": "string" + }, + "protocol": { + "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"", + "type": "string" + }, + "referer": { + "description": "The referer URL of the request, as defined in\n[HTTP/1.1 Header Field\nDefinitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", + "type": "string" + }, + "remoteIp": { + "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP\nrequest. Examples: `\"192.168.1.1\"`, `\"FE80::0202:B3FF:FE1E:8329\"`.", + "type": "string" + }, + "requestMethod": { + "description": "The request method. Examples: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`.", + "type": "string" + }, + "requestSize": { + "description": "The size of the HTTP request message in bytes, including the request\nheaders and the request body.", + "format": "int64", + "type": "string" + }, + "requestUrl": { + "description": "The scheme (http, https), the host name, the path, and the query\nportion of the URL that was requested.\nExample: `\"http://example.com/some/info?color=red\"`.", + "type": "string" + }, + "responseSize": { + "description": "The size of the HTTP response message sent back to the client, in bytes,\nincluding the response headers and the response body.", + "format": "int64", + "type": "string" + }, + "serverIp": { + "description": "The IP address (IPv4 or IPv6) of the origin server that the request was\nsent to.", + "type": "string" + }, + "status": { + "description": "The response code indicating the status of the response.\nExamples: 200, 404.", + "format": "int32", + "type": "integer" + }, + "userAgent": { + "description": "The user agent sent by the client. Example:\n`\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET\nCLR 1.0.3705)\"`.", + "type": "string" + } + }, + "type": "object" + }, "Instance": { "description": "A Cloud Filestore instance.", "id": "Instance", @@ -828,6 +1166,28 @@ }, "type": "object" }, + "LinearBuckets": { + "description": "Describing buckets with constant width.", + "id": "LinearBuckets", + "properties": { + "numFiniteBuckets": { + "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.", + "format": "int32", + "type": "integer" + }, + "offset": { + "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.", + "format": "double", + "type": "number" + }, + "width": { + "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.\nMust be strictly positive.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "ListInstancesResponse": { "description": "ListInstancesResponse is the result of ListInstancesRequest.", "id": "ListInstancesResponse", @@ -923,6 +1283,227 @@ }, "type": "object" }, + "LogEntry": { + "description": "An individual log entry.", + "id": "LogEntry", + "properties": { + "httpRequest": { + "$ref": "HttpRequest", + "description": "Optional. Information about the HTTP request associated with this\nlog entry, if applicable." + }, + "insertId": { + "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.", + "type": "object" + }, + "name": { + "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.", + "type": "string" + }, + "operation": { + "$ref": "LogEntryOperation", + "description": "Optional. Information about an operation associated with the log entry, if\napplicable." + }, + "protoPayload": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.", + "type": "object" + }, + "severity": { + "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.", + "enum": [ + "DEFAULT", + "DEBUG", + "INFO", + "NOTICE", + "WARNING", + "ERROR", + "CRITICAL", + "ALERT", + "EMERGENCY" + ], + "enumDescriptions": [ + "(0) The log entry has no assigned severity level.", + "(100) Debug or trace information.", + "(200) Routine information, such as ongoing status or performance.", + "(300) Normal but significant events, such as start up, shut down, or\na configuration change.", + "(400) Warning events might cause problems.", + "(500) Error events are likely to cause problems.", + "(600) Critical events cause more severe problems or outages.", + "(700) A person must take an action immediately.", + "(800) One or more systems are unusable." + ], + "type": "string" + }, + "sourceLocation": { + "$ref": "LogEntrySourceLocation", + "description": "Optional. Source code location information associated with the log entry,\nif any." + }, + "structPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object.", + "type": "object" + }, + "textPayload": { + "description": "The log entry payload, represented as a Unicode string (UTF-8).", + "type": "string" + }, + "timestamp": { + "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.", + "format": "google-datetime", + "type": "string" + }, + "trace": { + "description": "Optional. Resource name of the trace associated with the log entry, if any.\nIf this field contains a relative resource name, you can assume the name is\nrelative to `//tracing.googleapis.com`. Example:\n`projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`", + "type": "string" + } + }, + "type": "object" + }, + "LogEntryOperation": { + "description": "Additional information about a potentially long-running operation with which\na log entry is associated.", + "id": "LogEntryOperation", + "properties": { + "first": { + "description": "Optional. Set this to True if this is the first log entry in the operation.", + "type": "boolean" + }, + "id": { + "description": "Optional. An arbitrary operation identifier. Log entries with the\nsame identifier are assumed to be part of the same operation.", + "type": "string" + }, + "last": { + "description": "Optional. Set this to True if this is the last log entry in the operation.", + "type": "boolean" + }, + "producer": { + "description": "Optional. An arbitrary producer identifier. The combination of\n`id` and `producer` must be globally unique. Examples for `producer`:\n`\"MyDivision.MyBigCompany.com\"`, `\"github.com/MyProject/MyApplication\"`.", + "type": "string" + } + }, + "type": "object" + }, + "LogEntrySourceLocation": { + "description": "Additional information about the source code location that produced the log\nentry.", + "id": "LogEntrySourceLocation", + "properties": { + "file": { + "description": "Optional. Source file name. Depending on the runtime environment, this\nmight be a simple name or a fully-qualified name.", + "type": "string" + }, + "function": { + "description": "Optional. Human-readable name of the function or method being invoked, with\noptional context such as the class or package name. This information may be\nused in contexts such as the logs viewer, where a file and line number are\nless meaningful. The format can vary by language. For example:\n`qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function`\n(Python).", + "type": "string" + }, + "line": { + "description": "Optional. Line within the source file. 1-based; 0 indicates no line number\navailable.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "MetricValue": { + "description": "Represents a single metric value.", + "id": "MetricValue", + "properties": { + "boolValue": { + "description": "A boolean value.", + "type": "boolean" + }, + "distributionValue": { + "$ref": "Distribution", + "description": "A distribution value." + }, + "doubleValue": { + "description": "A double precision floating point value.", + "format": "double", + "type": "number" + }, + "endTime": { + "description": "The end of the time period over which this metric value's measurement\napplies.", + "format": "google-datetime", + "type": "string" + }, + "int64Value": { + "description": "A signed 64-bit integer value.", + "format": "int64", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.\nNote that this map must not contain monitored resource labels.", + "type": "object" + }, + "moneyValue": { + "$ref": "Money", + "description": "A money value." + }, + "startTime": { + "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.", + "format": "google-datetime", + "type": "string" + }, + "stringValue": { + "description": "A text string value.", + "type": "string" + } + }, + "type": "object" + }, + "MetricValueSet": { + "description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.", + "id": "MetricValueSet", + "properties": { + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, + "metricValues": { + "description": "The values in this metric.", + "items": { + "$ref": "MetricValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "Money": { + "description": "Represents an amount of money with its currency type.", + "id": "Money", + "properties": { + "currencyCode": { + "description": "The 3-letter currency code defined in ISO 4217.", + "type": "string" + }, + "nanos": { + "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "format": "int32", + "type": "integer" + }, + "units": { + "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "NetworkConfig": { "description": "Network configuration for the instance.", "id": "NetworkConfig", @@ -1032,6 +1613,70 @@ }, "type": "object" }, + "QuotaProperties": { + "description": "Represents the properties needed for quota operations.", + "id": "QuotaProperties", + "properties": { + "quotaMode": { + "description": "Quota mode for this operation.", + "enum": [ + "ACQUIRE", + "ACQUIRE_BEST_EFFORT", + "CHECK", + "RELEASE" + ], + "enumDescriptions": [ + "Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation fails and returns\nerror.", + "Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation does not fail and\navailable quota goes down to zero but it returns error.", + "Does not change any available quota. Only checks if there is enough\nquota.\nNo lock is placed on the checked tokens neither.", + "Increases available quota by the operation cost specified for the\noperation." + ], + "type": "string" + } + }, + "type": "object" + }, + "ReportRequest": { + "description": "Request message for the Report method.", + "id": "ReportRequest", + "properties": { + "operations": { + "description": "Operations to be reported.\n\nTypically the service should report one operation per request.\nPutting multiple operations into a single request is allowed, but should\nbe used only when multiple operations are natually available at the time\nof the report.\n\nThere is no limit on the number of operations in the same ReportRequest,\nhowever the ReportRequest size should be no larger than 1MB. See\nReportResponse.report_errors for partial failure behavior.", + "items": { + "$ref": "GoogleApiServicecontrolV1Operation" + }, + "type": "array" + }, + "serviceConfigId": { + "description": "Specifies which version of service config should be used to process the\nrequest.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.", + "type": "string" + }, + "serviceName": { + "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.", + "type": "string" + } + }, + "type": "object" + }, + "ResourceInfo": { + "description": "Describes a resource associated with this operation.", + "id": "ResourceInfo", + "properties": { + "resourceContainer": { + "description": "The identifier of the parent of this resource instance.\nMust be in one of the following formats:\n - “projects/”\n - “folders/”\n - “organizations/”", + "type": "string" + }, + "resourceLocation": { + "description": "The location of the resource. If not empty, the resource will be checked\nagainst location policy. The value must be a valid zone, region or\nmultiregion. For example: \"europe-west4\" or \"northamerica-northeast1-a\"", + "type": "string" + }, + "resourceName": { + "description": "Name of the resource. This is used for auditing purposes.", + "type": "string" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1058,6 +1703,92 @@ } }, "type": "object" + }, + "TraceSpan": { + "description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\nthat describes the end-to-end latency, and one or more subspans for\nits sub-operations. A trace can also contain multiple root spans,\nor none at all. Spans do not need to be contiguous—there may be\ngaps or overlaps between spans in a trace.", + "id": "TraceSpan", + "properties": { + "attributes": { + "$ref": "Attributes", + "description": "A set of attributes on the span. You can have up to 32 attributes per\nspan." + }, + "childSpanCount": { + "description": "An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect missing child spans.", + "format": "int32", + "type": "integer" + }, + "displayName": { + "$ref": "TruncatableString", + "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\nGoogle Cloud Platform Console.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces." + }, + "endTime": { + "description": "The end time of the span. On the client side, this is the time kept by\nthe local machine where the span execution ends. On the server side, this\nis the time when the server application handler stops running.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The resource name of the span in the following format:\n\n projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;\nit is a 32-character hexadecimal encoding of a 16-byte array.\n\n[SPAN_ID] is a unique identifier for a span within a trace; it\nis a 16-character hexadecimal encoding of an 8-byte array.", + "type": "string" + }, + "parentSpanId": { + "description": "The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty.", + "type": "string" + }, + "sameProcessAsParentSpan": { + "description": "(Optional) Set this parameter to indicate whether this span is in\nthe same process as its parent. If you do not set this parameter,\nStackdriver Trace is unable to take advantage of this helpful\ninformation.", + "type": "boolean" + }, + "spanId": { + "description": "The [SPAN_ID] portion of the span's resource name.", + "type": "string" + }, + "spanKind": { + "description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `CLIENT` (caller)\nand `SERVER` (callee) to identify an RPC call.", + "enum": [ + "SPAN_KIND_UNSPECIFIED", + "INTERNAL", + "SERVER", + "CLIENT", + "PRODUCER", + "CONSUMER" + ], + "enumDescriptions": [ + "Unspecified. Do NOT use as default.\nImplementations MAY assume SpanKind.INTERNAL to be default.", + "Indicates that the span is used internally. Default value.", + "Indicates that the span covers server-side handling of an RPC or other\nremote network request.", + "Indicates that the span covers the client-side wrapper around an RPC or\nother remote request.", + "Indicates that the span describes producer sending a message to a broker.\nUnlike client and server, there is no direct critical path latency\nrelationship between producer and consumer spans (e.g. publishing a\nmessage to a pubsub service).", + "Indicates that the span describes consumer receiving a message from a\nbroker. Unlike client and server, there is no direct critical path\nlatency relationship between producer and consumer spans (e.g. receiving\na message from a pubsub service subscription)." + ], + "type": "string" + }, + "startTime": { + "description": "The start time of the span. On the client side, this is the time kept by\nthe local machine where the span execution starts. On the server side, this\nis the time when the server's application handler starts running.", + "format": "google-datetime", + "type": "string" + }, + "status": { + "$ref": "Status", + "description": "An optional final status for this span." + } + }, + "type": "object" + }, + "TruncatableString": { + "description": "Represents a string that might be shortened to a specified length.", + "id": "TruncatableString", + "properties": { + "truncatedByteCount": { + "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.", + "format": "int32", + "type": "integer" + }, + "value": { + "description": "The shortened string. For example, if the original string is 500\nbytes long and the limit of the string is 128 bytes, then\n`value` contains the first 128 bytes of the 500-byte string.\n\nTruncation always happens on a UTF8 character boundary. If there\nare multi-byte characters in the string, then the length of the\nshortened string might be less than the size limit.", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/file-v1beta1.json b/discovery/file-v1beta1.json index 7d42393c0d..551e6dcad3 100644 --- a/discovery/file-v1beta1.json +++ b/discovery/file-v1beta1.json @@ -477,21 +477,198 @@ } } }, - "revision": "20200413", + "revision": "20200513", "rootUrl": "https://file.googleapis.com/", "schemas": { + "AttributeValue": { + "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.", + "id": "AttributeValue", + "properties": { + "boolValue": { + "description": "A Boolean value represented by `true` or `false`.", + "type": "boolean" + }, + "intValue": { + "description": "A 64-bit signed integer.", + "format": "int64", + "type": "string" + }, + "stringValue": { + "$ref": "TruncatableString", + "description": "A string up to 256 bytes long." + } + }, + "type": "object" + }, + "Attributes": { + "description": "A set of attributes, each in the format `[KEY]:[VALUE]`.", + "id": "Attributes", + "properties": { + "attributeMap": { + "additionalProperties": { + "$ref": "AttributeValue" + }, + "description": "The set of attributes. Each attribute's key can be up to 128 bytes\nlong. The value can be a string up to 256 bytes, a signed 64-bit integer,\nor the Boolean values `true` and `false`. For example:\n\n \"/instance_id\": \"my-instance\"\n \"/http/user_agent\": \"\"\n \"/http/request_bytes\": 300\n \"abc.com/myattribute\": true", + "type": "object" + }, + "droppedAttributesCount": { + "description": "The number of attributes that were discarded. Attributes can be discarded\nbecause their keys are too long or because there are too many attributes.\nIf this value is 0 then all attributes are valid.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "BillingView": { + "description": "Message for reporting billing requests through Eventstream.", + "id": "BillingView", + "properties": { + "reportRequests": { + "description": "Billing requests to be reported for an [Eventstream\nresource](http://google3/cloud/eventstream/v2/resource_event.proto).\n\nEach request contains billing operations to be reported under a service\nname. See go/billing-view-construction for documentation on constructing\nbilling view report requests.", + "items": { + "$ref": "ReportRequest" + }, + "type": "array" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, + "Distribution": { + "description": "Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points", + "id": "Distribution", + "properties": { + "bucketCounts": { + "description": "The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "count": { + "description": "The total number of samples in the distribution. Must be >= 0.", + "format": "int64", + "type": "string" + }, + "exemplars": { + "description": "Example points. Must be in increasing order of `value` field.", + "items": { + "$ref": "Exemplar" + }, + "type": "array" + }, + "explicitBuckets": { + "$ref": "ExplicitBuckets", + "description": "Buckets with arbitrary user-provided width." + }, + "exponentialBuckets": { + "$ref": "ExponentialBuckets", + "description": "Buckets with exponentially growing width." + }, + "linearBuckets": { + "$ref": "LinearBuckets", + "description": "Buckets with constant width." + }, + "maximum": { + "description": "The maximum of the population of values. Ignored if `count` is zero.", + "format": "double", + "type": "number" + }, + "mean": { + "description": "The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "The minimum of the population of values. Ignored if `count` is zero.", + "format": "double", + "type": "number" + }, + "sumOfSquaredDeviation": { + "description": "The sum of squared deviations from the mean:\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `count` is zero then this field\nmust be zero, otherwise validation of the request fails.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, + "Exemplar": { + "description": "Exemplars are example points that may be used to annotate aggregated\ndistribution values. They are metadata that gives information about a\nparticular value added to a Distribution bucket, such as a trace ID that\nwas active when a value was added. They may contain further information,\nsuch as a example values and timestamps, origin, etc.", + "id": "Exemplar", + "properties": { + "attachments": { + "description": "Contextual information about the example value. Examples are:\n\n Trace: type.googleapis.com/google.monitoring.v3.SpanContext\n\n Literal string: type.googleapis.com/google.protobuf.StringValue\n\n Labels dropped during aggregation:\n type.googleapis.com/google.monitoring.v3.DroppedLabels\n\nThere may be only a single attachment of any given message type in a\nsingle exemplar, and this is enforced by the system.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "timestamp": { + "description": "The observation (sampling) time of the above value.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "description": "Value of the exemplar point. This value determines to which bucket the\nexemplar belongs.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ExplicitBuckets": { + "description": "Describing buckets with arbitrary user-provided width.", + "id": "ExplicitBuckets", + "properties": { + "bounds": { + "description": "'bound' is a list of strictly increasing boundaries between\nbuckets. Note that a list of length N-1 defines N buckets because\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th finite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from 1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound' only contains a single element; in\nthat special case the single bound defines the boundary between the\nunderflow and overflow buckets.\n\nbucket number lower bound upper bound\n i == 0 (underflow) -inf bound[i]\n 0 < i < bound_size() bound[i-1] bound[i]\n i == bound_size() (overflow) bound[i-1] +inf", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExponentialBuckets": { + "description": "Describing buckets with exponentially growing width.", + "id": "ExponentialBuckets", + "properties": { + "growthFactor": { + "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.", + "format": "double", + "type": "number" + }, + "numFiniteBuckets": { + "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.", + "format": "int32", + "type": "integer" + }, + "scale": { + "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be > 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "FileShareConfig": { "description": "File share configuration for the instance.", "id": "FileShareConfig", @@ -508,6 +685,95 @@ }, "type": "object" }, + "GoogleApiServicecontrolV1Operation": { + "description": "Represents information regarding an operation.", + "id": "GoogleApiServicecontrolV1Operation", + "properties": { + "consumerId": { + "description": "Identity of the consumer who is using the service.\nThis field should be filled in for the operations initiated by a\nconsumer, but not for service-initiated operations that are\nnot related to a specific consumer.\n\n- This can be in one of the following formats:\n - project:PROJECT_ID,\n - project`_`number:PROJECT_NUMBER,\n - projects/PROJECT_ID or PROJECT_NUMBER,\n - folders/FOLDER_NUMBER,\n - organizations/ORGANIZATION_NUMBER,\n - api`_`key:API_KEY.", + "type": "string" + }, + "endTime": { + "description": "End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.", + "format": "google-datetime", + "type": "string" + }, + "importance": { + "description": "DO NOT USE. This is an experimental field.", + "enum": [ + "LOW", + "HIGH", + "DEBUG" + ], + "enumDescriptions": [ + "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.", + "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.", + "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level." + ], + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served, such as App Engine, Compute Engine, or\n Kubernetes Engine.", + "type": "object" + }, + "logEntries": { + "description": "Represents information to be logged.", + "items": { + "$ref": "LogEntry" + }, + "type": "array" + }, + "metricValueSets": { + "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.", + "items": { + "$ref": "MetricValueSet" + }, + "type": "array" + }, + "operationId": { + "description": "Identity of the operation. This must be unique within the scope of the\nservice that generated the operation. If the service calls\nCheck() and Report() on the same operation, the two calls should carry\nthe same id.\n\nUUID version 4 is recommended, though not required.\nIn scenarios where an operation is computed from existing information\nand an idempotent id is desirable for deduplication purpose, UUID version 5\nis recommended. See RFC 4122 for details.", + "type": "string" + }, + "operationName": { + "description": "Fully qualified name of the operation. Reserved for future use.", + "type": "string" + }, + "quotaProperties": { + "$ref": "QuotaProperties", + "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request. If this is not specified, no quota\ncheck will be performed." + }, + "resources": { + "description": "The resources that are involved in the operation.\nThe maximum supported number of entries in this field is 100.", + "items": { + "$ref": "ResourceInfo" + }, + "type": "array" + }, + "startTime": { + "description": "Required. Start time of the operation.", + "format": "google-datetime", + "type": "string" + }, + "traceSpans": { + "description": "Unimplemented. A list of Cloud Trace spans. The span names shall contain\nthe id of the destination project which can be either the produce or the\nconsumer project.", + "items": { + "$ref": "TraceSpan" + }, + "type": "array" + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "User defined labels for the resource that this operation is associated\nwith. Only a combination of 1000 user labels per consumer project are\nallowed.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudSaasacceleratorManagementProvidersV1Instance": { "id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance", "properties": { @@ -739,6 +1005,78 @@ }, "type": "object" }, + "HttpRequest": { + "description": "A common proto for logging HTTP requests. Only contains semantics\ndefined by the HTTP specification. Product-specific logging\ninformation MUST be defined in a separate message.", + "id": "HttpRequest", + "properties": { + "cacheFillBytes": { + "description": "The number of HTTP response bytes inserted into cache. Set only when a\ncache fill was attempted.", + "format": "int64", + "type": "string" + }, + "cacheHit": { + "description": "Whether or not an entity was served from cache\n(with or without validation).", + "type": "boolean" + }, + "cacheLookup": { + "description": "Whether or not a cache lookup was attempted.", + "type": "boolean" + }, + "cacheValidatedWithOriginServer": { + "description": "Whether or not the response was validated with the origin server before\nbeing served from cache. This field is only meaningful if `cache_hit` is\nTrue.", + "type": "boolean" + }, + "latency": { + "description": "The request processing latency on the server, from the time the request was\nreceived until the response was sent.", + "format": "google-duration", + "type": "string" + }, + "protocol": { + "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"", + "type": "string" + }, + "referer": { + "description": "The referer URL of the request, as defined in\n[HTTP/1.1 Header Field\nDefinitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", + "type": "string" + }, + "remoteIp": { + "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP\nrequest. Examples: `\"192.168.1.1\"`, `\"FE80::0202:B3FF:FE1E:8329\"`.", + "type": "string" + }, + "requestMethod": { + "description": "The request method. Examples: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`.", + "type": "string" + }, + "requestSize": { + "description": "The size of the HTTP request message in bytes, including the request\nheaders and the request body.", + "format": "int64", + "type": "string" + }, + "requestUrl": { + "description": "The scheme (http, https), the host name, the path, and the query\nportion of the URL that was requested.\nExample: `\"http://example.com/some/info?color=red\"`.", + "type": "string" + }, + "responseSize": { + "description": "The size of the HTTP response message sent back to the client, in bytes,\nincluding the response headers and the response body.", + "format": "int64", + "type": "string" + }, + "serverIp": { + "description": "The IP address (IPv4 or IPv6) of the origin server that the request was\nsent to.", + "type": "string" + }, + "status": { + "description": "The response code indicating the status of the response.\nExamples: 200, 404.", + "format": "int32", + "type": "integer" + }, + "userAgent": { + "description": "The user agent sent by the client. Example:\n`\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET\nCLR 1.0.3705)\"`.", + "type": "string" + } + }, + "type": "object" + }, "Instance": { "description": "A Cloud Filestore instance.", "id": "Instance", @@ -830,6 +1168,28 @@ }, "type": "object" }, + "LinearBuckets": { + "description": "Describing buckets with constant width.", + "id": "LinearBuckets", + "properties": { + "numFiniteBuckets": { + "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.", + "format": "int32", + "type": "integer" + }, + "offset": { + "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.", + "format": "double", + "type": "number" + }, + "width": { + "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.\nMust be strictly positive.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "ListInstancesResponse": { "description": "ListInstancesResponse is the result of ListInstancesRequest.", "id": "ListInstancesResponse", @@ -925,6 +1285,227 @@ }, "type": "object" }, + "LogEntry": { + "description": "An individual log entry.", + "id": "LogEntry", + "properties": { + "httpRequest": { + "$ref": "HttpRequest", + "description": "Optional. Information about the HTTP request associated with this\nlog entry, if applicable." + }, + "insertId": { + "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.", + "type": "object" + }, + "name": { + "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.", + "type": "string" + }, + "operation": { + "$ref": "LogEntryOperation", + "description": "Optional. Information about an operation associated with the log entry, if\napplicable." + }, + "protoPayload": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.", + "type": "object" + }, + "severity": { + "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.", + "enum": [ + "DEFAULT", + "DEBUG", + "INFO", + "NOTICE", + "WARNING", + "ERROR", + "CRITICAL", + "ALERT", + "EMERGENCY" + ], + "enumDescriptions": [ + "(0) The log entry has no assigned severity level.", + "(100) Debug or trace information.", + "(200) Routine information, such as ongoing status or performance.", + "(300) Normal but significant events, such as start up, shut down, or\na configuration change.", + "(400) Warning events might cause problems.", + "(500) Error events are likely to cause problems.", + "(600) Critical events cause more severe problems or outages.", + "(700) A person must take an action immediately.", + "(800) One or more systems are unusable." + ], + "type": "string" + }, + "sourceLocation": { + "$ref": "LogEntrySourceLocation", + "description": "Optional. Source code location information associated with the log entry,\nif any." + }, + "structPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object.", + "type": "object" + }, + "textPayload": { + "description": "The log entry payload, represented as a Unicode string (UTF-8).", + "type": "string" + }, + "timestamp": { + "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.", + "format": "google-datetime", + "type": "string" + }, + "trace": { + "description": "Optional. Resource name of the trace associated with the log entry, if any.\nIf this field contains a relative resource name, you can assume the name is\nrelative to `//tracing.googleapis.com`. Example:\n`projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`", + "type": "string" + } + }, + "type": "object" + }, + "LogEntryOperation": { + "description": "Additional information about a potentially long-running operation with which\na log entry is associated.", + "id": "LogEntryOperation", + "properties": { + "first": { + "description": "Optional. Set this to True if this is the first log entry in the operation.", + "type": "boolean" + }, + "id": { + "description": "Optional. An arbitrary operation identifier. Log entries with the\nsame identifier are assumed to be part of the same operation.", + "type": "string" + }, + "last": { + "description": "Optional. Set this to True if this is the last log entry in the operation.", + "type": "boolean" + }, + "producer": { + "description": "Optional. An arbitrary producer identifier. The combination of\n`id` and `producer` must be globally unique. Examples for `producer`:\n`\"MyDivision.MyBigCompany.com\"`, `\"github.com/MyProject/MyApplication\"`.", + "type": "string" + } + }, + "type": "object" + }, + "LogEntrySourceLocation": { + "description": "Additional information about the source code location that produced the log\nentry.", + "id": "LogEntrySourceLocation", + "properties": { + "file": { + "description": "Optional. Source file name. Depending on the runtime environment, this\nmight be a simple name or a fully-qualified name.", + "type": "string" + }, + "function": { + "description": "Optional. Human-readable name of the function or method being invoked, with\noptional context such as the class or package name. This information may be\nused in contexts such as the logs viewer, where a file and line number are\nless meaningful. The format can vary by language. For example:\n`qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function`\n(Python).", + "type": "string" + }, + "line": { + "description": "Optional. Line within the source file. 1-based; 0 indicates no line number\navailable.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "MetricValue": { + "description": "Represents a single metric value.", + "id": "MetricValue", + "properties": { + "boolValue": { + "description": "A boolean value.", + "type": "boolean" + }, + "distributionValue": { + "$ref": "Distribution", + "description": "A distribution value." + }, + "doubleValue": { + "description": "A double precision floating point value.", + "format": "double", + "type": "number" + }, + "endTime": { + "description": "The end of the time period over which this metric value's measurement\napplies.", + "format": "google-datetime", + "type": "string" + }, + "int64Value": { + "description": "A signed 64-bit integer value.", + "format": "int64", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.\nNote that this map must not contain monitored resource labels.", + "type": "object" + }, + "moneyValue": { + "$ref": "Money", + "description": "A money value." + }, + "startTime": { + "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.", + "format": "google-datetime", + "type": "string" + }, + "stringValue": { + "description": "A text string value.", + "type": "string" + } + }, + "type": "object" + }, + "MetricValueSet": { + "description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.", + "id": "MetricValueSet", + "properties": { + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, + "metricValues": { + "description": "The values in this metric.", + "items": { + "$ref": "MetricValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "Money": { + "description": "Represents an amount of money with its currency type.", + "id": "Money", + "properties": { + "currencyCode": { + "description": "The 3-letter currency code defined in ISO 4217.", + "type": "string" + }, + "nanos": { + "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "format": "int32", + "type": "integer" + }, + "units": { + "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "NetworkConfig": { "description": "Network configuration for the instance.", "id": "NetworkConfig", @@ -1034,6 +1615,70 @@ }, "type": "object" }, + "QuotaProperties": { + "description": "Represents the properties needed for quota operations.", + "id": "QuotaProperties", + "properties": { + "quotaMode": { + "description": "Quota mode for this operation.", + "enum": [ + "ACQUIRE", + "ACQUIRE_BEST_EFFORT", + "CHECK", + "RELEASE" + ], + "enumDescriptions": [ + "Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation fails and returns\nerror.", + "Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation does not fail and\navailable quota goes down to zero but it returns error.", + "Does not change any available quota. Only checks if there is enough\nquota.\nNo lock is placed on the checked tokens neither.", + "Increases available quota by the operation cost specified for the\noperation." + ], + "type": "string" + } + }, + "type": "object" + }, + "ReportRequest": { + "description": "Request message for the Report method.", + "id": "ReportRequest", + "properties": { + "operations": { + "description": "Operations to be reported.\n\nTypically the service should report one operation per request.\nPutting multiple operations into a single request is allowed, but should\nbe used only when multiple operations are natually available at the time\nof the report.\n\nThere is no limit on the number of operations in the same ReportRequest,\nhowever the ReportRequest size should be no larger than 1MB. See\nReportResponse.report_errors for partial failure behavior.", + "items": { + "$ref": "GoogleApiServicecontrolV1Operation" + }, + "type": "array" + }, + "serviceConfigId": { + "description": "Specifies which version of service config should be used to process the\nrequest.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.", + "type": "string" + }, + "serviceName": { + "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.", + "type": "string" + } + }, + "type": "object" + }, + "ResourceInfo": { + "description": "Describes a resource associated with this operation.", + "id": "ResourceInfo", + "properties": { + "resourceContainer": { + "description": "The identifier of the parent of this resource instance.\nMust be in one of the following formats:\n - “projects/”\n - “folders/”\n - “organizations/”", + "type": "string" + }, + "resourceLocation": { + "description": "The location of the resource. If not empty, the resource will be checked\nagainst location policy. The value must be a valid zone, region or\nmultiregion. For example: \"europe-west4\" or \"northamerica-northeast1-a\"", + "type": "string" + }, + "resourceName": { + "description": "Name of the resource. This is used for auditing purposes.", + "type": "string" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1060,6 +1705,92 @@ } }, "type": "object" + }, + "TraceSpan": { + "description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\nthat describes the end-to-end latency, and one or more subspans for\nits sub-operations. A trace can also contain multiple root spans,\nor none at all. Spans do not need to be contiguous—there may be\ngaps or overlaps between spans in a trace.", + "id": "TraceSpan", + "properties": { + "attributes": { + "$ref": "Attributes", + "description": "A set of attributes on the span. You can have up to 32 attributes per\nspan." + }, + "childSpanCount": { + "description": "An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect missing child spans.", + "format": "int32", + "type": "integer" + }, + "displayName": { + "$ref": "TruncatableString", + "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\nGoogle Cloud Platform Console.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces." + }, + "endTime": { + "description": "The end time of the span. On the client side, this is the time kept by\nthe local machine where the span execution ends. On the server side, this\nis the time when the server application handler stops running.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The resource name of the span in the following format:\n\n projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;\nit is a 32-character hexadecimal encoding of a 16-byte array.\n\n[SPAN_ID] is a unique identifier for a span within a trace; it\nis a 16-character hexadecimal encoding of an 8-byte array.", + "type": "string" + }, + "parentSpanId": { + "description": "The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty.", + "type": "string" + }, + "sameProcessAsParentSpan": { + "description": "(Optional) Set this parameter to indicate whether this span is in\nthe same process as its parent. If you do not set this parameter,\nStackdriver Trace is unable to take advantage of this helpful\ninformation.", + "type": "boolean" + }, + "spanId": { + "description": "The [SPAN_ID] portion of the span's resource name.", + "type": "string" + }, + "spanKind": { + "description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `CLIENT` (caller)\nand `SERVER` (callee) to identify an RPC call.", + "enum": [ + "SPAN_KIND_UNSPECIFIED", + "INTERNAL", + "SERVER", + "CLIENT", + "PRODUCER", + "CONSUMER" + ], + "enumDescriptions": [ + "Unspecified. Do NOT use as default.\nImplementations MAY assume SpanKind.INTERNAL to be default.", + "Indicates that the span is used internally. Default value.", + "Indicates that the span covers server-side handling of an RPC or other\nremote network request.", + "Indicates that the span covers the client-side wrapper around an RPC or\nother remote request.", + "Indicates that the span describes producer sending a message to a broker.\nUnlike client and server, there is no direct critical path latency\nrelationship between producer and consumer spans (e.g. publishing a\nmessage to a pubsub service).", + "Indicates that the span describes consumer receiving a message from a\nbroker. Unlike client and server, there is no direct critical path\nlatency relationship between producer and consumer spans (e.g. receiving\na message from a pubsub service subscription)." + ], + "type": "string" + }, + "startTime": { + "description": "The start time of the span. On the client side, this is the time kept by\nthe local machine where the span execution starts. On the server side, this\nis the time when the server's application handler starts running.", + "format": "google-datetime", + "type": "string" + }, + "status": { + "$ref": "Status", + "description": "An optional final status for this span." + } + }, + "type": "object" + }, + "TruncatableString": { + "description": "Represents a string that might be shortened to a specified length.", + "id": "TruncatableString", + "properties": { + "truncatedByteCount": { + "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.", + "format": "int32", + "type": "integer" + }, + "value": { + "description": "The shortened string. For example, if the original string is 500\nbytes long and the limit of the string is 128 bytes, then\n`value` contains the first 128 bytes of the 500-byte string.\n\nTruncation always happens on a UTF8 character boundary. If there\nare multi-byte characters in the string, then the length of the\nshortened string might be less than the size limit.", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/firebase-v1beta1.json b/discovery/firebase-v1beta1.json index 96e0f7ef30..3f969a7184 100644 --- a/discovery/firebase-v1beta1.json +++ b/discovery/firebase-v1beta1.json @@ -1116,7 +1116,7 @@ } } }, - "revision": "20200512", + "revision": "20200513", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { @@ -1825,7 +1825,7 @@ "type": "string" }, "measurementId": { - "description": "The unique Google-assigned identifier of the Google Analytics web stream\nassociated with the Firebase Web App. Firebase SDKs use this ID to interact\nwith Google Analytics APIs.\n
\n
This field is only present if the App is linked to a web stream in a\nGoogle Analytics App + Web property. Learn more about this ID and Google\nAnalytics web streams in the [Analytics\ndocumentation](https://support.google.com/analytics/topic/9303475).\n
\n
To generate a `measurementId` and link the Web App with a Google\nAnalytics web stream, call\n[`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics).", + "description": "This field will no longer be provided here. Instead, use\n`GetAnalyticsDetails`", "type": "string" }, "messagingSenderId": { diff --git a/discovery/firebasehosting-v1beta1.json b/discovery/firebasehosting-v1beta1.json index db469b258b..973dbfeb35 100644 --- a/discovery/firebasehosting-v1beta1.json +++ b/discovery/firebasehosting-v1beta1.json @@ -1381,7 +1381,7 @@ } } }, - "revision": "20200430", + "revision": "20200512", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { @@ -1643,7 +1643,6 @@ "type": "object" }, "ListReleasesResponse": { - "description": "The response when listing Releases.", "id": "ListReleasesResponse", "properties": { "nextPageToken": { @@ -1661,7 +1660,6 @@ "type": "object" }, "ListVersionFilesResponse": { - "description": "The response when listing a Version's Files..", "id": "ListVersionFilesResponse", "properties": { "files": { @@ -1679,7 +1677,6 @@ "type": "object" }, "ListVersionsResponse": { - "description": "The response when listing Versions.", "id": "ListVersionsResponse", "properties": { "nextPageToken": { @@ -1746,7 +1743,6 @@ "type": "object" }, "PopulateVersionFilesResponse": { - "description": "The response to a PopulateVersionFilesRequest.", "id": "PopulateVersionFilesResponse", "properties": { "uploadRequiredHashes": { @@ -2042,8 +2038,7 @@ "FINALIZED", "DELETED", "ABANDONED", - "EXPIRED", - "CLONING" + "EXPIRED" ], "enumDescriptions": [ "The default status; should not be intentionally used.", @@ -2051,8 +2046,7 @@ "All content has been added to the version, and the version can no longer be\nchanged.", "The version has been deleted.", "The version was not updated to `FINALIZED` within 12 hours and was\nautomatically deleted.", - "The version is outside the site-configured limit for the number of\nretained versions, so the version's content is scheduled for deletion.", - "The version is being cloned from another version. All content is still\nbeing copied over." + "The version is outside the site-configured limit for the number of\nretained versions, so the version's content is scheduled for deletion." ], "type": "string" }, diff --git a/discovery/gamesManagement-v1management.json b/discovery/gamesManagement-v1management.json index 0aed87201d..a776bc4583 100644 --- a/discovery/gamesManagement-v1management.json +++ b/discovery/gamesManagement-v1management.json @@ -8,36 +8,63 @@ } } }, - "basePath": "/games/v1management/", - "baseUrl": "https://www.googleapis.com/games/v1management/", - "batchPath": "batch/gamesManagement/v1management", + "basePath": "", + "baseUrl": "https://www.googleapis.com/", + "batchPath": "batch", "canonicalName": "Games Management", - "description": "The Management API for Google Play Game Services.", + "description": "The Google Play Game Management API allows developers to manage resources from the Google\n Play Game service.", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/games/services", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/0vywllof2KmJMV_A_P1FQUHxgfM\"", + "documentationLink": "https://developers.google.com/games/", "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "gamesManagement:v1management", "kind": "discovery#restDescription", + "mtlsRootUrl": "https://www.mtls.googleapis.com/", "name": "gamesManagement", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, "alt": { "default": "json", - "description": "Data format for the response.", + "description": "Data format for response.", "enum": [ - "json" + "json", + "media", + "proto" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string" }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", @@ -60,12 +87,17 @@ "type": "boolean" }, "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "description": "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.", "location": "query", "type": "string" }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } @@ -75,7 +107,8 @@ "achievements": { "methods": { "reset": { - "description": "Resets the achievement with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.", + "description": "Resets the achievement with the given ID for the currently authenticated\nplayer. This method is only accessible to whitelisted tester accounts for\nyour application.", + "flatPath": "games/v1management/achievements/{achievementId}/reset", "httpMethod": "POST", "id": "gamesManagement.achievements.reset", "parameterOrder": [ @@ -89,7 +122,7 @@ "type": "string" } }, - "path": "achievements/{achievementId}/reset", + "path": "games/v1management/achievements/{achievementId}/reset", "response": { "$ref": "AchievementResetResponse" }, @@ -98,10 +131,13 @@ ] }, "resetAll": { - "description": "Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.", + "description": "Resets all achievements for the currently authenticated player for your\napplication. This method is only accessible to whitelisted tester accounts\nfor your application.", + "flatPath": "games/v1management/achievements/reset", "httpMethod": "POST", "id": "gamesManagement.achievements.resetAll", - "path": "achievements/reset", + "parameterOrder": [], + "parameters": {}, + "path": "games/v1management/achievements/reset", "response": { "$ref": "AchievementResetAllResponse" }, @@ -110,16 +146,20 @@ ] }, "resetAllForAllPlayers": { - "description": "Resets all draft achievements for all players. This method is only available to user accounts for your developer console.", + "description": "Resets all draft achievements for all players. This method is only\navailable to user accounts for your developer console.", + "flatPath": "games/v1management/achievements/resetAllForAllPlayers", "httpMethod": "POST", "id": "gamesManagement.achievements.resetAllForAllPlayers", - "path": "achievements/resetAllForAllPlayers", + "parameterOrder": [], + "parameters": {}, + "path": "games/v1management/achievements/resetAllForAllPlayers", "scopes": [ "https://www.googleapis.com/auth/games" ] }, "resetForAllPlayers": { - "description": "Resets the achievement with the given ID for all players. This method is only available to user accounts for your developer console. Only draft achievements can be reset.", + "description": "Resets the achievement with the given ID for all players. This method is\nonly available to user accounts for your developer console. Only draft\nachievements can be reset.", + "flatPath": "games/v1management/achievements/{achievementId}/resetForAllPlayers", "httpMethod": "POST", "id": "gamesManagement.achievements.resetForAllPlayers", "parameterOrder": [ @@ -133,16 +173,19 @@ "type": "string" } }, - "path": "achievements/{achievementId}/resetForAllPlayers", + "path": "games/v1management/achievements/{achievementId}/resetForAllPlayers", "scopes": [ "https://www.googleapis.com/auth/games" ] }, "resetMultipleForAllPlayers": { - "description": "Resets achievements with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft achievements may be reset.", + "description": "Resets achievements with the given IDs for all players. This method is only\navailable to user accounts for your developer console. Only draft\nachievements may be reset.", + "flatPath": "games/v1management/achievements/resetMultipleForAllPlayers", "httpMethod": "POST", "id": "gamesManagement.achievements.resetMultipleForAllPlayers", - "path": "achievements/resetMultipleForAllPlayers", + "parameterOrder": [], + "parameters": {}, + "path": "games/v1management/achievements/resetMultipleForAllPlayers", "request": { "$ref": "AchievementResetMultipleForAllRequest" }, @@ -155,7 +198,8 @@ "applications": { "methods": { "listHidden": { - "description": "Get the list of players hidden from the given application. This method is only available to user accounts for your developer console.", + "description": "Get the list of players hidden from the given application. This method is\nonly available to user accounts for your developer console.", + "flatPath": "games/v1management/applications/{applicationId}/players/hidden", "httpMethod": "GET", "id": "gamesManagement.applications.listHidden", "parameterOrder": [ @@ -169,11 +213,9 @@ "type": "string" }, "maxResults": { - "description": "The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults.", + "description": "The maximum number of player resources to return in the response, used for\npaging. For any response, the actual number of player resources returned\nmay be less than the specified `maxResults`.", "format": "int32", "location": "query", - "maximum": "50", - "minimum": "1", "type": "integer" }, "pageToken": { @@ -182,7 +224,7 @@ "type": "string" } }, - "path": "applications/{applicationId}/players/hidden", + "path": "games/v1management/applications/{applicationId}/players/hidden", "response": { "$ref": "HiddenPlayerList" }, @@ -195,7 +237,8 @@ "events": { "methods": { "reset": { - "description": "Resets all player progress on the event with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.", + "description": "Resets all player progress on the event with the given ID for the currently\nauthenticated player. This method is only accessible to whitelisted tester\naccounts for your application.", + "flatPath": "games/v1management/events/{eventId}/reset", "httpMethod": "POST", "id": "gamesManagement.events.reset", "parameterOrder": [ @@ -209,31 +252,38 @@ "type": "string" } }, - "path": "events/{eventId}/reset", + "path": "games/v1management/events/{eventId}/reset", "scopes": [ "https://www.googleapis.com/auth/games" ] }, "resetAll": { - "description": "Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.", + "description": "Resets all player progress on all events for the currently authenticated\nplayer. This method is only accessible to whitelisted tester accounts for\nyour application.", + "flatPath": "games/v1management/events/reset", "httpMethod": "POST", "id": "gamesManagement.events.resetAll", - "path": "events/reset", + "parameterOrder": [], + "parameters": {}, + "path": "games/v1management/events/reset", "scopes": [ "https://www.googleapis.com/auth/games" ] }, "resetAllForAllPlayers": { - "description": "Resets all draft events for all players. This method is only available to user accounts for your developer console.", + "description": "Resets all draft events for all players. This method is only available to\nuser accounts for your developer console.", + "flatPath": "games/v1management/events/resetAllForAllPlayers", "httpMethod": "POST", "id": "gamesManagement.events.resetAllForAllPlayers", - "path": "events/resetAllForAllPlayers", + "parameterOrder": [], + "parameters": {}, + "path": "games/v1management/events/resetAllForAllPlayers", "scopes": [ "https://www.googleapis.com/auth/games" ] }, "resetForAllPlayers": { - "description": "Resets the event with the given ID for all players. This method is only available to user accounts for your developer console. Only draft events can be reset.", + "description": "Resets the event with the given ID for all players. This method is only\navailable to user accounts for your developer console. Only draft events\ncan be reset.", + "flatPath": "games/v1management/events/{eventId}/resetForAllPlayers", "httpMethod": "POST", "id": "gamesManagement.events.resetForAllPlayers", "parameterOrder": [ @@ -247,16 +297,19 @@ "type": "string" } }, - "path": "events/{eventId}/resetForAllPlayers", + "path": "games/v1management/events/{eventId}/resetForAllPlayers", "scopes": [ "https://www.googleapis.com/auth/games" ] }, "resetMultipleForAllPlayers": { - "description": "Resets events with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft events may be reset.", + "description": "Resets events with the given IDs for all players. This method is only\navailable to user accounts for your developer console. Only draft events\nmay be reset.", + "flatPath": "games/v1management/events/resetMultipleForAllPlayers", "httpMethod": "POST", "id": "gamesManagement.events.resetMultipleForAllPlayers", - "path": "events/resetMultipleForAllPlayers", + "parameterOrder": [], + "parameters": {}, + "path": "games/v1management/events/resetMultipleForAllPlayers", "request": { "$ref": "EventsResetMultipleForAllRequest" }, @@ -269,7 +322,8 @@ "players": { "methods": { "hide": { - "description": "Hide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.", + "description": "Hide the given player's leaderboard scores from the given application. This\nmethod is only available to user accounts for your developer console.", + "flatPath": "games/v1management/applications/{applicationId}/players/hidden/{playerId}", "httpMethod": "POST", "id": "gamesManagement.players.hide", "parameterOrder": [ @@ -284,19 +338,20 @@ "type": "string" }, "playerId": { - "description": "A player ID. A value of me may be used in place of the authenticated player's ID.", + "description": "A player ID. A value of `me` may be used in place of the\nauthenticated player's ID.", "location": "path", "required": true, "type": "string" } }, - "path": "applications/{applicationId}/players/hidden/{playerId}", + "path": "games/v1management/applications/{applicationId}/players/hidden/{playerId}", "scopes": [ "https://www.googleapis.com/auth/games" ] }, "unhide": { - "description": "Unhide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.", + "description": "Unhide the given player's leaderboard scores from the given application.\nThis method is only available to user accounts for your developer console.", + "flatPath": "games/v1management/applications/{applicationId}/players/hidden/{playerId}", "httpMethod": "DELETE", "id": "gamesManagement.players.unhide", "parameterOrder": [ @@ -311,35 +366,13 @@ "type": "string" }, "playerId": { - "description": "A player ID. A value of me may be used in place of the authenticated player's ID.", + "description": "A player ID. A value of `me` may be used in place of the\nauthenticated player's ID.", "location": "path", "required": true, "type": "string" } }, - "path": "applications/{applicationId}/players/hidden/{playerId}", - "scopes": [ - "https://www.googleapis.com/auth/games" - ] - } - } - }, - "rooms": { - "methods": { - "reset": { - "description": "Reset all rooms for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.", - "httpMethod": "POST", - "id": "gamesManagement.rooms.reset", - "path": "rooms/reset", - "scopes": [ - "https://www.googleapis.com/auth/games" - ] - }, - "resetForAllPlayers": { - "description": "Deletes rooms where the only room participants are from whitelisted tester accounts for your application. This method is only available to user accounts for your developer console.", - "httpMethod": "POST", - "id": "gamesManagement.rooms.resetForAllPlayers", - "path": "rooms/resetForAllPlayers", + "path": "games/v1management/applications/{applicationId}/players/hidden/{playerId}", "scopes": [ "https://www.googleapis.com/auth/games" ] @@ -349,7 +382,8 @@ "scores": { "methods": { "reset": { - "description": "Resets scores for the leaderboard with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.", + "description": "Resets scores for the leaderboard with the given ID for the currently\nauthenticated player. This method is only accessible to whitelisted tester\naccounts for your application.", + "flatPath": "games/v1management/leaderboards/{leaderboardId}/scores/reset", "httpMethod": "POST", "id": "gamesManagement.scores.reset", "parameterOrder": [ @@ -363,7 +397,7 @@ "type": "string" } }, - "path": "leaderboards/{leaderboardId}/scores/reset", + "path": "games/v1management/leaderboards/{leaderboardId}/scores/reset", "response": { "$ref": "PlayerScoreResetResponse" }, @@ -372,10 +406,13 @@ ] }, "resetAll": { - "description": "Resets all scores for all leaderboards for the currently authenticated players. This method is only accessible to whitelisted tester accounts for your application.", + "description": "Resets all scores for all leaderboards for the currently authenticated\nplayers. This method is only accessible to whitelisted tester accounts for\nyour application.", + "flatPath": "games/v1management/scores/reset", "httpMethod": "POST", "id": "gamesManagement.scores.resetAll", - "path": "scores/reset", + "parameterOrder": [], + "parameters": {}, + "path": "games/v1management/scores/reset", "response": { "$ref": "PlayerScoreResetAllResponse" }, @@ -384,16 +421,20 @@ ] }, "resetAllForAllPlayers": { - "description": "Resets scores for all draft leaderboards for all players. This method is only available to user accounts for your developer console.", + "description": "Resets scores for all draft leaderboards for all players. This method is\nonly available to user accounts for your developer console.", + "flatPath": "games/v1management/scores/resetAllForAllPlayers", "httpMethod": "POST", "id": "gamesManagement.scores.resetAllForAllPlayers", - "path": "scores/resetAllForAllPlayers", + "parameterOrder": [], + "parameters": {}, + "path": "games/v1management/scores/resetAllForAllPlayers", "scopes": [ "https://www.googleapis.com/auth/games" ] }, "resetForAllPlayers": { - "description": "Resets scores for the leaderboard with the given ID for all players. This method is only available to user accounts for your developer console. Only draft leaderboards can be reset.", + "description": "Resets scores for the leaderboard with the given ID for all players. This\nmethod is only available to user accounts for your developer console. Only\ndraft leaderboards can be reset.", + "flatPath": "games/v1management/leaderboards/{leaderboardId}/scores/resetForAllPlayers", "httpMethod": "POST", "id": "gamesManagement.scores.resetForAllPlayers", "parameterOrder": [ @@ -407,16 +448,19 @@ "type": "string" } }, - "path": "leaderboards/{leaderboardId}/scores/resetForAllPlayers", + "path": "games/v1management/leaderboards/{leaderboardId}/scores/resetForAllPlayers", "scopes": [ "https://www.googleapis.com/auth/games" ] }, "resetMultipleForAllPlayers": { - "description": "Resets scores for the leaderboards with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft leaderboards may be reset.", + "description": "Resets scores for the leaderboards with the given IDs for all players. This\nmethod is only available to user accounts for your developer console. Only\ndraft leaderboards may be reset.", + "flatPath": "games/v1management/scores/resetMultipleForAllPlayers", "httpMethod": "POST", "id": "gamesManagement.scores.resetMultipleForAllPlayers", - "path": "scores/resetMultipleForAllPlayers", + "parameterOrder": [], + "parameters": {}, + "path": "games/v1management/scores/resetMultipleForAllPlayers", "request": { "$ref": "ScoresResetMultipleForAllRequest" }, @@ -425,40 +469,17 @@ ] } } - }, - "turnBasedMatches": { - "methods": { - "reset": { - "description": "Reset all turn-based match data for a user. This method is only accessible to whitelisted tester accounts for your application.", - "httpMethod": "POST", - "id": "gamesManagement.turnBasedMatches.reset", - "path": "turnbasedmatches/reset", - "scopes": [ - "https://www.googleapis.com/auth/games" - ] - }, - "resetForAllPlayers": { - "description": "Deletes turn-based matches where the only match participants are from whitelisted tester accounts for your application. This method is only available to user accounts for your developer console.", - "httpMethod": "POST", - "id": "gamesManagement.turnBasedMatches.resetForAllPlayers", - "path": "turnbasedmatches/resetForAllPlayers", - "scopes": [ - "https://www.googleapis.com/auth/games" - ] - } - } } }, - "revision": "20200416", + "revision": "20200504", "rootUrl": "https://www.googleapis.com/", "schemas": { "AchievementResetAllResponse": { - "description": "This is a JSON template for achievement reset all response.", + "description": "Achievement reset all response.", "id": "AchievementResetAllResponse", "properties": { "kind": { - "default": "gamesManagement#achievementResetAllResponse", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetAllResponse.", + "description": "Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#achievementResetAllResponse`.", "type": "string" }, "results": { @@ -472,7 +493,6 @@ "type": "object" }, "AchievementResetMultipleForAllRequest": { - "description": "This is a JSON template for multiple achievements reset all request.", "id": "AchievementResetMultipleForAllRequest", "properties": { "achievement_ids": { @@ -483,19 +503,18 @@ "type": "array" }, "kind": { - "default": "gamesManagement#achievementResetMultipleForAllRequest", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetMultipleForAllRequest.", + "description": "Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#achievementResetMultipleForAllRequest`.", "type": "string" } }, "type": "object" }, "AchievementResetResponse": { - "description": "This is a JSON template for an achievement reset response.", + "description": "An achievement reset response.", "id": "AchievementResetResponse", "properties": { "currentState": { - "description": "The current state of the achievement. This is the same as the initial state of the achievement.\nPossible values are: \n- \"HIDDEN\"- Achievement is hidden. \n- \"REVEALED\" - Achievement is revealed. \n- \"UNLOCKED\" - Achievement is unlocked.", + "description": "The current state of the achievement. This is the same as the initial\nstate of the achievement.
Possible values are:
    \n
  • \"`HIDDEN`\"- Achievement is hidden.
    • \n
  • \"`REVEALED`\" - Achievement is revealed.
    • \n
  • \"`UNLOCKED`\" - Achievement is unlocked.
", "type": "string" }, "definitionId": { @@ -503,8 +522,7 @@ "type": "string" }, "kind": { - "default": "gamesManagement#achievementResetResponse", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse.", + "description": "Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#achievementResetResponse`.", "type": "string" }, "updateOccurred": { @@ -515,7 +533,7 @@ "type": "object" }, "EventsResetMultipleForAllRequest": { - "description": "This is a JSON template for multiple events reset all request.", + "description": "Multiple events reset all request.", "id": "EventsResetMultipleForAllRequest", "properties": { "event_ids": { @@ -526,31 +544,14 @@ "type": "array" }, "kind": { - "default": "gamesManagement#eventsResetMultipleForAllRequest", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#eventsResetMultipleForAllRequest.", - "type": "string" - } - }, - "type": "object" - }, - "GamesPlayedResource": { - "description": "This is a JSON template for metadata about a player playing a game with the currently authenticated user.", - "id": "GamesPlayedResource", - "properties": { - "autoMatched": { - "description": "True if the player was auto-matched with the currently authenticated user.", - "type": "boolean" - }, - "timeMillis": { - "description": "The last time the player played the game in milliseconds since the epoch in UTC.", - "format": "int64", + "description": "Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#eventsResetMultipleForAllRequest`.", "type": "string" } }, "type": "object" }, "GamesPlayerExperienceInfoResource": { - "description": "This is a JSON template for 1P/3P metadata about the player's experience.", + "description": "1P/3P metadata about the player's experience.", "id": "GamesPlayerExperienceInfoResource", "properties": { "currentExperiencePoints": { @@ -563,19 +564,19 @@ "description": "The current level of the player." }, "lastLevelUpTimestampMillis": { - "description": "The timestamp when the player was leveled up, in millis since Unix epoch UTC.", + "description": "The timestamp when the player was leveled up, in millis since Unix epoch\nUTC.", "format": "int64", "type": "string" }, "nextLevel": { "$ref": "GamesPlayerLevelResource", - "description": "The next level of the player. If the current level is the maximum level, this should be same as the current level." + "description": "The next level of the player. If the current level is the maximum level,\nthis should be same as the current level." } }, "type": "object" }, "GamesPlayerLevelResource": { - "description": "This is a JSON template for 1P/3P metadata about a user's level.", + "description": "1P/3P metadata about a user's level.", "id": "GamesPlayerLevelResource", "properties": { "level": { @@ -597,28 +598,27 @@ "type": "object" }, "HiddenPlayer": { - "description": "This is a JSON template for the HiddenPlayer resource.", + "description": "The HiddenPlayer resource.", "id": "HiddenPlayer", "properties": { "hiddenTimeMillis": { - "description": "The time this player was hidden.", + "description": "Output only. The time this player was hidden.", "format": "int64", "type": "string" }, "kind": { - "default": "gamesManagement#hiddenPlayer", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayer.", + "description": "Output only. Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#hiddenPlayer`.", "type": "string" }, "player": { "$ref": "Player", - "description": "The player information." + "description": "Output only. The player information." } }, "type": "object" }, "HiddenPlayerList": { - "description": "This is a JSON template for a list of hidden players.", + "description": "A list of hidden players.", "id": "HiddenPlayerList", "properties": { "items": { @@ -629,8 +629,7 @@ "type": "array" }, "kind": { - "default": "gamesManagement#hiddenPlayerList", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayerList.", + "description": "Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#hiddenPlayerList`.", "type": "string" }, "nextPageToken": { @@ -641,7 +640,7 @@ "type": "object" }, "Player": { - "description": "This is a JSON template for a Player resource.", + "description": "A Player resource.", "id": "Player", "properties": { "avatarImageUrl": { @@ -664,35 +663,26 @@ "$ref": "GamesPlayerExperienceInfoResource", "description": "An object to represent Play Game experience information for the player." }, - "friendStatus": { - "description": "The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.", - "type": "string" - }, "kind": { - "default": "gamesManagement#player", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#player.", + "description": "Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#player`.", "type": "string" }, - "lastPlayedWith": { - "$ref": "GamesPlayedResource", - "description": "Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members." - }, "name": { - "description": "An object representation of the individual components of the player's name. For some players, these fields may not be present.", + "description": "An object representation of the individual components of the player's name.\nFor some players, these fields may not be present.", "properties": { "familyName": { - "description": "The family name of this player. In some places, this is known as the last name.", + "description": "The family name of this player. In some places, this is known as the last\nname.", "type": "string" }, "givenName": { - "description": "The given name of this player. In some places, this is known as the first name.", + "description": "The given name of this player. In some places, this is known as the first\nname.", "type": "string" } }, "type": "object" }, "originalPlayerId": { - "description": "The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.", + "description": "The player ID that was used for this player the first time they signed into\nthe game in question. This is only populated for calls to player.get for\nthe requesting player, only if the player ID has subsequently changed, and\nonly to clients that support remapping player IDs.", "type": "string" }, "playerId": { @@ -701,7 +691,7 @@ }, "profileSettings": { "$ref": "ProfileSettings", - "description": "The player's profile settings. Controls whether or not the player's profile is visible to other players." + "description": "The player's profile settings. Controls whether or not the player's profile\nis visible to other players." }, "title": { "description": "The player's title rewarded for their game activities.", @@ -711,12 +701,11 @@ "type": "object" }, "PlayerScoreResetAllResponse": { - "description": "This is a JSON template for a list of leaderboard reset resources.", + "description": "A list of leaderboard reset resources.", "id": "PlayerScoreResetAllResponse", "properties": { "kind": { - "default": "gamesManagement#playerScoreResetAllResponse", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse.", + "description": "Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#playerScoreResetAllResponse`.", "type": "string" }, "results": { @@ -730,7 +719,7 @@ "type": "object" }, "PlayerScoreResetResponse": { - "description": "This is a JSON template for a list of reset leaderboard entry resources.", + "description": "A list of reset leaderboard entry resources.", "id": "PlayerScoreResetResponse", "properties": { "definitionId": { @@ -738,12 +727,11 @@ "type": "string" }, "kind": { - "default": "gamesManagement#playerScoreResetResponse", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse.", + "description": "Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#playerScoreResetResponse`.", "type": "string" }, "resetScoreTimeSpans": { - "description": "The time spans of the updated score.\nPossible values are: \n- \"ALL_TIME\" - The score is an all-time score. \n- \"WEEKLY\" - The score is a weekly score. \n- \"DAILY\" - The score is a daily score.", + "description": "The time spans of the updated score.
Possible values are:
    \n
  • \"`ALL_TIME`\" - The score is an all-time score.
    • \n
  • \"`WEEKLY`\" - The score is a weekly score.
    • \n
  • \"`DAILY`\" - The score is a daily score.
", "items": { "type": "string" }, @@ -753,12 +741,11 @@ "type": "object" }, "ProfileSettings": { - "description": "This is a JSON template for profile settings", + "description": "Profile settings", "id": "ProfileSettings", "properties": { "kind": { - "default": "gamesManagement#profileSettings", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#profileSettings.", + "description": "Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#profileSettings`.", "type": "string" }, "profileVisible": { @@ -768,12 +755,10 @@ "type": "object" }, "ScoresResetMultipleForAllRequest": { - "description": "This is a JSON template for multiple scores reset all request.", "id": "ScoresResetMultipleForAllRequest", "properties": { "kind": { - "default": "gamesManagement#scoresResetMultipleForAllRequest", - "description": "Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#scoresResetMultipleForAllRequest.", + "description": "Uniquely identifies the type of this resource. Value is always the fixed\nstring `gamesManagement#scoresResetMultipleForAllRequest`.", "type": "string" }, "leaderboard_ids": { @@ -787,7 +772,7 @@ "type": "object" } }, - "servicePath": "games/v1management/", - "title": "Google Play Game Services Management API", + "servicePath": "", + "title": "Google Play Game Management", "version": "v1management" } \ No newline at end of file diff --git a/discovery/jobs-v3.json b/discovery/jobs-v3.json index 7582e4cb0e..8fbe4e92f0 100644 --- a/discovery/jobs-v3.json +++ b/discovery/jobs-v3.json @@ -633,7 +633,7 @@ } } }, - "revision": "20200505", + "revision": "20200506", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -1213,7 +1213,7 @@ "id": "CustomAttribute", "properties": { "filterable": { - "description": "Optional. If the `filterable` flag is true, the custom field values may be used for\ncustom attribute filters JobQuery.custom_attribute_filter.\nIf false, these values may not be used for custom attribute filters.\n\nDefault is false.", + "description": "Optional. If the `filterable` flag is true, custom field values are searchable.\nIf false, values are not searchable.\n\nDefault is false.", "type": "boolean" }, "longValues": { diff --git a/discovery/monitoring-v3.json b/discovery/monitoring-v3.json index f552406ac0..7aadf97f52 100644 --- a/discovery/monitoring-v3.json +++ b/discovery/monitoring-v3.json @@ -1262,7 +1262,7 @@ ] }, "query": { - "description": "Queries time series using the time series query language. This method does not require a Workspace.", + "description": "Queries time series using Monitoring Query Language. This method does not require a Workspace.", "flatPath": "v3/projects/{projectsId}/timeSeries:query", "httpMethod": "POST", "id": "monitoring.projects.timeSeries.query", @@ -1848,7 +1848,7 @@ } } }, - "revision": "20200502", + "revision": "20200509", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { diff --git a/discovery/people-v1.json b/discovery/people-v1.json index b018809e92..8d19cf4fee 100644 --- a/discovery/people-v1.json +++ b/discovery/people-v1.json @@ -585,7 +585,7 @@ ], "parameters": { "pageSize": { - "description": "Optional. The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defaults to 100 if not set or set to 0.", + "description": "Optional. The number of connections to include in the response. Valid values are\nbetween 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.", "format": "int32", "location": "query", "type": "integer" @@ -650,7 +650,7 @@ } } }, - "revision": "20200509", + "revision": "20200513", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index dad7da0b93..504718836e 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -1093,7 +1093,7 @@ } } }, - "revision": "20200427", + "revision": "20200505", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1496,7 +1496,7 @@ "type": "string" }, "deliveryAttempt": { - "description": "Delivery attempt counter is 1 + (the sum of number of NACKs and number of\nack_deadline exceeds) for this message.\n\nA NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline\nexceeds event is whenever a message is not acknowledged within\nack_deadline. Note that ack_deadline is initially\nSubscription.ackDeadlineSeconds, but may get extended automatically by\nthe client library.\n\nThe first delivery of a given message will have this value as 1. The value\nis calculated at best effort and is approximate.\n\nIf a DeadLetterPolicy is not set on the subscription, this will be 0.\nEXPERIMENTAL: This feature is part of a closed alpha release. This\nAPI might be changed in backward-incompatible ways and is not recommended\nfor production use. It is not subject to any SLA or deprecation policy.", + "description": "The approximate number of times that Cloud Pub/Sub has attempted to deliver\nthe associated message to a subscriber.\n\nMore precisely, this is 1 + (number of NACKs) +\n(number of ack_deadline exceeds) for this message.\n\nA NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline\nexceeds event is whenever a message is not acknowledged within\nack_deadline. Note that ack_deadline is initially\nSubscription.ackDeadlineSeconds, but may get extended automatically by\nthe client library.\n\nUpon the first delivery of a given message, `delivery_attempt` will have a\nvalue of 1. The value is calculated at best effort and is approximate.\n\nIf a DeadLetterPolicy is not set on the subscription, this will be 0.", "format": "int32", "type": "integer" }, diff --git a/discovery/secretmanager-v1.json b/discovery/secretmanager-v1.json index 000436daeb..8f0f6dcd08 100644 --- a/discovery/secretmanager-v1.json +++ b/discovery/secretmanager-v1.json @@ -300,7 +300,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -628,7 +628,7 @@ } } }, - "revision": "20200417", + "revision": "20200508", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { @@ -717,7 +717,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -879,7 +879,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -902,7 +902,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } @@ -921,7 +921,7 @@ "type": "object" }, "Replication": { - "description": "A policy that defines the replication configuration of data.", + "description": "A policy that defines the replication configuration of data.\n", "id": "Replication", "properties": { "automatic": { @@ -963,7 +963,7 @@ "type": "object" }, "SecretPayload": { - "description": "A secret payload resource in the Secret Manager API. This contains the\nsensitive secret data that is associated with a SecretVersion.", + "description": "A secret payload resource in the Secret Manager API. This contains the\nsensitive secret payload that is associated with a SecretVersion.", "id": "SecretPayload", "properties": { "data": { diff --git a/discovery/secretmanager-v1beta1.json b/discovery/secretmanager-v1beta1.json index c07dd8bdc3..f7524cb3eb 100644 --- a/discovery/secretmanager-v1beta1.json +++ b/discovery/secretmanager-v1beta1.json @@ -300,7 +300,7 @@ ], "parameters": { "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.", + "description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "location": "query", "type": "integer" @@ -628,7 +628,7 @@ } } }, - "revision": "20200417", + "revision": "20200508", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { @@ -717,7 +717,7 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently." + "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)." }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a user that has been recently deleted. For\n example, `alice@example.com?uid=123456789012345678901`. If the user is\n recovered, this value reverts to `user:{emailid}` and the recovered user\n retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n unique identifier) representing a service account that has been recently\n deleted. For example,\n `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n If the service account is undeleted, this value reverts to\n `serviceAccount:{emailid}` and the undeleted service account retains the\n role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n identifier) representing a Google group that has been recently\n deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n the group is recovered, this value reverts to `group:{emailid}` and the\n recovered group retains the role in the binding.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -879,7 +879,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nOptionally, a `binding` can specify a `condition`, which is a logical\nexpression that allows access to a resource only if the expression evaluates\nto `true`. A condition can add constraints based on attributes of the\nrequest, the resource, or both.\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", + "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions; each `role` can be an IAM predefined role or a user-created\ncustom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n\n**YAML example:**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n - etag: BwWWja0YfJA=\n - version: 3\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", "properties": { "auditConfigs": { @@ -902,7 +902,7 @@ "type": "string" }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.", + "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32", "type": "integer" } diff --git a/discovery/testing-v1.json b/discovery/testing-v1.json index 2abd077a17..76bf036f96 100644 --- a/discovery/testing-v1.json +++ b/discovery/testing-v1.json @@ -273,7 +273,7 @@ } } }, - "revision": "20200509", + "revision": "20200508", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { @@ -535,7 +535,7 @@ "type": "array" }, "thumbnailUrl": { - "description": "URL of a thumbnail image of the device.", + "description": "URL of a thumbnail image (photo) of the device.\ne.g. https://lh3.googleusercontent.com/90WcauuJiCYABEl8U0lcZeuS5STUbf2yW...", "type": "string" } }, @@ -1065,7 +1065,7 @@ "type": "object" }, "IosModel": { - "description": "A description of an iOS device tests may be run on.\nNext tag: 12", + "description": "A description of an iOS device tests may be run on.\nNext tag: 13", "id": "IosModel", "properties": { "deviceCapabilities": { diff --git a/discovery/toolresults-v1beta3.json b/discovery/toolresults-v1beta3.json index e46aa598d5..356a9069a6 100644 --- a/discovery/toolresults-v1beta3.json +++ b/discovery/toolresults-v1beta3.json @@ -1446,7 +1446,7 @@ } } }, - "revision": "20200512", + "revision": "20200513", "rootUrl": "https://www.googleapis.com/", "schemas": { "ANR": { @@ -1566,7 +1566,7 @@ "type": "object" }, "AndroidTestLoop": { - "description": "Test Loops are tests that can be launched by the app itself, determining\nwhen to run by listening for an intent. go/ftl-games-dd", + "description": "Test Loops are tests that can be launched by the app itself, determining\nwhen to run by listening for an intent.", "id": "AndroidTestLoop", "properties": {}, "type": "object" @@ -2084,6 +2084,20 @@ "name": { "description": "A name to uniquely identify a history within a project.\nMaximum of 200 characters.\n\n- In response always set\n- In create request: always set", "type": "string" + }, + "testPlatform": { + "description": "The platform of the test history.\n\n- In response: always set. Returns the platform of the last execution if\nunknown.", + "enum": [ + "UNKNOWN_PLATFORM", + "ANDROID", + "IOS" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" } }, "type": "object" @@ -2202,6 +2216,76 @@ }, "type": "object" }, + "IosAppInfo": { + "description": "iOS app information", + "id": "IosAppInfo", + "properties": { + "name": { + "description": "The name of the app.\nRequired", + "type": "string" + } + }, + "type": "object" + }, + "IosRoboTest": { + "description": "A Robo test for an iOS application.", + "id": "IosRoboTest", + "properties": {}, + "type": "object" + }, + "IosTest": { + "description": "A iOS mobile test specification", + "id": "IosTest", + "properties": { + "iosAppInfo": { + "$ref": "IosAppInfo", + "description": "Information about the application under test." + }, + "iosRoboTest": { + "$ref": "IosRoboTest", + "description": "An iOS Robo test." + }, + "iosTestLoop": { + "$ref": "IosTestLoop", + "description": "An iOS test loop." + }, + "iosXcTest": { + "$ref": "IosXcTest", + "description": "An iOS XCTest." + }, + "testTimeout": { + "$ref": "Duration", + "description": "Max time a test is allowed to run before it is\nautomatically cancelled." + } + }, + "type": "object" + }, + "IosTestLoop": { + "description": "A game loop test of an iOS application.", + "id": "IosTestLoop", + "properties": { + "bundleId": { + "description": "Bundle ID of the app.", + "type": "string" + } + }, + "type": "object" + }, + "IosXcTest": { + "description": "A test of an iOS application that uses the XCTest framework.", + "id": "IosXcTest", + "properties": { + "bundleId": { + "description": "Bundle ID of the app.", + "type": "string" + }, + "xcodeVersion": { + "description": "Xcode version that the test was run with.", + "type": "string" + } + }, + "type": "object" + }, "LauncherActivityNotFound": { "description": "Failed to find the launcher activity of an app.", "id": "LauncherActivityNotFound", @@ -3030,6 +3114,10 @@ "androidTest": { "$ref": "AndroidTest", "description": "An Android mobile test execution specification." + }, + "iosTest": { + "$ref": "IosTest", + "description": "An iOS mobile test execution specification." } }, "type": "object" diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index 33a6026e68..7b1ec23b00 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -120,7 +120,7 @@ export namespace bigqueryreservation_v1 { */ export interface Schema$Assignment { /** - * The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456. + * The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. */ assignee?: string | null; /** @@ -128,7 +128,7 @@ export namespace bigqueryreservation_v1 { */ jobType?: string | null; /** - * Output only. Name of the resource. E.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123. + * Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. */ name?: string | null; /** @@ -154,7 +154,7 @@ export namespace bigqueryreservation_v1 { updateTime?: string | null; } /** - * Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project. + * Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project. */ export interface Schema$CapacityCommitment { /** @@ -166,7 +166,7 @@ export namespace bigqueryreservation_v1 { */ failureStatus?: Schema$Status; /** - * Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 + * Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123` */ name?: string | null; /** @@ -174,7 +174,7 @@ export namespace bigqueryreservation_v1 { */ plan?: string | null; /** - * The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL commitments. + * The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. */ renewalPlan?: string | null; /** @@ -261,11 +261,11 @@ export namespace bigqueryreservation_v1 { capacityCommitmentIds?: string[] | null; } /** - * The request for ReservationService.MoveAssignment. Note: "bigquery.reservationAssignments.create" permission is required on the destination_id. Note: "bigquery.reservationAssignments.create" and "bigquery.reservationAssignments.delete" permission is required on the related assignee. + * The request for ReservationService.MoveAssignment. **Note**: "bigquery.reservationAssignments.create" permission is required on the destination_id. **Note**: "bigquery.reservationAssignments.create" and "bigquery.reservationAssignments.delete" permission are required on the related assignee. */ export interface Schema$MoveAssignmentRequest { /** - * The new reservation ID, e.g.: projects/myotherproject/locations/US/reservations/team2-prod + * The new reservation ID, e.g.: `projects/myotherproject/locations/US/reservations/team2-prod` */ destinationId?: string | null; } @@ -303,11 +303,11 @@ export namespace bigqueryreservation_v1 { */ ignoreIdleSlots?: boolean | null; /** - * The resource name of the reservation, e.g., "projects/x/locations/x/reservations/team1-prod". + * The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. */ name?: string | null; /** - * Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. + * Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. */ slotCapacity?: string | null; } @@ -789,7 +789,7 @@ export namespace bigqueryreservation_v1 { /** * bigqueryreservation.projects.locations.searchAssignments - * @desc Looks up assignments for a specified resource for a particular region. If the request is about a project: 1) Assignments created on the project will be returned if they exist. 2) Otherwise assignments created on the closest ancestor will be returned. 3) Assignments for different JobTypes will all be returned. Same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1) permission on the assignee will be verified in this API. 2) Hierarchy lookup (project->folder->organization) happens in this API. 3) Parent here is projects/x/locations/x, instead of projects/x/locations/xreservations/x. Note "-" cannot be used for projects nor locations. + * @desc Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project->folder->organization) happens in this API. 3. Parent here is `projects/x/locations/x`, instead of `projects/x/locations/xreservations/x`. **Note** "-" cannot be used for projects nor locations. * @example * // Before running the sample: * // - Enable the API at: @@ -817,7 +817,7 @@ export namespace bigqueryreservation_v1 { * * // Do the magic * const res = await bigqueryreservation.projects.locations.searchAssignments({ - * // The maximum number of items to return. + * // The maximum number of items to return per page. * pageSize: 'placeholder-value', * // The next_page_token value returned from a previous List request, if any. * pageToken: 'placeholder-value', @@ -826,9 +826,12 @@ export namespace bigqueryreservation_v1 { * // "projects/myproject/locations/US". * parent: 'projects/my-project/locations/my-location', * // Please specify resource name as assignee in the query. - * // e.g., "assignee=projects/myproject" - * // "assignee=folders/123" - * // "assignee=organizations/456" + * // + * // Examples: + * // + * // * `assignee=projects/myproject` + * // * `assignee=folders/123` + * // * `assignee=organizations/456` * query: 'placeholder-value', * }); * console.log(res.data); @@ -849,10 +852,10 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of items to return. + * @param {integer=} params.pageSize The maximum number of items to return per page. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. * @param {string} params.parent Required. The resource name of the admin project(containing project and location), e.g.: "projects/myproject/locations/US". - * @param {string=} params.query Please specify resource name as assignee in the query. e.g., "assignee=projects/myproject" "assignee=folders/123" "assignee=organizations/456" + * @param {string=} params.query Please specify resource name as assignee in the query. Examples: * `assignee=projects/myproject` * `assignee=folders/123` * `assignee=organizations/456` * @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 @@ -929,7 +932,7 @@ export namespace bigqueryreservation_v1 { /** * bigqueryreservation.projects.locations.updateBiReservation - * @desc Updates a BI reservation. Only fields specified in the field_mask are updated. Singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0. + * @desc Updates a BI reservation. Only fields specified in the `field_mask` are updated. A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0. * @example * // Before running the sample: * // - Enable the API at: @@ -1083,7 +1086,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of items to return. + * The maximum number of items to return per page. */ pageSize?: number; /** @@ -1095,7 +1098,7 @@ export namespace bigqueryreservation_v1 { */ parent?: string; /** - * Please specify resource name as assignee in the query. e.g., "assignee=projects/myproject" "assignee=folders/123" "assignee=organizations/456" + * Please specify resource name as assignee in the query. Examples: * `assignee=projects/myproject` * `assignee=folders/123` * `assignee=organizations/456` */ query?: string; } @@ -1652,7 +1655,7 @@ export namespace bigqueryreservation_v1 { /** * bigqueryreservation.projects.locations.capacityCommitments.merge - * @desc Merges capacity commitments of the same plan into one. Resulting capacity commitment has the longer commitment_end_time out of the two. Attempting to merge capacity commitments of different plan will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`. + * @desc Merges capacity commitments of the same plan into a single commitment. The resulting capacity commitment has the greater commitment_end_time out of the to-be-merged capacity commitments. Attempting to merge capacity commitments of different plan will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`. * @example * // Before running the sample: * // - Enable the API at: @@ -1788,7 +1791,7 @@ export namespace bigqueryreservation_v1 { /** * bigqueryreservation.projects.locations.capacityCommitments.patch - * @desc Updates an existing capacity commitment. Only plan and renewal_plan fields can be updated. Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`. + * @desc Updates an existing capacity commitment. Only `plan` and `renewal_plan` fields can be updated. Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`. * @example * // Before running the sample: * // - Enable the API at: @@ -1818,7 +1821,7 @@ export namespace bigqueryreservation_v1 { * const res = await bigqueryreservation.projects.locations.capacityCommitments.patch( * { * // Output only. The resource name of the capacity commitment, e.g., - * // projects/myproject/locations/US/capacityCommitments/123 + * // `projects/myproject/locations/US/capacityCommitments/123` * name: * 'projects/my-project/locations/my-location/capacityCommitments/my-capacityCommitment', * // Standard field mask for the set of fields to be updated. @@ -1862,7 +1865,7 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 + * @param {string} params.name Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123` * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. * @param {().CapacityCommitment} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1931,7 +1934,7 @@ export namespace bigqueryreservation_v1 { /** * bigqueryreservation.projects.locations.capacityCommitments.split - * @desc Splits capacity commitment to two commitments of the same plan and commitment_end_time. A common use case to do that is to perform a downgrade e.g., in order to downgrade from 10000 slots to 8000, one might split 10000 capacity commitment to 2000 and 8000, change the plan of the first one to flex and then delete it. + * @desc Splits capacity commitment to two commitments of the same plan and `commitment_end_time`. A common use case is to enable downgrading commitments. For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you would change the plan of the first one to `FLEX` and then delete it. * @example * // Before running the sample: * // - Enable the API at: @@ -2158,7 +2161,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 + * Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123` */ name?: string; /** @@ -2230,7 +2233,7 @@ export namespace bigqueryreservation_v1 { * // Do the magic * const res = await bigqueryreservation.projects.locations.reservations.create({ * // Required. Project, location. E.g., - * // projects/myproject/locations/US + * // `projects/myproject/locations/US` * parent: 'projects/my-project/locations/my-location', * // The reservation ID. This field must only contain lower case alphanumeric * // characters or dash. Max length is 64 characters. @@ -2265,7 +2268,7 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. Project, location. E.g., projects/myproject/locations/US + * @param {string} params.parent Required. Project, location. E.g., `projects/myproject/locations/US` * @param {string=} params.reservationId The reservation ID. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters. * @param {().Reservation} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2366,7 +2369,7 @@ export namespace bigqueryreservation_v1 { * // Do the magic * const res = await bigqueryreservation.projects.locations.reservations.delete({ * // Required. Resource name of the reservation to retrieve. E.g., - * // projects/myproject/locations/US/reservations/team1-prod + * // `projects/myproject/locations/US/reservations/team1-prod` * name: * 'projects/my-project/locations/my-location/reservations/my-reservation', * }); @@ -2385,7 +2388,7 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod + * @param {string} params.name Required. Resource name of the reservation to retrieve. E.g., `projects/myproject/locations/US/reservations/team1-prod` * @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 @@ -2479,7 +2482,7 @@ export namespace bigqueryreservation_v1 { * // Do the magic * const res = await bigqueryreservation.projects.locations.reservations.get({ * // Required. Resource name of the reservation to retrieve. E.g., - * // projects/myproject/locations/US/reservations/team1-prod + * // `projects/myproject/locations/US/reservations/team1-prod` * name: * 'projects/my-project/locations/my-location/reservations/my-reservation', * }); @@ -2502,7 +2505,7 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod + * @param {string} params.name Required. Resource name of the reservation to retrieve. E.g., `projects/myproject/locations/US/reservations/team1-prod` * @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 @@ -2597,7 +2600,7 @@ export namespace bigqueryreservation_v1 { * * // Do the magic * const res = await bigqueryreservation.projects.locations.reservations.list({ - * // The maximum number of items to return. + * // The maximum number of items to return per page. * pageSize: 'placeholder-value', * // The next_page_token value returned from a previous List request, if any. * pageToken: 'placeholder-value', @@ -2623,7 +2626,7 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of items to return. + * @param {integer=} params.pageSize The maximum number of items to return per page. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. * @param {string} params.parent Required. The parent resource name containing project and location, e.g.: "projects/myproject/locations/US" * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2726,7 +2729,7 @@ export namespace bigqueryreservation_v1 { * // Do the magic * const res = await bigqueryreservation.projects.locations.reservations.patch({ * // The resource name of the reservation, e.g., - * // "projects/x/locations/x/reservations/team1-prod". + * // `projects/x/locations/x/reservations/team1-prod`. * name: * 'projects/my-project/locations/my-location/reservations/my-reservation', * // Standard field mask for the set of fields to be updated. @@ -2761,7 +2764,7 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the reservation, e.g., "projects/x/locations/x/reservations/team1-prod". + * @param {string} params.name The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. * @param {().Reservation} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2837,7 +2840,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Project, location. E.g., projects/myproject/locations/US + * Required. Project, location. E.g., `projects/myproject/locations/US` */ parent?: string; /** @@ -2858,7 +2861,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod + * Required. Resource name of the reservation to retrieve. E.g., `projects/myproject/locations/US/reservations/team1-prod` */ name?: string; } @@ -2870,7 +2873,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod + * Required. Resource name of the reservation to retrieve. E.g., `projects/myproject/locations/US/reservations/team1-prod` */ name?: string; } @@ -2882,7 +2885,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of items to return. + * The maximum number of items to return per page. */ pageSize?: number; /** @@ -2902,7 +2905,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the reservation, e.g., "projects/x/locations/x/reservations/team1-prod". + * The resource name of the reservation, e.g., `projects/x/locations/x/reservations/team1-prod`. */ name?: string; /** @@ -2924,7 +2927,7 @@ export namespace bigqueryreservation_v1 { /** * bigqueryreservation.projects.locations.reservations.assignments.create - * @desc Creates an object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per {job_type, location}, and that reservation will be used for all jobs of the matching type. Within the organization, different assignments can be created on projects, folders or organization level. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. E.g: organizationA contains project1, project2. Assignments for organizationA, project1 and project2 could all be created, mapping to the same or different reservations. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation. + * @desc Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type. Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. Example: * The organization `organizationA` contains two projects, `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and `project2`) could all be created and mapped to the same or different reservations. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation. * @example * // Before running the sample: * // - Enable the API at: @@ -2954,7 +2957,7 @@ export namespace bigqueryreservation_v1 { * const res = await bigqueryreservation.projects.locations.reservations.assignments.create( * { * // Required. The parent resource name of the assignment - * // E.g.: projects/myproject/locations/US/reservations/team1-prod + * // E.g. `projects/myproject/locations/US/reservations/team1-prod` * parent: * 'projects/my-project/locations/my-location/reservations/my-reservation', * @@ -2990,7 +2993,7 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The parent resource name of the assignment E.g.: projects/myproject/locations/US/reservations/team1-prod + * @param {string} params.parent Required. The parent resource name of the assignment E.g. `projects/myproject/locations/US/reservations/team1-prod` * @param {().Assignment} params.requestBody 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. @@ -3061,7 +3064,7 @@ export namespace bigqueryreservation_v1 { /** * bigqueryreservation.projects.locations.reservations.assignments.delete - * @desc Deletes a assignment. No expansion will happen. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly: Then deletion of won't affect . After deletion of , queries from project1 will still use res1, while queries from project2 will use on-demand mode. + * @desc Deletes a assignment. No expansion will happen. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, deletion of the `` assignment won't affect the other assignment ``. After said deletion, queries from `project1` will still use `res1` while queries from `project2` will switch to use on-demand mode. * @example * // Before running the sample: * // - Enable the API at: @@ -3090,8 +3093,8 @@ export namespace bigqueryreservation_v1 { * // Do the magic * const res = await bigqueryreservation.projects.locations.reservations.assignments.delete( * { - * // Required. Name of the resource, e.g.: - * // projects/myproject/locations/US/reservations/team1-prod/assignments/123 + * // Required. Name of the resource, e.g. + * // `projects/myproject/locations/US/reservations/team1-prod/assignments/123` * name: * 'projects/my-project/locations/my-location/reservations/my-reservation/assignments/my-assignment', * } @@ -3111,7 +3114,7 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. Name of the resource, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 + * @param {string} params.name Required. Name of the resource, e.g. `projects/myproject/locations/US/reservations/team1-prod/assignments/123` * @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 @@ -3176,7 +3179,7 @@ export namespace bigqueryreservation_v1 { /** * bigqueryreservation.projects.locations.reservations.assignments.list - * @desc Lists assignments. Only explicitly created assignments will be returned. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly: Then this API will just return the above two assignments for reservation res1, and no expansion/merge will happen. Wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. Note "-" cannot be used for projects nor locations. + * @desc Lists assignments. Only explicitly created assignments will be returned. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, ListAssignments will just return the above two assignments for reservation `res1`, and no expansion/merge will happen. The wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. **Note** "-" cannot be used for projects nor locations. * @example * // Before running the sample: * // - Enable the API at: @@ -3205,14 +3208,17 @@ export namespace bigqueryreservation_v1 { * // Do the magic * const res = await bigqueryreservation.projects.locations.reservations.assignments.list( * { - * // The maximum number of items to return. + * // The maximum number of items to return per page. * pageSize: 'placeholder-value', * // The next_page_token value returned from a previous List request, if any. * pageToken: 'placeholder-value', * // Required. The parent resource name e.g.: - * // projects/myproject/locations/US/reservations/team1-prod + * // + * // `projects/myproject/locations/US/reservations/team1-prod` + * // * // Or: - * // projects/myproject/locations/US/reservations/- + * // + * // `projects/myproject/locations/US/reservations/-` * parent: * 'projects/my-project/locations/my-location/reservations/my-reservation', * } @@ -3235,9 +3241,9 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of items to return. + * @param {integer=} params.pageSize The maximum number of items to return per page. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. - * @param {string} params.parent Required. The parent resource name e.g.: projects/myproject/locations/US/reservations/team1-prod Or: projects/myproject/locations/US/reservations/- + * @param {string} params.parent Required. The parent resource name e.g.: `projects/myproject/locations/US/reservations/team1-prod` Or: `projects/myproject/locations/US/reservations/-` * @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 @@ -3309,7 +3315,7 @@ export namespace bigqueryreservation_v1 { /** * bigqueryreservation.projects.locations.reservations.assignments.move - * @desc Moves a assignment under a new reservation. Customers can do this by deleting the existing assignment followed by creating another assignment under the new reservation, but this method provides a transactional way to do so, to make sure the assignee always has an associated reservation. Without the method customers might see some queries run on-demand which might be unexpected. + * @desc Moves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation. * @example * // Before running the sample: * // - Enable the API at: @@ -3339,8 +3345,8 @@ export namespace bigqueryreservation_v1 { * const res = await bigqueryreservation.projects.locations.reservations.assignments.move( * { * // Required. The resource name of the assignment, - * // e.g.: - * // projects/myproject/locations/US/reservations/team1-prod/assignments/123 + * // e.g. + * // `projects/myproject/locations/US/reservations/team1-prod/assignments/123` * name: * 'projects/my-project/locations/my-location/reservations/my-reservation/assignments/my-assignment', * @@ -3373,7 +3379,7 @@ export namespace bigqueryreservation_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the assignment, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 + * @param {string} params.name Required. The resource name of the assignment, e.g. `projects/myproject/locations/US/reservations/team1-prod/assignments/123` * @param {().MoveAssignmentRequest} params.requestBody 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. @@ -3448,7 +3454,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The parent resource name of the assignment E.g.: projects/myproject/locations/US/reservations/team1-prod + * Required. The parent resource name of the assignment E.g. `projects/myproject/locations/US/reservations/team1-prod` */ parent?: string; @@ -3465,7 +3471,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. Name of the resource, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 + * Required. Name of the resource, e.g. `projects/myproject/locations/US/reservations/team1-prod/assignments/123` */ name?: string; } @@ -3477,7 +3483,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The maximum number of items to return. + * The maximum number of items to return per page. */ pageSize?: number; /** @@ -3485,7 +3491,7 @@ export namespace bigqueryreservation_v1 { */ pageToken?: string; /** - * Required. The parent resource name e.g.: projects/myproject/locations/US/reservations/team1-prod Or: projects/myproject/locations/US/reservations/- + * Required. The parent resource name e.g.: `projects/myproject/locations/US/reservations/team1-prod` Or: `projects/myproject/locations/US/reservations/-` */ parent?: string; } @@ -3497,7 +3503,7 @@ export namespace bigqueryreservation_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the assignment, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 + * Required. The resource name of the assignment, e.g. `projects/myproject/locations/US/reservations/team1-prod/assignments/123` */ name?: string; diff --git a/src/apis/bigqueryreservation/v1beta1.ts b/src/apis/bigqueryreservation/v1beta1.ts index 7a1c721b8c..b1f99f3499 100644 --- a/src/apis/bigqueryreservation/v1beta1.ts +++ b/src/apis/bigqueryreservation/v1beta1.ts @@ -134,19 +134,6 @@ export namespace bigqueryreservation_v1beta1 { */ state?: string | null; } - /** - * Auto scaling settings and current situation. System will create a dedicated FLEX capacity commitment to hold the slots for auto-scale. Users won't be able to manage it,to avoid conflicts. Scale-up will happen, if there are always pending tasks for the past 10 minutes. Scale-down will happen, if the system knows that scale-up won't be triggered again. Note this is an alpha feature. - */ - export interface Schema$Autoscale { - /** - * Output only. The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots]. - */ - currentSlots?: string | null; - /** - * Number of slots to be scaled when needed. - */ - maxSlots?: string | null; - } /** * Represents a BI Reservation. */ @@ -271,10 +258,6 @@ export namespace bigqueryreservation_v1beta1 { * A reservation is a mechanism used to guarantee slots to users. */ export interface Schema$Reservation { - /** - * The configuration parameters for the auto scaling feature. Note this is an alpha feature. - */ - autoscale?: Schema$Autoscale; /** * If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most. */ @@ -1939,7 +1922,6 @@ export namespace bigqueryreservation_v1beta1 { * requestBody: { * // request body parameters * // { - * // "autoscale": {}, * // "ignoreIdleSlots": false, * // "name": "my_name", * // "slotCapacity": "my_slotCapacity" @@ -1950,7 +1932,6 @@ export namespace bigqueryreservation_v1beta1 { * * // Example response * // { - * // "autoscale": {}, * // "ignoreIdleSlots": false, * // "name": "my_name", * // "slotCapacity": "my_slotCapacity" @@ -2188,7 +2169,6 @@ export namespace bigqueryreservation_v1beta1 { * * // Example response * // { - * // "autoscale": {}, * // "ignoreIdleSlots": false, * // "name": "my_name", * // "slotCapacity": "my_slotCapacity" @@ -2445,7 +2425,6 @@ export namespace bigqueryreservation_v1beta1 { * requestBody: { * // request body parameters * // { - * // "autoscale": {}, * // "ignoreIdleSlots": false, * // "name": "my_name", * // "slotCapacity": "my_slotCapacity" @@ -2456,7 +2435,6 @@ export namespace bigqueryreservation_v1beta1 { * * // Example response * // { - * // "autoscale": {}, * // "ignoreIdleSlots": false, * // "name": "my_name", * // "slotCapacity": "my_slotCapacity" diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 96f35c08d8..dc8abf3f69 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -478,7 +478,7 @@ export namespace cloudsearch_v1 { */ count?: number | null; /** - * Percent of results that match the bucket value. This value is between (0-100]. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts. + * Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts. */ percentage?: number | null; value?: Schema$Value; @@ -1070,7 +1070,7 @@ export namespace cloudsearch_v1 { */ metalines?: Schema$Metaline[]; /** - * The user friendly label to display in the search result to indicate the type of the item. This is OPTIONAL; if not provided, an object label isn't displayed on the context line of the search results. The maximum length is 32 characters. + * The user friendly label to display in the search result to indicate the type of the item. This is OPTIONAL; if not provided, an object label isn't displayed on the context line of the search results. The maximum length is 64 characters. */ objectDisplayLabel?: string | null; } @@ -1280,7 +1280,7 @@ export namespace cloudsearch_v1 { */ export interface Schema$PropertyDisplayOptions { /** - * The user friendly label for the property that is used if the property is specified to be displayed in ObjectDisplayOptions. If provided, the display label is shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user sees 'priority : 1' in the search results which provides clear context to search users. This is OPTIONAL; if not given, only the property values are displayed. The maximum length is 32 characters. + * The user friendly label for the property that is used if the property is specified to be displayed in ObjectDisplayOptions. If provided, the display label is shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user sees 'priority : 1' in the search results which provides clear context to search users. This is OPTIONAL; if not given, only the property values are displayed. The maximum length is 64 characters. */ displayLabel?: string | null; } diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index b15751d4c8..1978eff997 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -1253,7 +1253,7 @@ export namespace container_v1 { minNodeCount?: number | null; } /** - * Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + * Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values. */ export interface Schema$NodeTaint { /** diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index 6a0e8ebfcc..1f5ecd9c5b 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -1074,7 +1074,7 @@ export namespace datastore_v1 { */ nullValue?: string | null; /** - * A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes. + * A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. */ stringValue?: string | null; /** diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index e344048422..71054c2f5b 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -926,7 +926,7 @@ export namespace datastore_v1beta3 { */ nullValue?: string | null; /** - * A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at least 1,000,000 bytes. + * A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. */ stringValue?: string | null; /** diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 008c2e66ee..f4f09c2f3b 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -1257,7 +1257,7 @@ export namespace dialogflow_v2 { */ prompts?: string[] | null; /** - * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. + * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. */ value?: string | null; } @@ -2462,7 +2462,7 @@ export namespace dialogflow_v2 { */ prompts?: string[] | null; /** - * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. + * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. */ value?: string | null; } diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index bd43bea417..9c0a60eb4e 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -1542,7 +1542,7 @@ export namespace dialogflow_v2beta1 { */ prompts?: string[] | null; /** - * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. + * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. */ value?: string | null; } @@ -2870,7 +2870,7 @@ export namespace dialogflow_v2beta1 { */ prompts?: string[] | null; /** - * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. + * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. */ value?: string | null; } diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index d39beb66d9..3aab9d37c7 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -113,14 +113,141 @@ export namespace file_v1 { } } + /** + * A set of attributes, each in the format `[KEY]:[VALUE]`. + */ + export interface Schema$Attributes { + /** + * The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "abc.com/myattribute": true + */ + attributeMap?: {[key: string]: Schema$AttributeValue} | null; + /** + * The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. + */ + droppedAttributesCount?: number | null; + } + /** + * The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute. + */ + export interface Schema$AttributeValue { + /** + * A Boolean value represented by `true` or `false`. + */ + boolValue?: boolean | null; + /** + * A 64-bit signed integer. + */ + intValue?: string | null; + /** + * A string up to 256 bytes long. + */ + stringValue?: Schema$TruncatableString; + } + /** + * Message for reporting billing requests through Eventstream. + */ + export interface Schema$BillingView { + /** + * Billing requests to be reported for an [Eventstream resource](http://google3/cloud/eventstream/v2/resource_event.proto). Each request contains billing operations to be reported under a service name. See go/billing-view-construction for documentation on constructing billing view report requests. + */ + reportRequests?: Schema$ReportRequest[]; + } /** * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information: - the arithmetic mean of the samples - the minimum and maximum of the samples - the sum-squared-deviation of the samples, used to compute variance - a histogram of the values of the sample points + */ + export interface Schema$Distribution { + /** + * The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N] is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted. + */ + bucketCounts?: string[] | null; + /** + * The total number of samples in the distribution. Must be >= 0. + */ + count?: string | null; + /** + * Example points. Must be in increasing order of `value` field. + */ + exemplars?: Schema$Exemplar[]; + /** + * Buckets with arbitrary user-provided width. + */ + explicitBuckets?: Schema$ExplicitBuckets; + /** + * Buckets with exponentially growing width. + */ + exponentialBuckets?: Schema$ExponentialBuckets; + /** + * Buckets with constant width. + */ + linearBuckets?: Schema$LinearBuckets; + /** + * The maximum of the population of values. Ignored if `count` is zero. + */ + maximum?: number | null; + /** + * The arithmetic mean of the samples in the distribution. If `count` is zero then this field must be zero. + */ + mean?: number | null; + /** + * The minimum of the population of values. Ignored if `count` is zero. + */ + minimum?: number | null; + /** + * The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If `count` is zero then this field must be zero, otherwise validation of the request fails. + */ + sumOfSquaredDeviation?: number | null; + } /** * 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 {} + /** + * Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc. + */ + export interface Schema$Exemplar { + /** + * Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. + */ + attachments?: Array<{[key: string]: any}> | null; + /** + * The observation (sampling) time of the above value. + */ + timestamp?: string | null; + /** + * Value of the exemplar point. This value determines to which bucket the exemplar belongs. + */ + value?: number | null; + } + /** + * Describing buckets with arbitrary user-provided width. + */ + export interface Schema$ExplicitBuckets { + /** + * 'bound' is a list of strictly increasing boundaries between buckets. Note that a list of length N-1 defines N buckets because of fenceposting. See comments on `bucket_options` for details. The i'th finite bucket covers the interval [bound[i-1], bound[i]) where i ranges from 1 to bound_size() - 1. Note that there are no finite buckets at all if 'bound' only contains a single element; in that special case the single bound defines the boundary between the underflow and overflow buckets. bucket number lower bound upper bound i == 0 (underflow) -inf bound[i] 0 < i < bound_size() bound[i-1] bound[i] i == bound_size() (overflow) bound[i-1] +inf + */ + bounds?: number[] | null; + } + /** + * Describing buckets with exponentially growing width. + */ + export interface Schema$ExponentialBuckets { + /** + * The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than 1.0. + */ + growthFactor?: number | null; + /** + * The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details. + */ + numFiniteBuckets?: number | null; + /** + * The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0. + */ + scale?: number | null; + } /** * File share configuration for the instance. */ @@ -134,6 +261,63 @@ export namespace file_v1 { */ name?: string | null; } + /** + * Represents information regarding an operation. + */ + export interface Schema$GoogleApiServicecontrolV1Operation { + /** + * Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. - This can be in one of the following formats: - project:PROJECT_ID, - project`_`number:PROJECT_NUMBER, - projects/PROJECT_ID or PROJECT_NUMBER, - folders/FOLDER_NUMBER, - organizations/ORGANIZATION_NUMBER, - api`_`key:API_KEY. + */ + consumerId?: string | null; + /** + * End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check. + */ + endTime?: string | null; + /** + * DO NOT USE. This is an experimental field. + */ + importance?: string | null; + /** + * Labels describing the operation. Only the following labels are allowed: - Labels describing monitored resources as defined in the service configuration. - Default labels of metric values. When specified, labels defined in the metric value override these default. - The following labels defined by Google Cloud Platform: - `cloud.googleapis.com/location` describing the location where the operation happened, - `servicecontrol.googleapis.com/user_agent` describing the user agent of the API request, - `servicecontrol.googleapis.com/service_agent` describing the service used to handle the API request (e.g. ESP), - `servicecontrol.googleapis.com/platform` describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine. + */ + labels?: {[key: string]: string} | null; + /** + * Represents information to be logged. + */ + logEntries?: Schema$LogEntry[]; + /** + * Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error. + */ + metricValueSets?: Schema$MetricValueSet[]; + /** + * Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details. + */ + operationId?: string | null; + /** + * Fully qualified name of the operation. Reserved for future use. + */ + operationName?: string | null; + /** + * Represents the properties needed for quota check. Applicable only if this operation is for a quota check request. If this is not specified, no quota check will be performed. + */ + quotaProperties?: Schema$QuotaProperties; + /** + * The resources that are involved in the operation. The maximum supported number of entries in this field is 100. + */ + resources?: Schema$ResourceInfo[]; + /** + * Required. Start time of the operation. + */ + startTime?: string | null; + /** + * Unimplemented. A list of Cloud Trace spans. The span names shall contain the id of the destination project which can be either the produce or the consumer project. + */ + traceSpans?: Schema$TraceSpan[]; + /** + * User defined labels for the resource that this operation is associated with. Only a combination of 1000 user labels per consumer project are allowed. + */ + userLabels?: {[key: string]: string} | null; + } export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1Instance { /** * consumer_defined_name is the name that is set by the consumer. On the other hand Name field represents system-assigned id of an instance so consumers are not necessarily aware of it. consumer_defined_name is used for notification/UI purposes for consumer to recognize their instances. @@ -302,6 +486,71 @@ export namespace file_v1 { */ tier?: string | null; } + /** + * A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. + */ + export interface Schema$HttpRequest { + /** + * The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted. + */ + cacheFillBytes?: string | null; + /** + * Whether or not an entity was served from cache (with or without validation). + */ + cacheHit?: boolean | null; + /** + * Whether or not a cache lookup was attempted. + */ + cacheLookup?: boolean | null; + /** + * Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True. + */ + cacheValidatedWithOriginServer?: boolean | null; + /** + * The request processing latency on the server, from the time the request was received until the response was sent. + */ + latency?: string | null; + /** + * Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket" + */ + protocol?: string | null; + /** + * The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + */ + referer?: string | null; + /** + * The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`. + */ + remoteIp?: string | null; + /** + * The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`. + */ + requestMethod?: string | null; + /** + * The size of the HTTP request message in bytes, including the request headers and the request body. + */ + requestSize?: string | null; + /** + * The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: `"http://example.com/some/info?color=red"`. + */ + requestUrl?: string | null; + /** + * The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body. + */ + responseSize?: string | null; + /** + * The IP address (IPv4 or IPv6) of the origin server that the request was sent to. + */ + serverIp?: string | null; + /** + * The response code indicating the status of the response. Examples: 200, 404. + */ + status?: number | null; + /** + * The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`. + */ + userAgent?: string | null; + } /** * A Cloud Filestore instance. */ @@ -347,6 +596,23 @@ export namespace file_v1 { */ tier?: string | null; } + /** + * Describing buckets with constant width. + */ + export interface Schema$LinearBuckets { + /** + * The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details. + */ + numFiniteBuckets?: number | null; + /** + * The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. + */ + offset?: number | null; + /** + * The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. Must be strictly positive. + */ + width?: number | null; + } /** * ListInstancesResponse is the result of ListInstancesRequest. */ @@ -415,6 +681,168 @@ export namespace file_v1 { */ name?: string | null; } + /** + * An individual log entry. + */ + export interface Schema$LogEntry { + /** + * Optional. Information about the HTTP request associated with this log entry, if applicable. + */ + httpRequest?: Schema$HttpRequest; + /** + * A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operation_id. + */ + insertId?: string | null; + /** + * A set of user-defined (key, value) data that provides additional information about the log entry. + */ + labels?: {[key: string]: string} | null; + /** + * Required. The log to which this log entry belongs. Examples: `"syslog"`, `"book_log"`. + */ + name?: string | null; + /** + * Optional. Information about an operation associated with the log entry, if applicable. + */ + operation?: Schema$LogEntryOperation; + /** + * The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is AuditLog. + */ + protoPayload?: {[key: string]: any} | null; + /** + * The severity of the log entry. The default value is `LogSeverity.DEFAULT`. + */ + severity?: string | null; + /** + * Optional. Source code location information associated with the log entry, if any. + */ + sourceLocation?: Schema$LogEntrySourceLocation; + /** + * The log entry payload, represented as a structure that is expressed as a JSON object. + */ + structPayload?: {[key: string]: any} | null; + /** + * The log entry payload, represented as a Unicode string (UTF-8). + */ + textPayload?: string | null; + /** + * The time the event described by the log entry occurred. If omitted, defaults to operation start time. + */ + timestamp?: string | null; + /** + * Optional. Resource name of the trace associated with the log entry, if any. If this field contains a relative resource name, you can assume the name is relative to `//tracing.googleapis.com`. Example: `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824` + */ + trace?: string | null; + } + /** + * Additional information about a potentially long-running operation with which a log entry is associated. + */ + export interface Schema$LogEntryOperation { + /** + * Optional. Set this to True if this is the first log entry in the operation. + */ + first?: boolean | null; + /** + * Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation. + */ + id?: string | null; + /** + * Optional. Set this to True if this is the last log entry in the operation. + */ + last?: boolean | null; + /** + * Optional. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`. + */ + producer?: string | null; + } + /** + * Additional information about the source code location that produced the log entry. + */ + export interface Schema$LogEntrySourceLocation { + /** + * Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name. + */ + file?: string | null; + /** + * Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python). + */ + function?: string | null; + /** + * Optional. Line within the source file. 1-based; 0 indicates no line number available. + */ + line?: string | null; + } + /** + * Represents a single metric value. + */ + export interface Schema$MetricValue { + /** + * A boolean value. + */ + boolValue?: boolean | null; + /** + * A distribution value. + */ + distributionValue?: Schema$Distribution; + /** + * A double precision floating point value. + */ + doubleValue?: number | null; + /** + * The end of the time period over which this metric value's measurement applies. + */ + endTime?: string | null; + /** + * A signed 64-bit integer value. + */ + int64Value?: string | null; + /** + * The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship. Note that this map must not contain monitored resource labels. + */ + labels?: {[key: string]: string} | null; + /** + * A money value. + */ + moneyValue?: Schema$Money; + /** + * The start of the time period over which this metric value's measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details. + */ + startTime?: string | null; + /** + * A text string value. + */ + stringValue?: string | null; + } + /** + * Represents a set of metric values in the same metric. Each metric value in the set should have a unique combination of start time, end time, and label values. + */ + export interface Schema$MetricValueSet { + /** + * The metric name defined in the service configuration. + */ + metricName?: string | null; + /** + * The values in this metric. + */ + metricValues?: Schema$MetricValue[]; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$Money { + /** + * The 3-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + */ + nanos?: number | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: string | null; + } /** * Network configuration for the instance. */ @@ -494,6 +922,49 @@ export namespace file_v1 { */ verb?: string | null; } + /** + * Represents the properties needed for quota operations. + */ + export interface Schema$QuotaProperties { + /** + * Quota mode for this operation. + */ + quotaMode?: string | null; + } + /** + * Request message for the Report method. + */ + export interface Schema$ReportRequest { + /** + * Operations to be reported. Typically the service should report one operation per request. Putting multiple operations into a single request is allowed, but should be used only when multiple operations are natually available at the time of the report. There is no limit on the number of operations in the same ReportRequest, however the ReportRequest size should be no larger than 1MB. See ReportResponse.report_errors for partial failure behavior. + */ + operations?: Schema$GoogleApiServicecontrolV1Operation[]; + /** + * Specifies which version of service config should be used to process the request. If unspecified or no matching version can be found, the latest one will be used. + */ + serviceConfigId?: string | null; + /** + * The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name. + */ + serviceName?: string | null; + } + /** + * Describes a resource associated with this operation. + */ + export interface Schema$ResourceInfo { + /** + * The identifier of the parent of this resource instance. Must be in one of the following formats: - “projects/<project-id or project-number>” - “folders/<folder-id>” - “organizations/<organization-id>” + */ + resourceContainer?: string | null; + /** + * The location of the resource. If not empty, the resource will be checked against location policy. The value must be a valid zone, region or multiregion. For example: "europe-west4" or "northamerica-northeast1-a" + */ + resourceLocation?: string | null; + /** + * Name of the resource. This is used for auditing purposes. + */ + resourceName?: string | null; + } /** * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ @@ -511,6 +982,68 @@ export namespace file_v1 { */ message?: string | null; } + /** + * A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous&mdash;there may be gaps or overlaps between spans in a trace. + */ + export interface Schema$TraceSpan { + /** + * A set of attributes on the span. You can have up to 32 attributes per span. + */ + attributes?: Schema$Attributes; + /** + * An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. + */ + childSpanCount?: number | null; + /** + * A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces. + */ + displayName?: Schema$TruncatableString; + /** + * The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. + */ + endTime?: string | null; + /** + * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. + */ + name?: string | null; + /** + * The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty. + */ + parentSpanId?: string | null; + /** + * (Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information. + */ + sameProcessAsParentSpan?: boolean | null; + /** + * The [SPAN_ID] portion of the span's resource name. + */ + spanId?: string | null; + /** + * Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call. + */ + spanKind?: string | null; + /** + * The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. + */ + startTime?: string | null; + /** + * An optional final status for this span. + */ + status?: Schema$Status; + } + /** + * Represents a string that might be shortened to a specified length. + */ + export interface Schema$TruncatableString { + /** + * The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + */ + truncatedByteCount?: number | null; + /** + * The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + */ + value?: string | null; + } export class Resource$Projects { context: APIRequestContext; diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index d6b2e3c01b..893d16d583 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -113,14 +113,141 @@ export namespace file_v1beta1 { } } + /** + * A set of attributes, each in the format `[KEY]:[VALUE]`. + */ + export interface Schema$Attributes { + /** + * The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "abc.com/myattribute": true + */ + attributeMap?: {[key: string]: Schema$AttributeValue} | null; + /** + * The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. + */ + droppedAttributesCount?: number | null; + } + /** + * The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute. + */ + export interface Schema$AttributeValue { + /** + * A Boolean value represented by `true` or `false`. + */ + boolValue?: boolean | null; + /** + * A 64-bit signed integer. + */ + intValue?: string | null; + /** + * A string up to 256 bytes long. + */ + stringValue?: Schema$TruncatableString; + } + /** + * Message for reporting billing requests through Eventstream. + */ + export interface Schema$BillingView { + /** + * Billing requests to be reported for an [Eventstream resource](http://google3/cloud/eventstream/v2/resource_event.proto). Each request contains billing operations to be reported under a service name. See go/billing-view-construction for documentation on constructing billing view report requests. + */ + reportRequests?: Schema$ReportRequest[]; + } /** * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information: - the arithmetic mean of the samples - the minimum and maximum of the samples - the sum-squared-deviation of the samples, used to compute variance - a histogram of the values of the sample points + */ + export interface Schema$Distribution { + /** + * The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N] is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted. + */ + bucketCounts?: string[] | null; + /** + * The total number of samples in the distribution. Must be >= 0. + */ + count?: string | null; + /** + * Example points. Must be in increasing order of `value` field. + */ + exemplars?: Schema$Exemplar[]; + /** + * Buckets with arbitrary user-provided width. + */ + explicitBuckets?: Schema$ExplicitBuckets; + /** + * Buckets with exponentially growing width. + */ + exponentialBuckets?: Schema$ExponentialBuckets; + /** + * Buckets with constant width. + */ + linearBuckets?: Schema$LinearBuckets; + /** + * The maximum of the population of values. Ignored if `count` is zero. + */ + maximum?: number | null; + /** + * The arithmetic mean of the samples in the distribution. If `count` is zero then this field must be zero. + */ + mean?: number | null; + /** + * The minimum of the population of values. Ignored if `count` is zero. + */ + minimum?: number | null; + /** + * The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If `count` is zero then this field must be zero, otherwise validation of the request fails. + */ + sumOfSquaredDeviation?: number | null; + } /** * 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 {} + /** + * Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc. + */ + export interface Schema$Exemplar { + /** + * Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. + */ + attachments?: Array<{[key: string]: any}> | null; + /** + * The observation (sampling) time of the above value. + */ + timestamp?: string | null; + /** + * Value of the exemplar point. This value determines to which bucket the exemplar belongs. + */ + value?: number | null; + } + /** + * Describing buckets with arbitrary user-provided width. + */ + export interface Schema$ExplicitBuckets { + /** + * 'bound' is a list of strictly increasing boundaries between buckets. Note that a list of length N-1 defines N buckets because of fenceposting. See comments on `bucket_options` for details. The i'th finite bucket covers the interval [bound[i-1], bound[i]) where i ranges from 1 to bound_size() - 1. Note that there are no finite buckets at all if 'bound' only contains a single element; in that special case the single bound defines the boundary between the underflow and overflow buckets. bucket number lower bound upper bound i == 0 (underflow) -inf bound[i] 0 < i < bound_size() bound[i-1] bound[i] i == bound_size() (overflow) bound[i-1] +inf + */ + bounds?: number[] | null; + } + /** + * Describing buckets with exponentially growing width. + */ + export interface Schema$ExponentialBuckets { + /** + * The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than 1.0. + */ + growthFactor?: number | null; + /** + * The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details. + */ + numFiniteBuckets?: number | null; + /** + * The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0. + */ + scale?: number | null; + } /** * File share configuration for the instance. */ @@ -134,6 +261,63 @@ export namespace file_v1beta1 { */ name?: string | null; } + /** + * Represents information regarding an operation. + */ + export interface Schema$GoogleApiServicecontrolV1Operation { + /** + * Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. - This can be in one of the following formats: - project:PROJECT_ID, - project`_`number:PROJECT_NUMBER, - projects/PROJECT_ID or PROJECT_NUMBER, - folders/FOLDER_NUMBER, - organizations/ORGANIZATION_NUMBER, - api`_`key:API_KEY. + */ + consumerId?: string | null; + /** + * End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check. + */ + endTime?: string | null; + /** + * DO NOT USE. This is an experimental field. + */ + importance?: string | null; + /** + * Labels describing the operation. Only the following labels are allowed: - Labels describing monitored resources as defined in the service configuration. - Default labels of metric values. When specified, labels defined in the metric value override these default. - The following labels defined by Google Cloud Platform: - `cloud.googleapis.com/location` describing the location where the operation happened, - `servicecontrol.googleapis.com/user_agent` describing the user agent of the API request, - `servicecontrol.googleapis.com/service_agent` describing the service used to handle the API request (e.g. ESP), - `servicecontrol.googleapis.com/platform` describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine. + */ + labels?: {[key: string]: string} | null; + /** + * Represents information to be logged. + */ + logEntries?: Schema$LogEntry[]; + /** + * Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error. + */ + metricValueSets?: Schema$MetricValueSet[]; + /** + * Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details. + */ + operationId?: string | null; + /** + * Fully qualified name of the operation. Reserved for future use. + */ + operationName?: string | null; + /** + * Represents the properties needed for quota check. Applicable only if this operation is for a quota check request. If this is not specified, no quota check will be performed. + */ + quotaProperties?: Schema$QuotaProperties; + /** + * The resources that are involved in the operation. The maximum supported number of entries in this field is 100. + */ + resources?: Schema$ResourceInfo[]; + /** + * Required. Start time of the operation. + */ + startTime?: string | null; + /** + * Unimplemented. A list of Cloud Trace spans. The span names shall contain the id of the destination project which can be either the produce or the consumer project. + */ + traceSpans?: Schema$TraceSpan[]; + /** + * User defined labels for the resource that this operation is associated with. Only a combination of 1000 user labels per consumer project are allowed. + */ + userLabels?: {[key: string]: string} | null; + } export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1Instance { /** * consumer_defined_name is the name that is set by the consumer. On the other hand Name field represents system-assigned id of an instance so consumers are not necessarily aware of it. consumer_defined_name is used for notification/UI purposes for consumer to recognize their instances. @@ -302,6 +486,71 @@ export namespace file_v1beta1 { */ tier?: string | null; } + /** + * A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. + */ + export interface Schema$HttpRequest { + /** + * The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted. + */ + cacheFillBytes?: string | null; + /** + * Whether or not an entity was served from cache (with or without validation). + */ + cacheHit?: boolean | null; + /** + * Whether or not a cache lookup was attempted. + */ + cacheLookup?: boolean | null; + /** + * Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True. + */ + cacheValidatedWithOriginServer?: boolean | null; + /** + * The request processing latency on the server, from the time the request was received until the response was sent. + */ + latency?: string | null; + /** + * Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket" + */ + protocol?: string | null; + /** + * The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + */ + referer?: string | null; + /** + * The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `"192.168.1.1"`, `"FE80::0202:B3FF:FE1E:8329"`. + */ + remoteIp?: string | null; + /** + * The request method. Examples: `"GET"`, `"HEAD"`, `"PUT"`, `"POST"`. + */ + requestMethod?: string | null; + /** + * The size of the HTTP request message in bytes, including the request headers and the request body. + */ + requestSize?: string | null; + /** + * The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: `"http://example.com/some/info?color=red"`. + */ + requestUrl?: string | null; + /** + * The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body. + */ + responseSize?: string | null; + /** + * The IP address (IPv4 or IPv6) of the origin server that the request was sent to. + */ + serverIp?: string | null; + /** + * The response code indicating the status of the response. Examples: 200, 404. + */ + status?: number | null; + /** + * The user agent sent by the client. Example: `"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)"`. + */ + userAgent?: string | null; + } /** * A Cloud Filestore instance. */ @@ -347,6 +596,23 @@ export namespace file_v1beta1 { */ tier?: string | null; } + /** + * Describing buckets with constant width. + */ + export interface Schema$LinearBuckets { + /** + * The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details. + */ + numFiniteBuckets?: number | null; + /** + * The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. + */ + offset?: number | null; + /** + * The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. Must be strictly positive. + */ + width?: number | null; + } /** * ListInstancesResponse is the result of ListInstancesRequest. */ @@ -415,6 +681,168 @@ export namespace file_v1beta1 { */ name?: string | null; } + /** + * An individual log entry. + */ + export interface Schema$LogEntry { + /** + * Optional. Information about the HTTP request associated with this log entry, if applicable. + */ + httpRequest?: Schema$HttpRequest; + /** + * A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operation_id. + */ + insertId?: string | null; + /** + * A set of user-defined (key, value) data that provides additional information about the log entry. + */ + labels?: {[key: string]: string} | null; + /** + * Required. The log to which this log entry belongs. Examples: `"syslog"`, `"book_log"`. + */ + name?: string | null; + /** + * Optional. Information about an operation associated with the log entry, if applicable. + */ + operation?: Schema$LogEntryOperation; + /** + * The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is AuditLog. + */ + protoPayload?: {[key: string]: any} | null; + /** + * The severity of the log entry. The default value is `LogSeverity.DEFAULT`. + */ + severity?: string | null; + /** + * Optional. Source code location information associated with the log entry, if any. + */ + sourceLocation?: Schema$LogEntrySourceLocation; + /** + * The log entry payload, represented as a structure that is expressed as a JSON object. + */ + structPayload?: {[key: string]: any} | null; + /** + * The log entry payload, represented as a Unicode string (UTF-8). + */ + textPayload?: string | null; + /** + * The time the event described by the log entry occurred. If omitted, defaults to operation start time. + */ + timestamp?: string | null; + /** + * Optional. Resource name of the trace associated with the log entry, if any. If this field contains a relative resource name, you can assume the name is relative to `//tracing.googleapis.com`. Example: `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824` + */ + trace?: string | null; + } + /** + * Additional information about a potentially long-running operation with which a log entry is associated. + */ + export interface Schema$LogEntryOperation { + /** + * Optional. Set this to True if this is the first log entry in the operation. + */ + first?: boolean | null; + /** + * Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation. + */ + id?: string | null; + /** + * Optional. Set this to True if this is the last log entry in the operation. + */ + last?: boolean | null; + /** + * Optional. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `"MyDivision.MyBigCompany.com"`, `"github.com/MyProject/MyApplication"`. + */ + producer?: string | null; + } + /** + * Additional information about the source code location that produced the log entry. + */ + export interface Schema$LogEntrySourceLocation { + /** + * Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name. + */ + file?: string | null; + /** + * Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python). + */ + function?: string | null; + /** + * Optional. Line within the source file. 1-based; 0 indicates no line number available. + */ + line?: string | null; + } + /** + * Represents a single metric value. + */ + export interface Schema$MetricValue { + /** + * A boolean value. + */ + boolValue?: boolean | null; + /** + * A distribution value. + */ + distributionValue?: Schema$Distribution; + /** + * A double precision floating point value. + */ + doubleValue?: number | null; + /** + * The end of the time period over which this metric value's measurement applies. + */ + endTime?: string | null; + /** + * A signed 64-bit integer value. + */ + int64Value?: string | null; + /** + * The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship. Note that this map must not contain monitored resource labels. + */ + labels?: {[key: string]: string} | null; + /** + * A money value. + */ + moneyValue?: Schema$Money; + /** + * The start of the time period over which this metric value's measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details. + */ + startTime?: string | null; + /** + * A text string value. + */ + stringValue?: string | null; + } + /** + * Represents a set of metric values in the same metric. Each metric value in the set should have a unique combination of start time, end time, and label values. + */ + export interface Schema$MetricValueSet { + /** + * The metric name defined in the service configuration. + */ + metricName?: string | null; + /** + * The values in this metric. + */ + metricValues?: Schema$MetricValue[]; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$Money { + /** + * The 3-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + */ + nanos?: number | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: string | null; + } /** * Network configuration for the instance. */ @@ -494,6 +922,49 @@ export namespace file_v1beta1 { */ verb?: string | null; } + /** + * Represents the properties needed for quota operations. + */ + export interface Schema$QuotaProperties { + /** + * Quota mode for this operation. + */ + quotaMode?: string | null; + } + /** + * Request message for the Report method. + */ + export interface Schema$ReportRequest { + /** + * Operations to be reported. Typically the service should report one operation per request. Putting multiple operations into a single request is allowed, but should be used only when multiple operations are natually available at the time of the report. There is no limit on the number of operations in the same ReportRequest, however the ReportRequest size should be no larger than 1MB. See ReportResponse.report_errors for partial failure behavior. + */ + operations?: Schema$GoogleApiServicecontrolV1Operation[]; + /** + * Specifies which version of service config should be used to process the request. If unspecified or no matching version can be found, the latest one will be used. + */ + serviceConfigId?: string | null; + /** + * The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name. + */ + serviceName?: string | null; + } + /** + * Describes a resource associated with this operation. + */ + export interface Schema$ResourceInfo { + /** + * The identifier of the parent of this resource instance. Must be in one of the following formats: - “projects/<project-id or project-number>” - “folders/<folder-id>” - “organizations/<organization-id>” + */ + resourceContainer?: string | null; + /** + * The location of the resource. If not empty, the resource will be checked against location policy. The value must be a valid zone, region or multiregion. For example: "europe-west4" or "northamerica-northeast1-a" + */ + resourceLocation?: string | null; + /** + * Name of the resource. This is used for auditing purposes. + */ + resourceName?: string | null; + } /** * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ @@ -511,6 +982,68 @@ export namespace file_v1beta1 { */ message?: string | null; } + /** + * A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous&mdash;there may be gaps or overlaps between spans in a trace. + */ + export interface Schema$TraceSpan { + /** + * A set of attributes on the span. You can have up to 32 attributes per span. + */ + attributes?: Schema$Attributes; + /** + * An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. + */ + childSpanCount?: number | null; + /** + * A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces. + */ + displayName?: Schema$TruncatableString; + /** + * The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. + */ + endTime?: string | null; + /** + * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. + */ + name?: string | null; + /** + * The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty. + */ + parentSpanId?: string | null; + /** + * (Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information. + */ + sameProcessAsParentSpan?: boolean | null; + /** + * The [SPAN_ID] portion of the span's resource name. + */ + spanId?: string | null; + /** + * Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call. + */ + spanKind?: string | null; + /** + * The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. + */ + startTime?: string | null; + /** + * An optional final status for this span. + */ + status?: Schema$Status; + } + /** + * Represents a string that might be shortened to a specified length. + */ + export interface Schema$TruncatableString { + /** + * The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + */ + truncatedByteCount?: number | null; + /** + * The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + */ + value?: string | null; + } export class Resource$Projects { context: APIRequestContext; diff --git a/src/apis/firebase/v1beta1.ts b/src/apis/firebase/v1beta1.ts index 95886eec83..a9b14d9899 100644 --- a/src/apis/firebase/v1beta1.ts +++ b/src/apis/firebase/v1beta1.ts @@ -630,7 +630,7 @@ export namespace firebase_v1beta1 { */ locationId?: string | null; /** - * The unique Google-assigned identifier of the Google Analytics web stream associated with the Firebase Web App. Firebase SDKs use this ID to interact with Google Analytics APIs. <br> <br>This field is only present if the App is linked to a web stream in a Google Analytics App + Web property. Learn more about this ID and Google Analytics web streams in the [Analytics documentation](https://support.google.com/analytics/topic/9303475). <br> <br>To generate a `measurementId` and link the Web App with a Google Analytics web stream, call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics). + * This field will no longer be provided here. Instead, use `GetAnalyticsDetails` */ measurementId?: string | null; /** diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index e6db56151c..230ca8e92e 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -280,9 +280,6 @@ export namespace firebasehosting_v1beta1 { */ nextPageToken?: string | null; } - /** - * The response when listing Releases. - */ export interface Schema$ListReleasesResponse { /** * If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.versions.files/list) call to continue with the next set of releases. @@ -293,9 +290,6 @@ export namespace firebasehosting_v1beta1 { */ releases?: Schema$Release[]; } - /** - * The response when listing a Version's Files.. - */ export interface Schema$ListVersionFilesResponse { /** * The list path/hashes in the specified version. @@ -306,9 +300,6 @@ export namespace firebasehosting_v1beta1 { */ nextPageToken?: string | null; } - /** - * The response when listing Versions. - */ export interface Schema$ListVersionsResponse { /** * The pagination token, if more results exist @@ -353,9 +344,6 @@ export namespace firebasehosting_v1beta1 { */ files?: {[key: string]: string} | null; } - /** - * The response to a PopulateVersionFilesRequest. - */ export interface Schema$PopulateVersionFilesResponse { /** * The content hashes of the specified files that need to be uploaded to the specified endpoint. diff --git a/src/apis/gamesManagement/v1management.ts b/src/apis/gamesManagement/v1management.ts index 49ecdea2aa..20f206b8f9 100644 --- a/src/apis/gamesManagement/v1management.ts +++ b/src/apis/gamesManagement/v1management.ts @@ -39,9 +39,21 @@ export namespace gamesManagement_v1management { interface StandardParameters { /** - * Data format for the response. + * 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. */ @@ -59,19 +71,23 @@ export namespace gamesManagement_v1management { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * 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; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). */ - userIp?: string; + upload_protocol?: string; } /** - * Google Play Game Services Management API + * Google Play Game Management * - * The Management API for Google Play Game Services. + * The Google Play Game Management API allows developers to manage resources from the Google Play Game service. * * @example * const {google} = require('googleapis'); @@ -89,9 +105,7 @@ export namespace gamesManagement_v1management { applications: Resource$Applications; events: Resource$Events; players: Resource$Players; - rooms: Resource$Rooms; scores: Resource$Scores; - turnBasedMatches: Resource$Turnbasedmatches; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -103,18 +117,16 @@ export namespace gamesManagement_v1management { this.applications = new Resource$Applications(this.context); this.events = new Resource$Events(this.context); this.players = new Resource$Players(this.context); - this.rooms = new Resource$Rooms(this.context); this.scores = new Resource$Scores(this.context); - this.turnBasedMatches = new Resource$Turnbasedmatches(this.context); } } /** - * This is a JSON template for achievement reset all response. + * Achievement reset all response. */ export interface Schema$AchievementResetAllResponse { /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetAllResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#achievementResetAllResponse`. */ kind?: string | null; /** @@ -122,25 +134,22 @@ export namespace gamesManagement_v1management { */ results?: Schema$AchievementResetResponse[]; } - /** - * This is a JSON template for multiple achievements reset all request. - */ export interface Schema$AchievementResetMultipleForAllRequest { /** * The IDs of achievements to reset. */ achievement_ids?: string[] | null; /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetMultipleForAllRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#achievementResetMultipleForAllRequest`. */ kind?: string | null; } /** - * This is a JSON template for an achievement reset response. + * An achievement reset response. */ export interface Schema$AchievementResetResponse { /** - * The current state of the achievement. This is the same as the initial state of the achievement. Possible values are: - "HIDDEN"- Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. + * The current state of the achievement. This is the same as the initial state of the achievement. <br/>Possible values are: <ul> <li>"`HIDDEN`"- Achievement is hidden.</li> <li>"`REVEALED`" - Achievement is revealed.</li> <li>"`UNLOCKED`" - Achievement is unlocked.</li> </ul> */ currentState?: string | null; /** @@ -148,7 +157,7 @@ export namespace gamesManagement_v1management { */ definitionId?: string | null; /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#achievementResetResponse`. */ kind?: string | null; /** @@ -157,7 +166,7 @@ export namespace gamesManagement_v1management { updateOccurred?: boolean | null; } /** - * This is a JSON template for multiple events reset all request. + * Multiple events reset all request. */ export interface Schema$EventsResetMultipleForAllRequest { /** @@ -165,25 +174,12 @@ export namespace gamesManagement_v1management { */ event_ids?: string[] | null; /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#eventsResetMultipleForAllRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#eventsResetMultipleForAllRequest`. */ kind?: string | null; } /** - * This is a JSON template for metadata about a player playing a game with the currently authenticated user. - */ - export interface Schema$GamesPlayedResource { - /** - * True if the player was auto-matched with the currently authenticated user. - */ - autoMatched?: boolean | null; - /** - * The last time the player played the game in milliseconds since the epoch in UTC. - */ - timeMillis?: string | null; - } - /** - * This is a JSON template for 1P/3P metadata about the player's experience. + * 1P/3P metadata about the player's experience. */ export interface Schema$GamesPlayerExperienceInfoResource { /** @@ -204,7 +200,7 @@ export namespace gamesManagement_v1management { nextLevel?: Schema$GamesPlayerLevelResource; } /** - * This is a JSON template for 1P/3P metadata about a user's level. + * 1P/3P metadata about a user's level. */ export interface Schema$GamesPlayerLevelResource { /** @@ -221,24 +217,24 @@ export namespace gamesManagement_v1management { minExperiencePoints?: string | null; } /** - * This is a JSON template for the HiddenPlayer resource. + * The HiddenPlayer resource. */ export interface Schema$HiddenPlayer { /** - * The time this player was hidden. + * Output only. The time this player was hidden. */ hiddenTimeMillis?: string | null; /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayer. + * Output only. Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#hiddenPlayer`. */ kind?: string | null; /** - * The player information. + * Output only. The player information. */ player?: Schema$Player; } /** - * This is a JSON template for a list of hidden players. + * A list of hidden players. */ export interface Schema$HiddenPlayerList { /** @@ -246,7 +242,7 @@ export namespace gamesManagement_v1management { */ items?: Schema$HiddenPlayer[]; /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#hiddenPlayerList. + * Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#hiddenPlayerList`. */ kind?: string | null; /** @@ -255,7 +251,7 @@ export namespace gamesManagement_v1management { nextPageToken?: string | null; } /** - * This is a JSON template for a Player resource. + * A Player resource. */ export interface Schema$Player { /** @@ -279,17 +275,9 @@ export namespace gamesManagement_v1management { */ experienceInfo?: Schema$GamesPlayerExperienceInfoResource; /** - * The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. - */ - friendStatus?: string | null; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#player. + * Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#player`. */ kind?: string | null; - /** - * Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. - */ - lastPlayedWith?: Schema$GamesPlayedResource; /** * An object representation of the individual components of the player's name. For some players, these fields may not be present. */ @@ -312,11 +300,11 @@ export namespace gamesManagement_v1management { title?: string | null; } /** - * This is a JSON template for a list of leaderboard reset resources. + * A list of leaderboard reset resources. */ export interface Schema$PlayerScoreResetAllResponse { /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#playerScoreResetAllResponse`. */ kind?: string | null; /** @@ -325,7 +313,7 @@ export namespace gamesManagement_v1management { results?: Schema$PlayerScoreResetResponse[]; } /** - * This is a JSON template for a list of reset leaderboard entry resources. + * A list of reset leaderboard entry resources. */ export interface Schema$PlayerScoreResetResponse { /** @@ -333,30 +321,27 @@ export namespace gamesManagement_v1management { */ definitionId?: string | null; /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#playerScoreResetResponse. + * Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#playerScoreResetResponse`. */ kind?: string | null; /** - * The time spans of the updated score. Possible values are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The score is a weekly score. - "DAILY" - The score is a daily score. + * The time spans of the updated score. <br/>Possible values are: <ul> <li>"`ALL_TIME`" - The score is an all-time score.</li> <li>"`WEEKLY`" - The score is a weekly score.</li> <li>"`DAILY`" - The score is a daily score.</li> </ul> */ resetScoreTimeSpans?: string[] | null; } /** - * This is a JSON template for profile settings + * Profile settings */ export interface Schema$ProfileSettings { /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#profileSettings. + * Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#profileSettings`. */ kind?: string | null; profileVisible?: boolean | null; } - /** - * This is a JSON template for multiple scores reset all request. - */ export interface Schema$ScoresResetMultipleForAllRequest { /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#scoresResetMultipleForAllRequest. + * Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#scoresResetMultipleForAllRequest`. */ kind?: string | null; /** @@ -535,7 +520,7 @@ export namespace gamesManagement_v1management { * @alias gamesManagement.achievements.resetAll * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @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 @@ -647,7 +632,7 @@ export namespace gamesManagement_v1management { * @alias gamesManagement.achievements.resetAllForAllPlayers * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @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 @@ -1018,7 +1003,9 @@ export namespace gamesManagement_v1management { * const res = await gamesManagement.applications.listHidden({ * // The application ID from the Google Play developer console. * applicationId: 'placeholder-value', - * // The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults. + * // The maximum number of player resources to return in the response, used for + * // paging. For any response, the actual number of player resources returned + * // may be less than the specified `maxResults`. * maxResults: 'placeholder-value', * // The token returned by the previous request. * pageToken: 'placeholder-value', @@ -1043,7 +1030,7 @@ export namespace gamesManagement_v1management { * * @param {object} params Parameters for request * @param {string} params.applicationId The application ID from the Google Play developer console. - * @param {integer=} params.maxResults The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults. + * @param {integer=} params.maxResults The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified `maxResults`. * @param {string=} params.pageToken The token returned by the previous request. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1124,7 +1111,7 @@ export namespace gamesManagement_v1management { */ applicationId?: string; /** - * The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults. + * The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified `maxResults`. */ maxResults?: number; /** @@ -1282,7 +1269,7 @@ export namespace gamesManagement_v1management { * @alias gamesManagement.events.resetAll * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @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 @@ -1384,7 +1371,7 @@ export namespace gamesManagement_v1management { * @alias gamesManagement.events.resetAllForAllPlayers * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @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 @@ -1752,7 +1739,8 @@ export namespace gamesManagement_v1management { * const res = await gamesManagement.players.hide({ * // The application ID from the Google Play developer console. * applicationId: 'placeholder-value', - * // A player ID. A value of me may be used in place of the authenticated player's ID. + * // A player ID. A value of `me` may be used in place of the + * // authenticated player's ID. * playerId: 'placeholder-value', * }); * console.log(res.data); @@ -1768,7 +1756,7 @@ export namespace gamesManagement_v1management { * * @param {object} params Parameters for request * @param {string} params.applicationId The application ID from the Google Play developer console. - * @param {string} params.playerId A player ID. A value of me may be used in place of the authenticated player's ID. + * @param {string} params.playerId A player ID. A value of `me` may be used in place of the authenticated player's ID. * @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 @@ -1861,7 +1849,8 @@ export namespace gamesManagement_v1management { * const res = await gamesManagement.players.unhide({ * // The application ID from the Google Play developer console. * applicationId: 'placeholder-value', - * // A player ID. A value of me may be used in place of the authenticated player's ID. + * // A player ID. A value of `me` may be used in place of the + * // authenticated player's ID. * playerId: 'placeholder-value', * }); * console.log(res.data); @@ -1877,7 +1866,7 @@ export namespace gamesManagement_v1management { * * @param {object} params Parameters for request * @param {string} params.applicationId The application ID from the Google Play developer console. - * @param {string} params.playerId A player ID. A value of me may be used in place of the authenticated player's ID. + * @param {string} params.playerId A player ID. A value of `me` may be used in place of the authenticated player's ID. * @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 @@ -1953,7 +1942,7 @@ export namespace gamesManagement_v1management { */ applicationId?: string; /** - * A player ID. A value of me may be used in place of the authenticated player's ID. + * A player ID. A value of `me` may be used in place of the authenticated player's ID. */ playerId?: string; } @@ -1968,236 +1957,11 @@ export namespace gamesManagement_v1management { */ applicationId?: string; /** - * A player ID. A value of me may be used in place of the authenticated player's ID. + * A player ID. A value of `me` may be used in place of the authenticated player's ID. */ playerId?: string; } - export class Resource$Rooms { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * gamesManagement.rooms.reset - * @desc Reset all rooms for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/gamesManagement.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const gamesManagement = google.gamesManagement('v1management'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/games'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await gamesManagement.rooms.reset({}); - * console.log(res.data); - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias gamesManagement.rooms.reset - * @memberOf! () - * - * @param {object=} params Parameters for request - * @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 - */ - reset( - params?: Params$Resource$Rooms$Reset, - options?: MethodOptions - ): GaxiosPromise; - reset( - params: Params$Resource$Rooms$Reset, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reset( - params: Params$Resource$Rooms$Reset, - callback: BodyResponseCallback - ): void; - reset(callback: BodyResponseCallback): void; - reset( - paramsOrCallback?: - | Params$Resource$Rooms$Reset - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Rooms$Reset; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Rooms$Reset; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/games/v1management/rooms/reset').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesManagement.rooms.resetForAllPlayers - * @desc Deletes rooms where the only room participants are from whitelisted tester accounts for your application. This method is only available to user accounts for your developer console. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/gamesManagement.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const gamesManagement = google.gamesManagement('v1management'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/games'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await gamesManagement.rooms.resetForAllPlayers({}); - * console.log(res.data); - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias gamesManagement.rooms.resetForAllPlayers - * @memberOf! () - * - * @param {object=} params Parameters for request - * @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 - */ - resetForAllPlayers( - params?: Params$Resource$Rooms$Resetforallplayers, - options?: MethodOptions - ): GaxiosPromise; - resetForAllPlayers( - params: Params$Resource$Rooms$Resetforallplayers, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - resetForAllPlayers( - params: Params$Resource$Rooms$Resetforallplayers, - callback: BodyResponseCallback - ): void; - resetForAllPlayers(callback: BodyResponseCallback): void; - resetForAllPlayers( - paramsOrCallback?: - | Params$Resource$Rooms$Resetforallplayers - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Rooms$Resetforallplayers; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Rooms$Resetforallplayers; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1management/rooms/resetForAllPlayers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Rooms$Reset extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - } - export interface Params$Resource$Rooms$Resetforallplayers - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - } - export class Resource$Scores { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -2367,7 +2131,7 @@ export namespace gamesManagement_v1management { * @alias gamesManagement.scores.resetAll * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @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 @@ -2478,7 +2242,7 @@ export namespace gamesManagement_v1management { * @alias gamesManagement.scores.resetAllForAllPlayers * @memberOf! () * - * @param {object=} params Parameters for request + * @param {object} params Parameters for request * @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 @@ -2810,231 +2574,4 @@ export namespace gamesManagement_v1management { */ requestBody?: Schema$ScoresResetMultipleForAllRequest; } - - export class Resource$Turnbasedmatches { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * gamesManagement.turnBasedMatches.reset - * @desc Reset all turn-based match data for a user. This method is only accessible to whitelisted tester accounts for your application. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/gamesManagement.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const gamesManagement = google.gamesManagement('v1management'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/games'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await gamesManagement.turnBasedMatches.reset({}); - * console.log(res.data); - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias gamesManagement.turnBasedMatches.reset - * @memberOf! () - * - * @param {object=} params Parameters for request - * @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 - */ - reset( - params?: Params$Resource$Turnbasedmatches$Reset, - options?: MethodOptions - ): GaxiosPromise; - reset( - params: Params$Resource$Turnbasedmatches$Reset, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reset( - params: Params$Resource$Turnbasedmatches$Reset, - callback: BodyResponseCallback - ): void; - reset(callback: BodyResponseCallback): void; - reset( - paramsOrCallback?: - | Params$Resource$Turnbasedmatches$Reset - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Turnbasedmatches$Reset; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Turnbasedmatches$Reset; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1management/turnbasedmatches/reset' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesManagement.turnBasedMatches.resetForAllPlayers - * @desc Deletes turn-based matches where the only match participants are from whitelisted tester accounts for your application. This method is only available to user accounts for your developer console. - * @example - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/gamesManagement.googleapis.com - * // - Login into gcloud by running: - * // `$ gcloud auth application-default login` - * // - Install the npm module by running: - * // `$ npm install googleapis` - * - * const {google} = require('googleapis'); - * const gamesManagement = google.gamesManagement('v1management'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/games'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options('auth', authClient); - * - * // Do the magic - * const res = await gamesManagement.turnBasedMatches.resetForAllPlayers({}); - * console.log(res.data); - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * @alias gamesManagement.turnBasedMatches.resetForAllPlayers - * @memberOf! () - * - * @param {object=} params Parameters for request - * @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 - */ - resetForAllPlayers( - params?: Params$Resource$Turnbasedmatches$Resetforallplayers, - options?: MethodOptions - ): GaxiosPromise; - resetForAllPlayers( - params: Params$Resource$Turnbasedmatches$Resetforallplayers, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - resetForAllPlayers( - params: Params$Resource$Turnbasedmatches$Resetforallplayers, - callback: BodyResponseCallback - ): void; - resetForAllPlayers(callback: BodyResponseCallback): void; - resetForAllPlayers( - paramsOrCallback?: - | Params$Resource$Turnbasedmatches$Resetforallplayers - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Turnbasedmatches$Resetforallplayers; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Turnbasedmatches$Resetforallplayers; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/games/v1management/turnbasedmatches/resetForAllPlayers' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Turnbasedmatches$Reset - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - } - export interface Params$Resource$Turnbasedmatches$Resetforallplayers - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - } } diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index cf33eb6253..93bb503cba 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -470,7 +470,7 @@ export namespace jobs_v3 { */ export interface Schema$CustomAttribute { /** - * Optional. If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false. + * Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. */ filterable?: boolean | null; /** diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index fb6482a6f0..f963706068 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -6524,7 +6524,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.timeSeries.query - * @desc Queries time series using the time series query language. This method does not require a Workspace. + * @desc Queries time series using Monitoring Query Language. This method does not require a Workspace. * @example * // Before running the sample: * // - Enable the API at: diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index 9c7b4a76ac..8b361edd41 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -3574,7 +3574,7 @@ export namespace people_v1 { * // Do the magic * const res = await people.people.connections.list({ * // Optional. The number of connections to include in the response. Valid values are - * // between 1 and 2000, inclusive. Defaults to 100 if not set or set to 0. + * // between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. * pageSize: 'placeholder-value', * // Optional. A page token, received from a previous `ListConnections` call. * // Provide this to retrieve the subsequent page. @@ -3654,7 +3654,7 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize Optional. The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100 if not set or set to 0. + * @param {integer=} params.pageSize Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. * @param {string=} params.pageToken Optional. A page token, received from a previous `ListConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnections` must match the call that provided the page token. * @param {string=} params.personFields Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * residences * sipAddresses * skills * urls * userDefined * @param {string=} params.requestMask.includeField Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. @@ -3739,7 +3739,7 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100 if not set or set to 0. + * Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0. */ pageSize?: number; /** diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index a0a7de1a87..cc5d69d5b8 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -409,7 +409,7 @@ export namespace pubsub_v1 { */ ackId?: string | null; /** - * Delivery attempt counter is 1 + (the sum of number of NACKs and number of ack_deadline exceeds) for this message. A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library. The first delivery of a given message will have this value as 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. + * The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber. More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message. A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library. Upon the first delivery of a given message, `delivery_attempt` will have a value of 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0. */ deliveryAttempt?: number | null; /** diff --git a/src/apis/secretmanager/v1.ts b/src/apis/secretmanager/v1.ts index 7d56a4b96c..a7df627687 100644 --- a/src/apis/secretmanager/v1.ts +++ b/src/apis/secretmanager/v1.ts @@ -170,7 +170,7 @@ export namespace secretmanager_v1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -292,7 +292,7 @@ export namespace secretmanager_v1 { name?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -308,7 +308,7 @@ export namespace secretmanager_v1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -356,7 +356,7 @@ export namespace secretmanager_v1 { replication?: Schema$Replication; } /** - * A secret payload resource in the Secret Manager API. This contains the sensitive secret data that is associated with a SecretVersion. + * A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion. */ export interface Schema$SecretPayload { /** @@ -1251,6 +1251,10 @@ export namespace secretmanager_v1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -1276,7 +1280,7 @@ export namespace secretmanager_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1928,7 +1932,7 @@ export namespace secretmanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/secretmanager/v1beta1.ts b/src/apis/secretmanager/v1beta1.ts index 421127f591..ee157a500e 100644 --- a/src/apis/secretmanager/v1beta1.ts +++ b/src/apis/secretmanager/v1beta1.ts @@ -170,7 +170,7 @@ export namespace secretmanager_v1beta1 { */ export interface Schema$Binding { /** - * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. + * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Schema$Expr; /** @@ -292,7 +292,7 @@ export namespace secretmanager_v1beta1 { name?: string | null; } /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -308,7 +308,7 @@ export namespace secretmanager_v1beta1 { */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number | null; } @@ -1251,6 +1251,10 @@ export namespace secretmanager_v1beta1 { * // Requests for policies with any conditional bindings must specify version 3. * // Policies without any conditional bindings may specify any valid value or * // leave the field unset. + * // + * // To learn which resources support conditions in their IAM policies, see the + * // [IAM + * // documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * 'options.requestedPolicyVersion': 'placeholder-value', * // REQUIRED: The resource for which the policy is being requested. * // See the operation documentation for the appropriate value for this field. @@ -1276,7 +1280,7 @@ export namespace secretmanager_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1928,7 +1932,7 @@ export namespace secretmanager_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ 'options.requestedPolicyVersion'?: number; /** diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 5abb755807..10bbcf5f99 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -300,7 +300,7 @@ export namespace testing_v1 { */ tags?: string[] | null; /** - * URL of a thumbnail image of the device. + * URL of a thumbnail image (photo) of the device. e.g. https://lh3.googleusercontent.com/90WcauuJiCYABEl8U0lcZeuS5STUbf2yW... */ thumbnailUrl?: string | null; } @@ -691,7 +691,7 @@ export namespace testing_v1 { iosDevices?: Schema$IosDevice[]; } /** - * A description of an iOS device tests may be run on. Next tag: 12 + * A description of an iOS device tests may be run on. Next tag: 13 */ export interface Schema$IosModel { /** diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index 7c0b2aee63..73d4513098 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -226,7 +226,7 @@ export namespace toolresults_v1beta3 { testTimeout?: Schema$Duration; } /** - * Test Loops are tests that can be launched by the app itself, determining when to run by listening for an intent. go/ftl-games-dd + * Test Loops are tests that can be launched by the app itself, determining when to run by listening for an intent. */ export interface Schema$AndroidTestLoop {} /** @@ -572,6 +572,10 @@ export namespace toolresults_v1beta3 { * A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set */ name?: string | null; + /** + * The platform of the test history. - In response: always set. Returns the platform of the last execution if unknown. + */ + testPlatform?: string | null; } /** * An image, with a link to the main image and a thumbnail. @@ -652,6 +656,66 @@ export namespace toolresults_v1beta3 { */ stackTrace?: Schema$StackTrace; } + /** + * iOS app information + */ + export interface Schema$IosAppInfo { + /** + * The name of the app. Required + */ + name?: string | null; + } + /** + * A Robo test for an iOS application. + */ + export interface Schema$IosRoboTest {} + /** + * A iOS mobile test specification + */ + export interface Schema$IosTest { + /** + * Information about the application under test. + */ + iosAppInfo?: Schema$IosAppInfo; + /** + * An iOS Robo test. + */ + iosRoboTest?: Schema$IosRoboTest; + /** + * An iOS test loop. + */ + iosTestLoop?: Schema$IosTestLoop; + /** + * An iOS XCTest. + */ + iosXcTest?: Schema$IosXcTest; + /** + * Max time a test is allowed to run before it is automatically cancelled. + */ + testTimeout?: Schema$Duration; + } + /** + * A game loop test of an iOS application. + */ + export interface Schema$IosTestLoop { + /** + * Bundle ID of the app. + */ + bundleId?: string | null; + } + /** + * A test of an iOS application that uses the XCTest framework. + */ + export interface Schema$IosXcTest { + /** + * Bundle ID of the app. + */ + bundleId?: string | null; + /** + * Xcode version that the test was run with. + */ + xcodeVersion?: string | null; + } /** * Failed to find the launcher activity of an app. */ @@ -1223,6 +1287,10 @@ export namespace toolresults_v1beta3 { * An Android mobile test execution specification. */ androidTest?: Schema$AndroidTest; + /** + * An iOS mobile test execution specification. + */ + iosTest?: Schema$IosTest; } /** * A stacktrace. @@ -3068,7 +3136,8 @@ export namespace toolresults_v1beta3 { * // { * // "displayName": "my_displayName", * // "historyId": "my_historyId", - * // "name": "my_name" + * // "name": "my_name", + * // "testPlatform": "my_testPlatform" * // } * }, * }); @@ -3078,7 +3147,8 @@ export namespace toolresults_v1beta3 { * // { * // "displayName": "my_displayName", * // "historyId": "my_historyId", - * // "name": "my_name" + * // "name": "my_name", + * // "testPlatform": "my_testPlatform" * // } * } * @@ -3198,7 +3268,8 @@ export namespace toolresults_v1beta3 { * // { * // "displayName": "my_displayName", * // "historyId": "my_historyId", - * // "name": "my_name" + * // "name": "my_name", + * // "testPlatform": "my_testPlatform" * // } * } * diff --git a/synth.metadata b/synth.metadata index 6e38fb0164..ee3883e5b0 100644 --- a/synth.metadata +++ b/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/google-api-nodejs-client.git", - "sha": "9d612d7249acdbacdc3092fb01519b769aa053cd" + "sha": "2dfda8fc41b8d97acac11ad6f099a1cdbfd64a9c" } }, {