mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-15 14:01:49 +01:00
update all json files
This commit is contained in:
Sebastian Thiel
@@ -1,13 +1,4 @@
|
||||
{
|
||||
"auth": {
|
||||
"oauth2": {
|
||||
"scopes": {
|
||||
"https://www.googleapis.com/auth/xapi.zoo": {
|
||||
"description": "Test scope for access to the Zoo service"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"basePath": "",
|
||||
"baseUrl": "https://abusiveexperiencereport.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
@@ -22,6 +13,7 @@
|
||||
},
|
||||
"id": "abusiveexperiencereport:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://abusiveexperiencereport.mtls.googleapis.com/",
|
||||
"name": "abusiveexperiencereport",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -107,7 +99,7 @@
|
||||
"sites": {
|
||||
"methods": {
|
||||
"get": {
|
||||
"description": "Gets a summary of the abusive experience rating of a site.",
|
||||
"description": "Gets a site's Abusive Experience Report summary.",
|
||||
"flatPath": "v1/sites/{sitesId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "abusiveexperiencereport.sites.get",
|
||||
@@ -116,7 +108,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The required site name. This is the site property whose abusive\nexperiences have been reviewed, and it must be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field\nreturned by the API will lead to the verification page, prompting the user\nto go through that process before they can gain access to the Abusive\nExperience Report.",
|
||||
"description": "Required. The name of the site whose summary to get, e.g.\n`sites/http%3A%2F%2Fwww.google.com%2F`.\n\nFormat: `sites/{site}`",
|
||||
"location": "path",
|
||||
"pattern": "^sites/[^/]+$",
|
||||
"required": true,
|
||||
@@ -126,17 +118,14 @@
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "SiteSummaryResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/xapi.zoo"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"violatingSites": {
|
||||
"methods": {
|
||||
"list": {
|
||||
"description": "Lists sites with Abusive Experience Report statuses of \"Failing\".",
|
||||
"description": "Lists sites that are failing in the Abusive Experience Report.",
|
||||
"flatPath": "v1/violatingSites",
|
||||
"httpMethod": "GET",
|
||||
"id": "abusiveexperiencereport.violatingSites.list",
|
||||
@@ -145,15 +134,12 @@
|
||||
"path": "v1/violatingSites",
|
||||
"response": {
|
||||
"$ref": "ViolatingSitesResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/xapi.zoo"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190624",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://abusiveexperiencereport.googleapis.com/",
|
||||
"schemas": {
|
||||
"SiteSummaryResponse": {
|
||||
@@ -161,7 +147,7 @@
|
||||
"id": "SiteSummaryResponse",
|
||||
"properties": {
|
||||
"abusiveStatus": {
|
||||
"description": "The status of the site reviewed for the abusive experiences.",
|
||||
"description": "The site's Abusive Experience Report status.",
|
||||
"enum": [
|
||||
"UNKNOWN",
|
||||
"PASSING",
|
||||
@@ -175,12 +161,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"enforcementTime": {
|
||||
"description": "The date on which enforcement begins.",
|
||||
"description": "The time at which\n[enforcement](https://support.google.com/webtools/answer/7538608) against\nthe site began or will begin.\n\nNot set when the\nfilter_status\nis OFF.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"filterStatus": {
|
||||
"description": "The abusive experience enforcement status of the site.",
|
||||
"description": "The site's [enforcement\nstatus](https://support.google.com/webtools/answer/7538608).",
|
||||
"enum": [
|
||||
"UNKNOWN",
|
||||
"ON",
|
||||
@@ -190,24 +176,24 @@
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"N/A.",
|
||||
"Ad filtering is on.",
|
||||
"Ad filtering is off.",
|
||||
"Ad filtering is paused.",
|
||||
"Ad filtering is pending."
|
||||
"Enforcement is on.",
|
||||
"Enforcement is off.",
|
||||
"Enforcement is paused.",
|
||||
"Enforcement is pending."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"lastChangeTime": {
|
||||
"description": "The last time that the site changed status.",
|
||||
"description": "The time at which the site's status last changed.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"reportUrl": {
|
||||
"description": "A link that leads to a full abusive experience report.",
|
||||
"description": "A link to the full Abusive Experience Report for the site.\n\nNot set in\nViolatingSitesResponse.\n\nNote that you must complete the [Search Console verification\nprocess](https://support.google.com/webmasters/answer/9008080) for the site\nbefore you can access the full report.",
|
||||
"type": "string"
|
||||
},
|
||||
"reviewedSite": {
|
||||
"description": "The name of the site reviewed.",
|
||||
"description": "The name of the reviewed site, e.g. `google.com`.",
|
||||
"type": "string"
|
||||
},
|
||||
"underReview": {
|
||||
@@ -222,7 +208,7 @@
|
||||
"id": "ViolatingSitesResponse",
|
||||
"properties": {
|
||||
"violatingSites": {
|
||||
"description": "A list of summaries of violating sites.",
|
||||
"description": "The list of violating sites.",
|
||||
"items": {
|
||||
"$ref": "SiteSummaryResponse"
|
||||
},
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
"basePath": "",
|
||||
"baseUrl": "https://acceleratedmobilepageurl.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "Acceleratedmobilepageurl",
|
||||
"description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/amp/cache/",
|
||||
@@ -11,6 +12,7 @@
|
||||
},
|
||||
"id": "acceleratedmobilepageurl:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://acceleratedmobilepageurl.mtls.googleapis.com/",
|
||||
"name": "acceleratedmobilepageurl",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -113,7 +115,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190619",
|
||||
"revision": "20200409",
|
||||
"rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
|
||||
"schemas": {
|
||||
"AmpUrl": {
|
||||
|
||||
985
etc/api/accessapproval/v1/accessapproval-api.json
Normal file
985
etc/api/accessapproval/v1/accessapproval-api.json
Normal file
@@ -0,0 +1,985 @@
|
||||
{
|
||||
"auth": {
|
||||
"oauth2": {
|
||||
"scopes": {
|
||||
"https://www.googleapis.com/auth/cloud-platform": {
|
||||
"description": "View and manage your data across Google Cloud Platform services"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"basePath": "",
|
||||
"baseUrl": "https://accessapproval.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "Access Approval",
|
||||
"description": "An API for controlling access to data by Google personnel.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/access-approval/docs",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
||||
},
|
||||
"id": "accessapproval:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://accessapproval.mtls.googleapis.com/",
|
||||
"name": "accessapproval",
|
||||
"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 response.",
|
||||
"enum": [
|
||||
"json",
|
||||
"media",
|
||||
"proto"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"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",
|
||||
"type": "string"
|
||||
},
|
||||
"key": {
|
||||
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"oauth_token": {
|
||||
"description": "OAuth 2.0 token for the current user.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"prettyPrint": {
|
||||
"default": "true",
|
||||
"description": "Returns response with indentations and line breaks.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"quotaUser": {
|
||||
"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"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"protocol": "rest",
|
||||
"resources": {
|
||||
"folders": {
|
||||
"methods": {
|
||||
"deleteAccessApprovalSettings": {
|
||||
"description": "Deletes the settings associated with a project, folder, or organization.\nThis will have the effect of disabling Access Approval for the project,\nfolder, or organization, but only if all ancestors also have Access\nApproval disabled. If Access Approval is enabled at a higher level of the\nhierarchy, then Access Approval will still be enabled at this level as\nthe settings are inherited.",
|
||||
"flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "accessapproval.folders.deleteAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the AccessApprovalSettings to delete.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"getAccessApprovalSettings": {
|
||||
"description": "Gets the settings associated with a project, folder, or organization.",
|
||||
"flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
|
||||
"httpMethod": "GET",
|
||||
"id": "accessapproval.folders.getAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the AccessApprovalSettings to retrieve.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "AccessApprovalSettings"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"updateAccessApprovalSettings": {
|
||||
"description": "Updates the settings associated with a project, folder, or organization.\nSettings to update are determined by the value of field_mask.",
|
||||
"flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "accessapproval.folders.updateAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the settings. Format is one of:\n<ol>\n <li>\"projects/{project_id}/accessApprovalSettings\"</li>\n <li>\"folders/{folder_id}/accessApprovalSettings\"</li>\n <li>\"organizations/{organization_id}/accessApprovalSettings\"</li>\n<ol>",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "The update mask applies to the settings. Only the top level fields of\nAccessApprovalSettings (notification_emails & enrolled_services) are\nsupported. For each field, if it is included, the currently stored value\nwill be entirely overwritten with the value of the field passed in this\nrequest.\n\nFor the `FieldMask` definition, see\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask\nIf this field is left unset, only the notification_emails field will be\nupdated.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"request": {
|
||||
"$ref": "AccessApprovalSettings"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "AccessApprovalSettings"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"approvalRequests": {
|
||||
"methods": {
|
||||
"approve": {
|
||||
"description": "Approves a request and returns the updated ApprovalRequest.\n\nReturns NOT_FOUND if the request does not exist. Returns\nFAILED_PRECONDITION if the request exists but is not in a pending state.",
|
||||
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:approve",
|
||||
"httpMethod": "POST",
|
||||
"id": "accessapproval.folders.approvalRequests.approve",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the approval request to approve.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}:approve",
|
||||
"request": {
|
||||
"$ref": "ApproveApprovalRequestMessage"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "ApprovalRequest"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"dismiss": {
|
||||
"description": "Dismisses a request. Returns the updated ApprovalRequest.\n\nNOTE: This does not deny access to the resource if another request has been\nmade and approved. It is equivalent in effect to ignoring the request\naltogether.\n\nReturns NOT_FOUND if the request does not exist.\n\nReturns FAILED_PRECONDITION if the request exists but is not in a pending\nstate.",
|
||||
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:dismiss",
|
||||
"httpMethod": "POST",
|
||||
"id": "accessapproval.folders.approvalRequests.dismiss",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the ApprovalRequest to dismiss.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}:dismiss",
|
||||
"request": {
|
||||
"$ref": "DismissApprovalRequestMessage"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "ApprovalRequest"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Gets an approval request. Returns NOT_FOUND if the request does not exist.",
|
||||
"flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "accessapproval.folders.approvalRequests.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the approval request to retrieve.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+/approvalRequests/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "ApprovalRequest"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists approval requests associated with a project, folder, or organization.\nApproval requests can be filtered by state (pending, active, dismissed).\nThe order is reverse chronological.",
|
||||
"flatPath": "v1/folders/{foldersId}/approvalRequests",
|
||||
"httpMethod": "GET",
|
||||
"id": "accessapproval.folders.approvalRequests.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "A filter on the type of approval requests to retrieve. Must be one of the\nfollowing values:\n<ol>\n <li>[not set]: Requests that are pending or have active approvals.</li>\n <li>ALL: All requests.</li>\n <li>PENDING: Only pending requests.</li>\n <li>ACTIVE: Only active (i.e. currently approved) requests.</li>\n <li>DISMISSED: Only dismissed (including expired) requests.</li>\n</ol>",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "Requested page size.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "A token identifying the page of results to return.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The parent resource. This may be \"projects/{project_id}\",\n\"folders/{folder_id}\", or \"organizations/{organization_id}\".",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/approvalRequests",
|
||||
"response": {
|
||||
"$ref": "ListApprovalRequestsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"organizations": {
|
||||
"methods": {
|
||||
"deleteAccessApprovalSettings": {
|
||||
"description": "Deletes the settings associated with a project, folder, or organization.\nThis will have the effect of disabling Access Approval for the project,\nfolder, or organization, but only if all ancestors also have Access\nApproval disabled. If Access Approval is enabled at a higher level of the\nhierarchy, then Access Approval will still be enabled at this level as\nthe settings are inherited.",
|
||||
"flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "accessapproval.organizations.deleteAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the AccessApprovalSettings to delete.",
|
||||
"location": "path",
|
||||
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"getAccessApprovalSettings": {
|
||||
"description": "Gets the settings associated with a project, folder, or organization.",
|
||||
"flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
|
||||
"httpMethod": "GET",
|
||||
"id": "accessapproval.organizations.getAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the AccessApprovalSettings to retrieve.",
|
||||
"location": "path",
|
||||
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "AccessApprovalSettings"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"updateAccessApprovalSettings": {
|
||||
"description": "Updates the settings associated with a project, folder, or organization.\nSettings to update are determined by the value of field_mask.",
|
||||
"flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "accessapproval.organizations.updateAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the settings. Format is one of:\n<ol>\n <li>\"projects/{project_id}/accessApprovalSettings\"</li>\n <li>\"folders/{folder_id}/accessApprovalSettings\"</li>\n <li>\"organizations/{organization_id}/accessApprovalSettings\"</li>\n<ol>",
|
||||
"location": "path",
|
||||
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "The update mask applies to the settings. Only the top level fields of\nAccessApprovalSettings (notification_emails & enrolled_services) are\nsupported. For each field, if it is included, the currently stored value\nwill be entirely overwritten with the value of the field passed in this\nrequest.\n\nFor the `FieldMask` definition, see\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask\nIf this field is left unset, only the notification_emails field will be\nupdated.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"request": {
|
||||
"$ref": "AccessApprovalSettings"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "AccessApprovalSettings"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"approvalRequests": {
|
||||
"methods": {
|
||||
"approve": {
|
||||
"description": "Approves a request and returns the updated ApprovalRequest.\n\nReturns NOT_FOUND if the request does not exist. Returns\nFAILED_PRECONDITION if the request exists but is not in a pending state.",
|
||||
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:approve",
|
||||
"httpMethod": "POST",
|
||||
"id": "accessapproval.organizations.approvalRequests.approve",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the approval request to approve.",
|
||||
"location": "path",
|
||||
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}:approve",
|
||||
"request": {
|
||||
"$ref": "ApproveApprovalRequestMessage"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "ApprovalRequest"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"dismiss": {
|
||||
"description": "Dismisses a request. Returns the updated ApprovalRequest.\n\nNOTE: This does not deny access to the resource if another request has been\nmade and approved. It is equivalent in effect to ignoring the request\naltogether.\n\nReturns NOT_FOUND if the request does not exist.\n\nReturns FAILED_PRECONDITION if the request exists but is not in a pending\nstate.",
|
||||
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:dismiss",
|
||||
"httpMethod": "POST",
|
||||
"id": "accessapproval.organizations.approvalRequests.dismiss",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the ApprovalRequest to dismiss.",
|
||||
"location": "path",
|
||||
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}:dismiss",
|
||||
"request": {
|
||||
"$ref": "DismissApprovalRequestMessage"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "ApprovalRequest"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Gets an approval request. Returns NOT_FOUND if the request does not exist.",
|
||||
"flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "accessapproval.organizations.approvalRequests.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the approval request to retrieve.",
|
||||
"location": "path",
|
||||
"pattern": "^organizations/[^/]+/approvalRequests/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "ApprovalRequest"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists approval requests associated with a project, folder, or organization.\nApproval requests can be filtered by state (pending, active, dismissed).\nThe order is reverse chronological.",
|
||||
"flatPath": "v1/organizations/{organizationsId}/approvalRequests",
|
||||
"httpMethod": "GET",
|
||||
"id": "accessapproval.organizations.approvalRequests.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "A filter on the type of approval requests to retrieve. Must be one of the\nfollowing values:\n<ol>\n <li>[not set]: Requests that are pending or have active approvals.</li>\n <li>ALL: All requests.</li>\n <li>PENDING: Only pending requests.</li>\n <li>ACTIVE: Only active (i.e. currently approved) requests.</li>\n <li>DISMISSED: Only dismissed (including expired) requests.</li>\n</ol>",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "Requested page size.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "A token identifying the page of results to return.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The parent resource. This may be \"projects/{project_id}\",\n\"folders/{folder_id}\", or \"organizations/{organization_id}\".",
|
||||
"location": "path",
|
||||
"pattern": "^organizations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/approvalRequests",
|
||||
"response": {
|
||||
"$ref": "ListApprovalRequestsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"projects": {
|
||||
"methods": {
|
||||
"deleteAccessApprovalSettings": {
|
||||
"description": "Deletes the settings associated with a project, folder, or organization.\nThis will have the effect of disabling Access Approval for the project,\nfolder, or organization, but only if all ancestors also have Access\nApproval disabled. If Access Approval is enabled at a higher level of the\nhierarchy, then Access Approval will still be enabled at this level as\nthe settings are inherited.",
|
||||
"flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "accessapproval.projects.deleteAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the AccessApprovalSettings to delete.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"getAccessApprovalSettings": {
|
||||
"description": "Gets the settings associated with a project, folder, or organization.",
|
||||
"flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
|
||||
"httpMethod": "GET",
|
||||
"id": "accessapproval.projects.getAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the AccessApprovalSettings to retrieve.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "AccessApprovalSettings"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"updateAccessApprovalSettings": {
|
||||
"description": "Updates the settings associated with a project, folder, or organization.\nSettings to update are determined by the value of field_mask.",
|
||||
"flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "accessapproval.projects.updateAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the settings. Format is one of:\n<ol>\n <li>\"projects/{project_id}/accessApprovalSettings\"</li>\n <li>\"folders/{folder_id}/accessApprovalSettings\"</li>\n <li>\"organizations/{organization_id}/accessApprovalSettings\"</li>\n<ol>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "The update mask applies to the settings. Only the top level fields of\nAccessApprovalSettings (notification_emails & enrolled_services) are\nsupported. For each field, if it is included, the currently stored value\nwill be entirely overwritten with the value of the field passed in this\nrequest.\n\nFor the `FieldMask` definition, see\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask\nIf this field is left unset, only the notification_emails field will be\nupdated.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"request": {
|
||||
"$ref": "AccessApprovalSettings"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "AccessApprovalSettings"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"approvalRequests": {
|
||||
"methods": {
|
||||
"approve": {
|
||||
"description": "Approves a request and returns the updated ApprovalRequest.\n\nReturns NOT_FOUND if the request does not exist. Returns\nFAILED_PRECONDITION if the request exists but is not in a pending state.",
|
||||
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:approve",
|
||||
"httpMethod": "POST",
|
||||
"id": "accessapproval.projects.approvalRequests.approve",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the approval request to approve.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}:approve",
|
||||
"request": {
|
||||
"$ref": "ApproveApprovalRequestMessage"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "ApprovalRequest"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"dismiss": {
|
||||
"description": "Dismisses a request. Returns the updated ApprovalRequest.\n\nNOTE: This does not deny access to the resource if another request has been\nmade and approved. It is equivalent in effect to ignoring the request\naltogether.\n\nReturns NOT_FOUND if the request does not exist.\n\nReturns FAILED_PRECONDITION if the request exists but is not in a pending\nstate.",
|
||||
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:dismiss",
|
||||
"httpMethod": "POST",
|
||||
"id": "accessapproval.projects.approvalRequests.dismiss",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the ApprovalRequest to dismiss.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}:dismiss",
|
||||
"request": {
|
||||
"$ref": "DismissApprovalRequestMessage"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "ApprovalRequest"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Gets an approval request. Returns NOT_FOUND if the request does not exist.",
|
||||
"flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "accessapproval.projects.approvalRequests.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the approval request to retrieve.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/approvalRequests/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "ApprovalRequest"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists approval requests associated with a project, folder, or organization.\nApproval requests can be filtered by state (pending, active, dismissed).\nThe order is reverse chronological.",
|
||||
"flatPath": "v1/projects/{projectsId}/approvalRequests",
|
||||
"httpMethod": "GET",
|
||||
"id": "accessapproval.projects.approvalRequests.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "A filter on the type of approval requests to retrieve. Must be one of the\nfollowing values:\n<ol>\n <li>[not set]: Requests that are pending or have active approvals.</li>\n <li>ALL: All requests.</li>\n <li>PENDING: Only pending requests.</li>\n <li>ACTIVE: Only active (i.e. currently approved) requests.</li>\n <li>DISMISSED: Only dismissed (including expired) requests.</li>\n</ol>",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "Requested page size.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "A token identifying the page of results to return.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The parent resource. This may be \"projects/{project_id}\",\n\"folders/{folder_id}\", or \"organizations/{organization_id}\".",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/approvalRequests",
|
||||
"response": {
|
||||
"$ref": "ListApprovalRequestsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20200409",
|
||||
"rootUrl": "https://accessapproval.googleapis.com/",
|
||||
"schemas": {
|
||||
"AccessApprovalSettings": {
|
||||
"description": "Settings on a Project/Folder/Organization related to Access Approval.",
|
||||
"id": "AccessApprovalSettings",
|
||||
"properties": {
|
||||
"enrolledAncestor": {
|
||||
"description": "Output only. This field is read only (not settable via\nUpdateAccessAccessApprovalSettings method). If the field is true, that\nindicates that at least one service is enrolled for Access Approval in one\nor more ancestors of the Project or Folder (this field will always be\nunset for the organization since organizations do not have ancestors).",
|
||||
"type": "boolean"
|
||||
},
|
||||
"enrolledServices": {
|
||||
"description": "A list of Google Cloud Services for which the given resource has Access\nApproval enrolled. Access requests for the resource given by name against\nany of these services contained here will be required to have explicit\napproval. If name refers to an organization, enrollment can be done for\nindividual services. If name refers to a folder or project, enrollment can\nonly be done on an all or nothing basis.\n\nIf a cloud_product is repeated in this list, the first entry will be\nhonored and all following entries will be discarded. A maximum of 10\nenrolled services will be enforced, to be expanded as the set of supported\nservices is expanded.",
|
||||
"items": {
|
||||
"$ref": "EnrolledService"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"name": {
|
||||
"description": "The resource name of the settings. Format is one of:\n<ol>\n <li>\"projects/{project_id}/accessApprovalSettings\"</li>\n <li>\"folders/{folder_id}/accessApprovalSettings\"</li>\n <li>\"organizations/{organization_id}/accessApprovalSettings\"</li>\n<ol>",
|
||||
"type": "string"
|
||||
},
|
||||
"notificationEmails": {
|
||||
"description": "A list of email addresses to which notifications relating to approval\nrequests should be sent. Notifications relating to a resource will be sent\nto all emails in the settings of ancestor resources of that resource. A\nmaximum of 50 email addresses are allowed.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AccessLocations": {
|
||||
"description": "Home office and physical location of the principal.",
|
||||
"id": "AccessLocations",
|
||||
"properties": {
|
||||
"principalOfficeCountry": {
|
||||
"description": "The \"home office\" location of the principal. A two-letter country code\n(ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some\nlimited situations Google systems may refer refer to a region code instead\nof a country code.\nPossible Region Codes:\n<ol>\n <li>ASI: Asia</li>\n <li>EUR: Europe</li>\n <li>OCE: Oceania</li>\n <li>AFR: Africa</li>\n <li>NAM: North America</li>\n <li>SAM: South America</li>\n <li>ANT: Antarctica</li>\n <li>ANY: Any location</li>\n</ol>",
|
||||
"type": "string"
|
||||
},
|
||||
"principalPhysicalLocationCountry": {
|
||||
"description": "Physical location of the principal at the time of the access. A\ntwo-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or\na region code. In some limited situations Google systems may refer refer to\na region code instead of a country code.\nPossible Region Codes:\n<ol>\n <li>ASI: Asia</li>\n <li>EUR: Europe</li>\n <li>OCE: Oceania</li>\n <li>AFR: Africa</li>\n <li>NAM: North America</li>\n <li>SAM: South America</li>\n <li>ANT: Antarctica</li>\n <li>ANY: Any location</li>\n</ol>",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AccessReason": {
|
||||
"id": "AccessReason",
|
||||
"properties": {
|
||||
"detail": {
|
||||
"description": "More detail about certain reason types. See comments for each type above.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "Type of access justification.",
|
||||
"enum": [
|
||||
"TYPE_UNSPECIFIED",
|
||||
"CUSTOMER_INITIATED_SUPPORT",
|
||||
"GOOGLE_INITIATED_SERVICE",
|
||||
"GOOGLE_INITIATED_REVIEW"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for proto, shouldn't be used.",
|
||||
"Customer made a request or raised an issue that required the principal to\naccess customer data. `detail` is of the form (\"#####\" is the issue ID):\n<ol>\n <li>\"Feedback Report: #####\"</li>\n <li>\"Case Number: #####\"</li>\n <li>\"Case ID: #####\"</li>\n <li>\"E-PIN Reference: #####\"</li>\n <li>\"Google-#####\"</li>\n <li>\"T-#####\"</li>\n</ol>",
|
||||
"The principal accessed customer data in order to diagnose or resolve a\nsuspected issue in services or a known outage. Often this access is used\nto confirm that customers are not affected by a suspected service issue\nor to remediate a reversible system issue.",
|
||||
"Google initiated service for security, fraud, abuse, or compliance\npurposes."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ApprovalRequest": {
|
||||
"description": "A request for the customer to approve access to a resource.",
|
||||
"id": "ApprovalRequest",
|
||||
"properties": {
|
||||
"approve": {
|
||||
"$ref": "ApproveDecision",
|
||||
"description": "Access was approved."
|
||||
},
|
||||
"dismiss": {
|
||||
"$ref": "DismissDecision",
|
||||
"description": "The request was dismissed."
|
||||
},
|
||||
"name": {
|
||||
"description": "The resource name of the request. Format is\n\"{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}\".",
|
||||
"type": "string"
|
||||
},
|
||||
"requestTime": {
|
||||
"description": "The time at which approval was requested.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"requestedExpiration": {
|
||||
"description": "The requested expiration for the approval. If the request is approved,\naccess will be granted from the time of approval until the expiration time.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"requestedLocations": {
|
||||
"$ref": "AccessLocations",
|
||||
"description": "The locations for which approval is being requested."
|
||||
},
|
||||
"requestedReason": {
|
||||
"$ref": "AccessReason",
|
||||
"description": "The justification for which approval is being requested."
|
||||
},
|
||||
"requestedResourceName": {
|
||||
"description": "The resource for which approval is being requested. The format of the\nresource name is defined at\nhttps://cloud.google.com/apis/design/resource_names. The resource name here\nmay either be a \"full\" resource name (e.g.\n\"//library.googleapis.com/shelves/shelf1/books/book2\") or a \"relative\"\nresource name (e.g. \"shelves/shelf1/books/book2\") as described in the\nresource name specification.",
|
||||
"type": "string"
|
||||
},
|
||||
"requestedResourceProperties": {
|
||||
"$ref": "ResourceProperties",
|
||||
"description": "Properties related to the resource represented by requested_resource_name."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ApproveApprovalRequestMessage": {
|
||||
"description": "Request to approve an ApprovalRequest.",
|
||||
"id": "ApproveApprovalRequestMessage",
|
||||
"properties": {
|
||||
"expireTime": {
|
||||
"description": "The expiration time of this approval.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ApproveDecision": {
|
||||
"description": "A decision that has been made to approve access to a resource.",
|
||||
"id": "ApproveDecision",
|
||||
"properties": {
|
||||
"approveTime": {
|
||||
"description": "The time at which approval was granted.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"expireTime": {
|
||||
"description": "The time at which the approval expires.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DismissApprovalRequestMessage": {
|
||||
"description": "Request to dismiss an approval request.",
|
||||
"id": "DismissApprovalRequestMessage",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"DismissDecision": {
|
||||
"description": "A decision that has been made to dismiss an approval request.",
|
||||
"id": "DismissDecision",
|
||||
"properties": {
|
||||
"dismissTime": {
|
||||
"description": "The time at which the approval request was dismissed.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"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"
|
||||
},
|
||||
"EnrolledService": {
|
||||
"description": "Represents the enrollment of a cloud resource into a specific service.",
|
||||
"id": "EnrolledService",
|
||||
"properties": {
|
||||
"cloudProduct": {
|
||||
"description": "The product for which Access Approval will be enrolled. Allowed values are\nlisted below (case-sensitive):\n<ol>\n <li>all</li>\n <li>appengine.googleapis.com</li>\n <li>bigquery.googleapis.com</li>\n <li>bigtable.googleapis.com</li>\n <li>cloudkms.googleapis.com</li>\n <li>compute.googleapis.com</li>\n <li>dataflow.googleapis.com</li>\n <li>iam.googleapis.com</li>\n <li>pubsub.googleapis.com</li>\n <li>storage.googleapis.com</li>\n<ol>",
|
||||
"type": "string"
|
||||
},
|
||||
"enrollmentLevel": {
|
||||
"description": "The enrollment level of the service.",
|
||||
"enum": [
|
||||
"ENROLLMENT_LEVEL_UNSPECIFIED",
|
||||
"BLOCK_ALL"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for proto, shouldn't be used.",
|
||||
"Service is enrolled in Access Approval for all requests"
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListApprovalRequestsResponse": {
|
||||
"description": "Response to listing of ApprovalRequest objects.",
|
||||
"id": "ListApprovalRequestsResponse",
|
||||
"properties": {
|
||||
"approvalRequests": {
|
||||
"description": "Approval request details.",
|
||||
"items": {
|
||||
"$ref": "ApprovalRequest"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "Token to retrieve the next page of results, or empty if there are no more.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ResourceProperties": {
|
||||
"description": "The properties associated with the resource of the request.",
|
||||
"id": "ResourceProperties",
|
||||
"properties": {
|
||||
"excludesDescendants": {
|
||||
"description": "Whether an approval will exclude the descendants of the resource being\nrequested.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "Access Approval API",
|
||||
"version": "v1",
|
||||
"version_module": true
|
||||
}
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "accessapproval:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://accessapproval.mtls.googleapis.com/",
|
||||
"name": "accessapproval",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -106,6 +107,31 @@
|
||||
"resources": {
|
||||
"folders": {
|
||||
"methods": {
|
||||
"deleteAccessApprovalSettings": {
|
||||
"description": "Deletes the settings associated with a project, folder, or organization.\nThis will have the effect of disabling Access Approval for the project,\nfolder, or organization, but only if all ancestors also have Access\nApproval disabled. If Access Approval is enabled at a higher level of the\nhierarchy, then Access Approval will still be enabled at this level as\nthe settings are inherited.",
|
||||
"flatPath": "v1beta1/folders/{foldersId}/accessApprovalSettings",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "accessapproval.folders.deleteAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the AccessApprovalSettings to delete.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"getAccessApprovalSettings": {
|
||||
"description": "Gets the settings associated with a project, folder, or organization.",
|
||||
"flatPath": "v1beta1/folders/{foldersId}/accessApprovalSettings",
|
||||
@@ -132,7 +158,7 @@
|
||||
]
|
||||
},
|
||||
"updateAccessApprovalSettings": {
|
||||
"description": "Updates the settings associated with a project, folder, or organization.\nCompletely replaces the existing settings.",
|
||||
"description": "Updates the settings associated with a project, folder, or organization.\nSettings to update are determined by the value of field_mask.",
|
||||
"flatPath": "v1beta1/folders/{foldersId}/accessApprovalSettings",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "accessapproval.folders.updateAccessApprovalSettings",
|
||||
@@ -146,6 +172,12 @@
|
||||
"pattern": "^folders/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "For the `FieldMask` definition, see\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask\nIf this field is left unset, only the notification_emails field will be\nupdated.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
@@ -291,6 +323,31 @@
|
||||
},
|
||||
"organizations": {
|
||||
"methods": {
|
||||
"deleteAccessApprovalSettings": {
|
||||
"description": "Deletes the settings associated with a project, folder, or organization.\nThis will have the effect of disabling Access Approval for the project,\nfolder, or organization, but only if all ancestors also have Access\nApproval disabled. If Access Approval is enabled at a higher level of the\nhierarchy, then Access Approval will still be enabled at this level as\nthe settings are inherited.",
|
||||
"flatPath": "v1beta1/organizations/{organizationsId}/accessApprovalSettings",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "accessapproval.organizations.deleteAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the AccessApprovalSettings to delete.",
|
||||
"location": "path",
|
||||
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"getAccessApprovalSettings": {
|
||||
"description": "Gets the settings associated with a project, folder, or organization.",
|
||||
"flatPath": "v1beta1/organizations/{organizationsId}/accessApprovalSettings",
|
||||
@@ -317,7 +374,7 @@
|
||||
]
|
||||
},
|
||||
"updateAccessApprovalSettings": {
|
||||
"description": "Updates the settings associated with a project, folder, or organization.\nCompletely replaces the existing settings.",
|
||||
"description": "Updates the settings associated with a project, folder, or organization.\nSettings to update are determined by the value of field_mask.",
|
||||
"flatPath": "v1beta1/organizations/{organizationsId}/accessApprovalSettings",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "accessapproval.organizations.updateAccessApprovalSettings",
|
||||
@@ -331,6 +388,12 @@
|
||||
"pattern": "^organizations/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "For the `FieldMask` definition, see\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask\nIf this field is left unset, only the notification_emails field will be\nupdated.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
@@ -476,6 +539,31 @@
|
||||
},
|
||||
"projects": {
|
||||
"methods": {
|
||||
"deleteAccessApprovalSettings": {
|
||||
"description": "Deletes the settings associated with a project, folder, or organization.\nThis will have the effect of disabling Access Approval for the project,\nfolder, or organization, but only if all ancestors also have Access\nApproval disabled. If Access Approval is enabled at a higher level of the\nhierarchy, then Access Approval will still be enabled at this level as\nthe settings are inherited.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/accessApprovalSettings",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "accessapproval.projects.deleteAccessApprovalSettings",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the AccessApprovalSettings to delete.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"getAccessApprovalSettings": {
|
||||
"description": "Gets the settings associated with a project, folder, or organization.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/accessApprovalSettings",
|
||||
@@ -502,7 +590,7 @@
|
||||
]
|
||||
},
|
||||
"updateAccessApprovalSettings": {
|
||||
"description": "Updates the settings associated with a project, folder, or organization.\nCompletely replaces the existing settings.",
|
||||
"description": "Updates the settings associated with a project, folder, or organization.\nSettings to update are determined by the value of field_mask.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/accessApprovalSettings",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "accessapproval.projects.updateAccessApprovalSettings",
|
||||
@@ -516,6 +604,12 @@
|
||||
"pattern": "^projects/[^/]+/accessApprovalSettings$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "For the `FieldMask` definition, see\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask\nIf this field is left unset, only the notification_emails field will be\nupdated.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
@@ -660,19 +754,30 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190628",
|
||||
"revision": "20200409",
|
||||
"rootUrl": "https://accessapproval.googleapis.com/",
|
||||
"schemas": {
|
||||
"AccessApprovalSettings": {
|
||||
"description": "Settings on a Project/Folder/Organization related to Access Approval.",
|
||||
"id": "AccessApprovalSettings",
|
||||
"properties": {
|
||||
"enrolledAncestor": {
|
||||
"description": "Output only. This field is read only (not settable via\nUpdateAccessAccessApprovalSettings method). If the field is true, that\nindicates that at least one service is enrolled for Access Approval in one\nor more ancestors of the Project or Folder (this field will always be\nunset for the organization since organizations do not have ancestors).",
|
||||
"type": "boolean"
|
||||
},
|
||||
"enrolledServices": {
|
||||
"description": "A list of Google Cloud Services for which the given resource has Access\nApproval enrolled. Access requests for the resource given by name against\nany of these services contained here will be required to have explicit\napproval. If name refers to an organization, enrollment can be done for\nindividual services. If name refers to a folder or project, enrollment can\nonly be done on an all or nothing basis.\n\nIf a cloud_product is repeated in this list, the first entry will be\nhonored and all following entries will be discarded. A maximum of 10\nenrolled services will be enforced, to be expanded as the set of supported\nservices is expanded.",
|
||||
"items": {
|
||||
"$ref": "EnrolledService"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"name": {
|
||||
"description": "The resource name of the settings. Format is one of:\n<ol>\n <li>\"projects/{project_id}/accessApprovalSettings\"</li>\n <li>\"folders/{folder_id}/accessApprovalSettings\"</li>\n <li>\"organizations/{organization_id}/accessApprovalSettings\"</li>\n<ol>",
|
||||
"type": "string"
|
||||
},
|
||||
"notificationEmails": {
|
||||
"description": "A list of email addresses to which notifications relating to approval\nrequests should be sent. Notifications relating to a resource will be sent\nto all emails in the settings of ancestor resources of that resource.",
|
||||
"description": "A list of email addresses to which notifications relating to approval\nrequests should be sent. Notifications relating to a resource will be sent\nto all emails in the settings of ancestor resources of that resource. A\nmaximum of 50 email addresses are allowed.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -814,6 +919,35 @@
|
||||
},
|
||||
"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"
|
||||
},
|
||||
"EnrolledService": {
|
||||
"description": "Represents the enrollment of a cloud resource into a specific service.",
|
||||
"id": "EnrolledService",
|
||||
"properties": {
|
||||
"cloudProduct": {
|
||||
"description": "The product for which Access Approval will be enrolled. Allowed values are\nlisted below (case-sensitive):\n<ol>\n <li>all</li>\n <li>appengine.googleapis.com</li>\n <li>bigquery.googleapis.com</li>\n <li>bigtable.googleapis.com</li>\n <li>cloudkms.googleapis.com</li>\n <li>compute.googleapis.com</li>\n <li>dataflow.googleapis.com</li>\n <li>iam.googleapis.com</li>\n <li>pubsub.googleapis.com</li>\n <li>storage.googleapis.com</li>\n<ol>",
|
||||
"type": "string"
|
||||
},
|
||||
"enrollmentLevel": {
|
||||
"description": "The enrollment level of the service.",
|
||||
"enum": [
|
||||
"ENROLLMENT_LEVEL_UNSPECIFIED",
|
||||
"BLOCK_ALL"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for proto, shouldn't be used.",
|
||||
"Service is enrolled in Access Approval for all requests"
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListApprovalRequestsResponse": {
|
||||
"description": "Response to listing of ApprovalRequest objects.",
|
||||
"id": "ListApprovalRequestsResponse",
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "accesscontextmanager:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://accesscontextmanager.mtls.googleapis.com/",
|
||||
"name": "accesscontextmanager",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -388,14 +389,14 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. Resource name for the Access Level. The `short_name` component\nmust begin with a letter and only include alphanumeric and '_'. Format:\n`accessPolicies/{policy_id}/accessLevels/{short_name}`",
|
||||
"description": "Required. Resource name for the Access Level. The `short_name` component\nmust begin with a letter and only include alphanumeric and '_'. Format:\n`accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length\nof the `short_name` component is 50 characters.",
|
||||
"location": "path",
|
||||
"pattern": "^accessPolicies/[^/]+/accessLevels/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Required. Mask to control which fields get updated. Must be non-empty.",
|
||||
"description": "Required. Mask to control which fields get updated. Must be non-empty.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -411,13 +412,69 @@
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"replaceAll": {
|
||||
"description": "Replace all existing Access Levels in an Access\nPolicy with\nthe Access Levels provided. This\nis done atomically. The longrunning operation from this RPC will have a\nsuccessful status once all replacements have propagated to long-lasting\nstorage. Replacements containing errors will result in an error response\nfor the first error encountered. Replacement will be cancelled on error,\nexisting Access Levels will not be\naffected. Operation.response field will contain\nReplaceAccessLevelsResponse. Removing Access Levels contained in existing\nService Perimeters will result in\nerror.",
|
||||
"flatPath": "v1/accessPolicies/{accessPoliciesId}/accessLevels:replaceAll",
|
||||
"httpMethod": "POST",
|
||||
"id": "accesscontextmanager.accessPolicies.accessLevels.replaceAll",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. Resource name for the access policy which owns these\nAccess Levels.\n\nFormat: `accessPolicies/{policy_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^accessPolicies/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/accessLevels:replaceAll",
|
||||
"request": {
|
||||
"$ref": "ReplaceAccessLevelsRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"servicePerimeters": {
|
||||
"methods": {
|
||||
"commit": {
|
||||
"description": "Commit the dry-run spec for all the Service Perimeters in an\nAccess Policy.\nA commit operation on a Service Perimeter involves copying its `spec` field\nto that Service Perimeter's `status` field. Only Service Perimeters with\n`use_explicit_dry_run_spec` field set to true are affected by a commit\noperation. The longrunning operation from this RPC will have a successful\nstatus once the dry-run specs for all the Service Perimeters have been\ncommitted. If a commit fails, it will cause the longrunning operation to\nreturn an error response and the entire commit operation will be cancelled.\nWhen successful, Operation.response field will contain\nCommitServicePerimetersResponse. The `dry_run` and the `spec` fields will\nbe cleared after a successful commit operation.",
|
||||
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters:commit",
|
||||
"httpMethod": "POST",
|
||||
"id": "accesscontextmanager.accessPolicies.servicePerimeters.commit",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. Resource name for the parent Access Policy which owns all\nService Perimeters in scope for\nthe commit operation.\n\nFormat: `accessPolicies/{policy_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^accessPolicies/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/servicePerimeters:commit",
|
||||
"request": {
|
||||
"$ref": "CommitServicePerimetersRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"create": {
|
||||
"description": "Create an Service Perimeter. The\nlongrunning operation from this RPC will have a successful status once the\nService Perimeter has\npropagated to long-lasting storage. Service Perimeters containing\nerrors will result in an error response for the first error encountered.",
|
||||
"description": "Create a Service Perimeter. The\nlongrunning operation from this RPC will have a successful status once the\nService Perimeter has\npropagated to long-lasting storage. Service Perimeters containing\nerrors will result in an error response for the first error encountered.",
|
||||
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters",
|
||||
"httpMethod": "POST",
|
||||
"id": "accesscontextmanager.accessPolicies.servicePerimeters.create",
|
||||
@@ -445,7 +502,7 @@
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Delete an Service Perimeter by resource\nname. The longrunning operation from this RPC will have a successful status\nonce the Service Perimeter has been\nremoved from long-lasting storage.",
|
||||
"description": "Delete a Service Perimeter by resource\nname. The longrunning operation from this RPC will have a successful status\nonce the Service Perimeter has been\nremoved from long-lasting storage.",
|
||||
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "accesscontextmanager.accessPolicies.servicePerimeters.delete",
|
||||
@@ -470,7 +527,7 @@
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Get an Service Perimeter by resource\nname.",
|
||||
"description": "Get a Service Perimeter by resource\nname.",
|
||||
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "accesscontextmanager.accessPolicies.servicePerimeters.get",
|
||||
@@ -531,7 +588,7 @@
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Update an Service Perimeter. The\nlongrunning operation from this RPC will have a successful status once the\nchanges to the Service Perimeter have\npropagated to long-lasting storage. Service Perimeter containing\nerrors will result in an error response for the first error encountered.",
|
||||
"description": "Update a Service Perimeter. The\nlongrunning operation from this RPC will have a successful status once the\nchanges to the Service Perimeter have\npropagated to long-lasting storage. Service Perimeter containing\nerrors will result in an error response for the first error encountered.",
|
||||
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "accesscontextmanager.accessPolicies.servicePerimeters.patch",
|
||||
@@ -563,6 +620,34 @@
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"replaceAll": {
|
||||
"description": "Replace all existing Service Perimeters in an\nAccess Policy\nwith the Service Perimeters provided.\nThis is done atomically. The longrunning operation from this\nRPC will have a successful status once all replacements have propagated to\nlong-lasting storage. Replacements containing errors will result in an\nerror response for the first error encountered. Replacement will be\ncancelled on error, existing Service Perimeters will not be\naffected. Operation.response field will contain\nReplaceServicePerimetersResponse.",
|
||||
"flatPath": "v1/accessPolicies/{accessPoliciesId}/servicePerimeters:replaceAll",
|
||||
"httpMethod": "POST",
|
||||
"id": "accesscontextmanager.accessPolicies.servicePerimeters.replaceAll",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. Resource name for the access policy which owns these\nService Perimeters.\n\nFormat: `accessPolicies/{policy_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^accessPolicies/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/servicePerimeters:replaceAll",
|
||||
"request": {
|
||||
"$ref": "ReplaceServicePerimetersRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -582,7 +667,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource to be cancelled.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -610,7 +695,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource to be deleted.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -635,7 +720,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -692,49 +777,42 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190626",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://accesscontextmanager.googleapis.com/",
|
||||
"schemas": {
|
||||
"AccessLevel": {
|
||||
"description": "An `AccessLevel` is a label that can be applied to requests to GCP services,\nalong with a list of requirements necessary for the label to be applied.",
|
||||
"description": "An `AccessLevel` is a label that can be applied to requests to Google Cloud\nservices, along with a list of requirements necessary for the label to be\napplied.",
|
||||
"id": "AccessLevel",
|
||||
"properties": {
|
||||
"basic": {
|
||||
"$ref": "BasicLevel",
|
||||
"description": "A `BasicLevel` composed of `Conditions`."
|
||||
},
|
||||
"createTime": {
|
||||
"description": "Output only. Time the `AccessLevel` was created in UTC.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
"custom": {
|
||||
"$ref": "CustomLevel",
|
||||
"description": "A `CustomLevel` written in the Common Expression Language."
|
||||
},
|
||||
"description": {
|
||||
"description": "Description of the `AccessLevel` and its use. Does not affect behavior.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Required. Resource name for the Access Level. The `short_name` component\nmust begin with a letter and only include alphanumeric and '_'. Format:\n`accessPolicies/{policy_id}/accessLevels/{short_name}`",
|
||||
"description": "Required. Resource name for the Access Level. The `short_name` component\nmust begin with a letter and only include alphanumeric and '_'. Format:\n`accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length\nof the `short_name` component is 50 characters.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "Human readable title. Must be unique within the Policy.",
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only. Time the `AccessLevel` was updated in UTC.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AccessPolicy": {
|
||||
"description": "`AccessPolicy` is a container for `AccessLevels` (which define the necessary\nattributes to use GCP services) and `ServicePerimeters` (which define regions\nof services able to freely pass data within a perimeter). An access policy is\nglobally visible within an organization, and the restrictions it specifies\napply to all projects within an organization.",
|
||||
"description": "`AccessPolicy` is a container for `AccessLevels` (which define the necessary\nattributes to use Google Cloud services) and `ServicePerimeters` (which\ndefine regions of services able to freely pass data within a perimeter). An\naccess policy is globally visible within an organization, and the\nrestrictions it specifies apply to all projects within an organization.",
|
||||
"id": "AccessPolicy",
|
||||
"properties": {
|
||||
"createTime": {
|
||||
"description": "Output only. Time the `AccessPolicy` was created in UTC.",
|
||||
"format": "google-datetime",
|
||||
"etag": {
|
||||
"description": "Output only. An opaque identifier for the current version of the\n`AccessPolicy`. This will always be a strongly validated etag, meaning that\ntwo Access Polices will be identical if and only if their etags are\nidentical. Clients should not expect this to be in any specific format.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
@@ -748,11 +826,6 @@
|
||||
"title": {
|
||||
"description": "Required. Human readable title. Does not affect behavior.",
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only. Time the `AccessPolicy` was updated in UTC.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -789,6 +862,31 @@
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"CommitServicePerimetersRequest": {
|
||||
"description": "A request to commit dry-run specs in all Service Perimeters belonging to\nan Access Policy.",
|
||||
"id": "CommitServicePerimetersRequest",
|
||||
"properties": {
|
||||
"etag": {
|
||||
"description": "Optional. The etag for the version of the Access Policy that this\ncommit operation is to be performed on. If, at the time of commit, the\netag for the Access Policy stored in Access Context Manager is different\nfrom the specified etag, then the commit operation will not be performed\nand the call will fail. This field is not required. If etag is not\nprovided, the operation will be performed as if a valid etag is provided.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CommitServicePerimetersResponse": {
|
||||
"description": "A response to CommitServicePerimetersRequest. This will be put inside of\nOperation.response field.",
|
||||
"id": "CommitServicePerimetersResponse",
|
||||
"properties": {
|
||||
"servicePerimeters": {
|
||||
"description": "List of all the Service Perimeter instances in\nthe Access Policy.",
|
||||
"items": {
|
||||
"$ref": "ServicePerimeter"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Condition": {
|
||||
"description": "A condition necessary for an `AccessLevel` to be granted. The Condition is an\nAND over its fields. So a Condition is true if: 1) the request IP is from one\nof the listed subnetworks AND 2) the originating device complies with the\nlisted device policy AND 3) all listed access levels are granted AND 4) the\nrequest was sent at a time allowed by the DateTimeRestriction.",
|
||||
"id": "Condition",
|
||||
@@ -832,6 +930,17 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CustomLevel": {
|
||||
"description": "`CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language\nto represent the necessary conditions for the level to apply to a request.\nSee CEL spec at: https://github.com/google/cel-spec",
|
||||
"id": "CustomLevel",
|
||||
"properties": {
|
||||
"expr": {
|
||||
"$ref": "Expr",
|
||||
"description": "Required. A Cloud CEL expression evaluating to a boolean."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DevicePolicy": {
|
||||
"description": "`DevicePolicy` specifies device specific restrictions necessary to acquire a\ngiven access level. A `DevicePolicy` specifies requirements for requests from\ndevices to be granted access levels, it does not do any enforcement on the\ndevice. `DevicePolicy` acts as an AND over all specified fields, and each\nrepeated field is an OR over its elements. Any unset fields are ignored. For\nexample, if the proto is { os_type : DESKTOP_WINDOWS, os_type :\nDESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be\ntrue for requests originating from encrypted Linux desktops and encrypted\nWindows desktops.",
|
||||
"id": "DevicePolicy",
|
||||
@@ -902,6 +1011,29 @@
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListAccessLevelsResponse": {
|
||||
"description": "A response to `ListAccessLevelsRequest`.",
|
||||
"id": "ListAccessLevelsResponse",
|
||||
@@ -1024,33 +1156,96 @@
|
||||
"DESKTOP_MAC",
|
||||
"DESKTOP_WINDOWS",
|
||||
"DESKTOP_LINUX",
|
||||
"DESKTOP_CHROME_OS"
|
||||
"DESKTOP_CHROME_OS",
|
||||
"ANDROID",
|
||||
"IOS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The operating system of the device is not specified or not known.",
|
||||
"A desktop Mac operating system.",
|
||||
"A desktop Windows operating system.",
|
||||
"A desktop Linux operating system.",
|
||||
"A desktop ChromeOS operating system."
|
||||
"A desktop ChromeOS operating system.",
|
||||
"An Android operating system.",
|
||||
"An iOS operating system."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"requireVerifiedChromeOs": {
|
||||
"description": "Only allows requests from devices with a verified Chrome OS.\nVerifications includes requirements that the device is enterprise-managed,\nconformant to Dasher domain policies, and the caller has permission to call\nthe API targeted by the request.",
|
||||
"description": "Only allows requests from devices with a verified Chrome OS.\nVerifications includes requirements that the device is enterprise-managed,\nconformant to domain policies, and the caller has permission to call\nthe API targeted by the request.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ServicePerimeter": {
|
||||
"description": "`ServicePerimeter` describes a set of GCP resources which can freely import\nand export data amongst themselves, but not export outside of the\n`ServicePerimeter`. If a request with a source within this `ServicePerimeter`\nhas a target outside of the `ServicePerimeter`, the request will be blocked.\nOtherwise the request is allowed. There are two types of Service Perimeter -\nRegular and Bridge. Regular Service Perimeters cannot overlap, a single GCP\nproject can only belong to a single regular Service Perimeter. Service\nPerimeter Bridges can contain only GCP projects as members, a single GCP\nproject may belong to multiple Service Perimeter Bridges.",
|
||||
"id": "ServicePerimeter",
|
||||
"ReplaceAccessLevelsRequest": {
|
||||
"description": "A request to replace all existing Access Levels in an Access Policy with\nthe Access Levels provided. This is done atomically.",
|
||||
"id": "ReplaceAccessLevelsRequest",
|
||||
"properties": {
|
||||
"createTime": {
|
||||
"description": "Output only. Time the `ServicePerimeter` was created in UTC.",
|
||||
"format": "google-datetime",
|
||||
"accessLevels": {
|
||||
"description": "Required. The desired Access Levels that should\nreplace all existing Access Levels in the\nAccess Policy.",
|
||||
"items": {
|
||||
"$ref": "AccessLevel"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "Optional. The etag for the version of the Access Policy that this\nreplace operation is to be performed on. If, at the time of replace, the\netag for the Access Policy stored in Access Context Manager is different\nfrom the specified etag, then the replace operation will not be performed\nand the call will fail. This field is not required. If etag is not\nprovided, the operation will be performed as if a valid etag is provided.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReplaceAccessLevelsResponse": {
|
||||
"description": "A response to ReplaceAccessLevelsRequest. This will be put inside of\nOperation.response field.",
|
||||
"id": "ReplaceAccessLevelsResponse",
|
||||
"properties": {
|
||||
"accessLevels": {
|
||||
"description": "List of the Access Level instances.",
|
||||
"items": {
|
||||
"$ref": "AccessLevel"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReplaceServicePerimetersRequest": {
|
||||
"description": "A request to replace all existing Service Perimeters in an Access Policy\nwith the Service Perimeters provided. This is done atomically.",
|
||||
"id": "ReplaceServicePerimetersRequest",
|
||||
"properties": {
|
||||
"etag": {
|
||||
"description": "Optional. The etag for the version of the Access Policy that this\nreplace operation is to be performed on. If, at the time of replace, the\netag for the Access Policy stored in Access Context Manager is different\nfrom the specified etag, then the replace operation will not be performed\nand the call will fail. This field is not required. If etag is not\nprovided, the operation will be performed as if a valid etag is provided.",
|
||||
"type": "string"
|
||||
},
|
||||
"servicePerimeters": {
|
||||
"description": "Required. The desired Service Perimeters that should\nreplace all existing Service Perimeters in the\nAccess Policy.",
|
||||
"items": {
|
||||
"$ref": "ServicePerimeter"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReplaceServicePerimetersResponse": {
|
||||
"description": "A response to ReplaceServicePerimetersRequest. This will be put inside of\nOperation.response field.",
|
||||
"id": "ReplaceServicePerimetersResponse",
|
||||
"properties": {
|
||||
"servicePerimeters": {
|
||||
"description": "List of the Service Perimeter instances.",
|
||||
"items": {
|
||||
"$ref": "ServicePerimeter"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ServicePerimeter": {
|
||||
"description": "`ServicePerimeter` describes a set of Google Cloud resources which can freely\nimport and export data amongst themselves, but not export outside of the\n`ServicePerimeter`. If a request with a source within this `ServicePerimeter`\nhas a target outside of the `ServicePerimeter`, the request will be blocked.\nOtherwise the request is allowed. There are two types of Service Perimeter -\nRegular and Bridge. Regular Service Perimeters cannot overlap, a single\nGoogle Cloud project can only belong to a single regular Service Perimeter.\nService Perimeter Bridges can contain only Google Cloud projects as members,\na single Google Cloud project may belong to multiple Service Perimeter\nBridges.",
|
||||
"id": "ServicePerimeter",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "Description of the `ServicePerimeter` and its use. Does not affect\nbehavior.",
|
||||
"type": "string"
|
||||
@@ -1071,6 +1266,10 @@
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"spec": {
|
||||
"$ref": "ServicePerimeterConfig",
|
||||
"description": "Proposed (or dry run) ServicePerimeter configuration. This configuration\nallows to specify and test ServicePerimeter configuration without enforcing\nactual access restrictions. Only allowed to be set when the\n\"use_explicit_dry_run_spec\" flag is set."
|
||||
},
|
||||
"status": {
|
||||
"$ref": "ServicePerimeterConfig",
|
||||
"description": "Current ServicePerimeter configuration. Specifies sets of resources,\nrestricted services and access levels that determine perimeter\ncontent and boundaries."
|
||||
@@ -1079,38 +1278,41 @@
|
||||
"description": "Human readable title. Must be unique within the Policy.",
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only. Time the `ServicePerimeter` was updated in UTC.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
"useExplicitDryRunSpec": {
|
||||
"description": "Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly\nexists for all Service Perimeters, and that spec is identical to the\nstatus for those Service Perimeters. When this flag is set, it inhibits the\ngeneration of the implicit spec, thereby allowing the user to explicitly\nprovide a configuration (\"spec\") to use in a dry-run version of the Service\nPerimeter. This allows the user to test changes to the enforced config\n(\"status\") without actually enforcing them. This testing is done through\nanalyzing the differences between currently enforced and suggested\nrestrictions. use_explicit_dry_run_spec must bet set to True if any of the\nfields in the spec are set to non-default values.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ServicePerimeterConfig": {
|
||||
"description": "`ServicePerimeterConfig` specifies a set of GCP resources that describe\nspecific Service Perimeter configuration.",
|
||||
"description": "`ServicePerimeterConfig` specifies a set of Google Cloud resources that\ndescribe specific Service Perimeter configuration.",
|
||||
"id": "ServicePerimeterConfig",
|
||||
"properties": {
|
||||
"accessLevels": {
|
||||
"description": "A list of `AccessLevel` resource names that allow resources within the\n`ServicePerimeter` to be accessed from the internet. `AccessLevels` listed\nmust be in the same policy as this `ServicePerimeter`. Referencing a\nnonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are\nlisted, resources within the perimeter can only be accessed via GCP calls\nwith request origins within the perimeter. Example:\n`\"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL\"`.\nFor Service Perimeter Bridge, must be empty.",
|
||||
"description": "A list of `AccessLevel` resource names that allow resources within the\n`ServicePerimeter` to be accessed from the internet. `AccessLevels` listed\nmust be in the same policy as this `ServicePerimeter`. Referencing a\nnonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are\nlisted, resources within the perimeter can only be accessed via Google\nCloud calls with request origins within the perimeter. Example:\n`\"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL\"`.\nFor Service Perimeter Bridge, must be empty.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"resources": {
|
||||
"description": "A list of GCP resources that are inside of the service perimeter.\nCurrently only projects are allowed. Format: `projects/{project_number}`",
|
||||
"description": "A list of Google Cloud resources that are inside of the service perimeter.\nCurrently only projects are allowed. Format: `projects/{project_number}`",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"restrictedServices": {
|
||||
"description": "GCP services that are subject to the Service Perimeter restrictions. For\nexample, if `storage.googleapis.com` is specified, access to the storage\nbuckets inside the perimeter must meet the perimeter's access restrictions.",
|
||||
"description": "Google Cloud services that are subject to the Service Perimeter\nrestrictions. For example, if `storage.googleapis.com` is specified, access\nto the storage buckets inside the perimeter must meet the perimeter's\naccess restrictions.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"vpcAccessibleServices": {
|
||||
"$ref": "VpcAccessibleServices",
|
||||
"description": "Configuration for APIs allowed within Perimeter."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1141,6 +1343,24 @@
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"VpcAccessibleServices": {
|
||||
"description": "Specifies how APIs are allowed to communicate within the Service\nPerimeter.",
|
||||
"id": "VpcAccessibleServices",
|
||||
"properties": {
|
||||
"allowedServices": {
|
||||
"description": "The list of APIs usable within the Service Perimeter. Must be empty\nunless 'enable_restriction' is True.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"enableRestriction": {
|
||||
"description": "Whether to restrict API calls within the Service Perimeter to the list of\nAPIs specified in 'allowed_services'.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "accesscontextmanager:v1beta",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://accesscontextmanager.mtls.googleapis.com/",
|
||||
"name": "accesscontextmanager",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -388,14 +389,14 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. Resource name for the Access Level. The `short_name` component\nmust begin with a letter and only include alphanumeric and '_'. Format:\n`accessPolicies/{policy_id}/accessLevels/{short_name}`",
|
||||
"description": "Required. Resource name for the Access Level. The `short_name` component\nmust begin with a letter and only include alphanumeric and '_'. Format:\n`accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length\n // of the `short_name` component is 50 characters.",
|
||||
"location": "path",
|
||||
"pattern": "^accessPolicies/[^/]+/accessLevels/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Required. Mask to control which fields get updated. Must be non-empty.",
|
||||
"description": "Required. Mask to control which fields get updated. Must be non-empty.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -417,7 +418,7 @@
|
||||
"servicePerimeters": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Create an Service Perimeter. The\nlongrunning operation from this RPC will have a successful status once the\nService Perimeter has\npropagated to long-lasting storage. Service Perimeters containing\nerrors will result in an error response for the first error encountered.",
|
||||
"description": "Create a Service Perimeter. The\nlongrunning operation from this RPC will have a successful status once the\nService Perimeter has\npropagated to long-lasting storage. Service Perimeters containing\nerrors will result in an error response for the first error encountered.",
|
||||
"flatPath": "v1beta/accessPolicies/{accessPoliciesId}/servicePerimeters",
|
||||
"httpMethod": "POST",
|
||||
"id": "accesscontextmanager.accessPolicies.servicePerimeters.create",
|
||||
@@ -445,7 +446,7 @@
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Delete an Service Perimeter by resource\nname. The longrunning operation from this RPC will have a successful status\nonce the Service Perimeter has been\nremoved from long-lasting storage.",
|
||||
"description": "Delete a Service Perimeter by resource\nname. The longrunning operation from this RPC will have a successful status\nonce the Service Perimeter has been\nremoved from long-lasting storage.",
|
||||
"flatPath": "v1beta/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "accesscontextmanager.accessPolicies.servicePerimeters.delete",
|
||||
@@ -470,7 +471,7 @@
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Get an Service Perimeter by resource\nname.",
|
||||
"description": "Get a Service Perimeter by resource\nname.",
|
||||
"flatPath": "v1beta/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "accesscontextmanager.accessPolicies.servicePerimeters.get",
|
||||
@@ -531,7 +532,7 @@
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Update an Service Perimeter. The\nlongrunning operation from this RPC will have a successful status once the\nchanges to the Service Perimeter have\npropagated to long-lasting storage. Service Perimeter containing\nerrors will result in an error response for the first error encountered.",
|
||||
"description": "Update a Service Perimeter. The\nlongrunning operation from this RPC will have a successful status once the\nchanges to the Service Perimeter have\npropagated to long-lasting storage. Service Perimeter containing\nerrors will result in an error response for the first error encountered.",
|
||||
"flatPath": "v1beta/accessPolicies/{accessPoliciesId}/servicePerimeters/{servicePerimetersId}",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "accesscontextmanager.accessPolicies.servicePerimeters.patch",
|
||||
@@ -582,7 +583,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -598,51 +599,40 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190626",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://accesscontextmanager.googleapis.com/",
|
||||
"schemas": {
|
||||
"AccessLevel": {
|
||||
"description": "An `AccessLevel` is a label that can be applied to requests to GCP services,\nalong with a list of requirements necessary for the label to be applied.",
|
||||
"description": "An `AccessLevel` is a label that can be applied to requests to Google Cloud\nservices, along with a list of requirements necessary for the label to be\napplied.",
|
||||
"id": "AccessLevel",
|
||||
"properties": {
|
||||
"basic": {
|
||||
"$ref": "BasicLevel",
|
||||
"description": "A `BasicLevel` composed of `Conditions`."
|
||||
},
|
||||
"createTime": {
|
||||
"description": "Output only. Time the `AccessLevel` was created in UTC.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
"custom": {
|
||||
"$ref": "CustomLevel",
|
||||
"description": "A `CustomLevel` written in the Common Expression Language."
|
||||
},
|
||||
"description": {
|
||||
"description": "Description of the `AccessLevel` and its use. Does not affect behavior.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Required. Resource name for the Access Level. The `short_name` component\nmust begin with a letter and only include alphanumeric and '_'. Format:\n`accessPolicies/{policy_id}/accessLevels/{short_name}`",
|
||||
"description": "Required. Resource name for the Access Level. The `short_name` component\nmust begin with a letter and only include alphanumeric and '_'. Format:\n`accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length\n // of the `short_name` component is 50 characters.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "Human readable title. Must be unique within the Policy.",
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only. Time the `AccessLevel` was updated in UTC.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AccessPolicy": {
|
||||
"description": "`AccessPolicy` is a container for `AccessLevels` (which define the necessary\nattributes to use GCP services) and `ServicePerimeters` (which define regions\nof services able to freely pass data within a perimeter). An access policy is\nglobally visible within an organization, and the restrictions it specifies\napply to all projects within an organization.",
|
||||
"description": "`AccessPolicy` is a container for `AccessLevels` (which define the necessary\nattributes to use Google Cloud services) and `ServicePerimeters` (which\ndefine regions of services able to freely pass data within a perimeter). An\naccess policy is globally visible within an organization, and the\nrestrictions it specifies apply to all projects within an organization.",
|
||||
"id": "AccessPolicy",
|
||||
"properties": {
|
||||
"createTime": {
|
||||
"description": "Output only. Time the `AccessPolicy` was created in UTC.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output only. Resource name of the `AccessPolicy`. Format:\n`accessPolicies/{policy_id}`",
|
||||
"type": "string"
|
||||
@@ -654,11 +644,6 @@
|
||||
"title": {
|
||||
"description": "Required. Human readable title. Does not affect behavior.",
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only. Time the `AccessPolicy` was updated in UTC.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -689,24 +674,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"BridgeServiceRestriction": {
|
||||
"description": "Alpha. Specifies which services are granted access via this Bridge Service\nPerimeter.",
|
||||
"id": "BridgeServiceRestriction",
|
||||
"properties": {
|
||||
"allowedServices": {
|
||||
"description": "The list of APIs usable through the Bridge Perimeter. Must be empty\nunless 'enable_restriction' is True.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"enableRestriction": {
|
||||
"description": "Whether to restrict the set of APIs callable through the Bridge Service\nPerimeter.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Condition": {
|
||||
"description": "A condition necessary for an `AccessLevel` to be granted. The Condition is an\nAND over its fields. So a Condition is true if: 1) the request IP is from one\nof the listed subnetworks AND 2) the originating device complies with the\nlisted device policy AND 3) all listed access levels are granted AND 4) the\nrequest was sent at a time allowed by the DateTimeRestriction.",
|
||||
"id": "Condition",
|
||||
@@ -750,6 +717,17 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CustomLevel": {
|
||||
"description": "`CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language\nto represent the necessary conditions for the level to apply to a request.\nSee CEL spec at: https://github.com/google/cel-spec",
|
||||
"id": "CustomLevel",
|
||||
"properties": {
|
||||
"expr": {
|
||||
"$ref": "Expr",
|
||||
"description": "Required. A Cloud CEL expression evaluating to a boolean."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DevicePolicy": {
|
||||
"description": "`DevicePolicy` specifies device specific restrictions necessary to acquire a\ngiven access level. A `DevicePolicy` specifies requirements for requests from\ndevices to be granted access levels, it does not do any enforcement on the\ndevice. `DevicePolicy` acts as an AND over all specified fields, and each\nrepeated field is an OR over its elements. Any unset fields are ignored. For\nexample, if the proto is { os_type : DESKTOP_WINDOWS, os_type :\nDESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be\ntrue for requests originating from encrypted Linux desktops and encrypted\nWindows desktops.",
|
||||
"id": "DevicePolicy",
|
||||
@@ -814,20 +792,25 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"IngressServiceRestriction": {
|
||||
"description": "Alpha. Specifies how Access Levels are to be used for accessing the Service\nPerimeter.",
|
||||
"id": "IngressServiceRestriction",
|
||||
"Expr": {
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"allowedServices": {
|
||||
"description": "The list of APIs usable with a valid Access Level. Must be empty unless\n'enable_restriction' is True.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
"description": {
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"enableRestriction": {
|
||||
"description": "Whether to restrict the set of APIs callable outside the Service\nPerimeter via Access Levels.",
|
||||
"type": "boolean"
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -936,33 +919,32 @@
|
||||
"DESKTOP_MAC",
|
||||
"DESKTOP_WINDOWS",
|
||||
"DESKTOP_LINUX",
|
||||
"DESKTOP_CHROME_OS"
|
||||
"DESKTOP_CHROME_OS",
|
||||
"ANDROID",
|
||||
"IOS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The operating system of the device is not specified or not known.",
|
||||
"A desktop Mac operating system.",
|
||||
"A desktop Windows operating system.",
|
||||
"A desktop Linux operating system.",
|
||||
"A desktop ChromeOS operating system."
|
||||
"A desktop ChromeOS operating system.",
|
||||
"An Android operating system.",
|
||||
"An iOS operating system."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"requireVerifiedChromeOs": {
|
||||
"description": "Only allows requests from devices with a verified Chrome OS.\nVerifications includes requirements that the device is enterprise-managed,\nconformant to Dasher domain policies, and the caller has permission to call\nthe API targeted by the request.",
|
||||
"description": "Only allows requests from devices with a verified Chrome OS.\nVerifications includes requirements that the device is enterprise-managed,\nconformant to domain policies, and the caller has permission to call\nthe API targeted by the request.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ServicePerimeter": {
|
||||
"description": "`ServicePerimeter` describes a set of GCP resources which can freely import\nand export data amongst themselves, but not export outside of the\n`ServicePerimeter`. If a request with a source within this `ServicePerimeter`\nhas a target outside of the `ServicePerimeter`, the request will be blocked.\nOtherwise the request is allowed. There are two types of Service Perimeter -\nRegular and Bridge. Regular Service Perimeters cannot overlap, a single GCP\nproject can only belong to a single regular Service Perimeter. Service\nPerimeter Bridges can contain only GCP projects as members, a single GCP\nproject may belong to multiple Service Perimeter Bridges.",
|
||||
"description": "`ServicePerimeter` describes a set of Google Cloud resources which can freely\nimport and export data amongst themselves, but not export outside of the\n`ServicePerimeter`. If a request with a source within this `ServicePerimeter`\nhas a target outside of the `ServicePerimeter`, the request will be blocked.\nOtherwise the request is allowed. There are two types of Service Perimeter -\nRegular and Bridge. Regular Service Perimeters cannot overlap, a single\nGoogle Cloud project can only belong to a single regular Service Perimeter.\nService Perimeter Bridges can contain only Google Cloud projects as members,\na single Google Cloud project may belong to multiple Service Perimeter\nBridges.",
|
||||
"id": "ServicePerimeter",
|
||||
"properties": {
|
||||
"createTime": {
|
||||
"description": "Output only. Time the `ServicePerimeter` was created in UTC.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"description": "Description of the `ServicePerimeter` and its use. Does not affect\nbehavior.",
|
||||
"type": "string"
|
||||
@@ -990,58 +972,45 @@
|
||||
"title": {
|
||||
"description": "Human readable title. Must be unique within the Policy.",
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only. Time the `ServicePerimeter` was updated in UTC.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ServicePerimeterConfig": {
|
||||
"description": "`ServicePerimeterConfig` specifies a set of GCP resources that describe\nspecific Service Perimeter configuration.",
|
||||
"description": "`ServicePerimeterConfig` specifies a set of Google Cloud resources that\ndescribe specific Service Perimeter configuration.",
|
||||
"id": "ServicePerimeterConfig",
|
||||
"properties": {
|
||||
"accessLevels": {
|
||||
"description": "A list of `AccessLevel` resource names that allow resources within the\n`ServicePerimeter` to be accessed from the internet. `AccessLevels` listed\nmust be in the same policy as this `ServicePerimeter`. Referencing a\nnonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are\nlisted, resources within the perimeter can only be accessed via GCP calls\nwith request origins within the perimeter. Example:\n`\"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL\"`.\nFor Service Perimeter Bridge, must be empty.",
|
||||
"description": "A list of `AccessLevel` resource names that allow resources within the\n`ServicePerimeter` to be accessed from the internet. `AccessLevels` listed\nmust be in the same policy as this `ServicePerimeter`. Referencing a\nnonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are\nlisted, resources within the perimeter can only be accessed via Google\nCloud calls with request origins within the perimeter. Example:\n`\"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL\"`.\nFor Service Perimeter Bridge, must be empty.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"bridgeServiceRestriction": {
|
||||
"$ref": "BridgeServiceRestriction",
|
||||
"description": "Alpha. Configuration for what services are accessible via the Bridge\nPerimeter. Must be empty for non-Bridge Perimeters."
|
||||
},
|
||||
"ingressServiceRestriction": {
|
||||
"$ref": "IngressServiceRestriction",
|
||||
"description": "Alpha. Configuration for which services may be used with Access Levels."
|
||||
},
|
||||
"resources": {
|
||||
"description": "A list of GCP resources that are inside of the service perimeter.\nCurrently only projects are allowed. Format: `projects/{project_number}`",
|
||||
"description": "A list of Google Cloud resources that are inside of the service perimeter.\nCurrently only projects are allowed. Format: `projects/{project_number}`",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"restrictedServices": {
|
||||
"description": "GCP services that are subject to the Service Perimeter restrictions. Must\ncontain a list of services. For example, if\n`storage.googleapis.com` is specified, access to the storage buckets\ninside the perimeter must meet the perimeter's access restrictions.",
|
||||
"description": "Google Cloud services that are subject to the Service Perimeter\nrestrictions. Must contain a list of services. For example, if\n`storage.googleapis.com` is specified, access to the storage buckets\ninside the perimeter must meet the perimeter's access restrictions.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"unrestrictedServices": {
|
||||
"description": "GCP services that are not subject to the Service Perimeter\nrestrictions. Deprecated. Must be set to a single wildcard \"*\".\n\nThe wildcard means that unless explicitly specified by\n\"restricted_services\" list, any service is treated as unrestricted.",
|
||||
"description": "Google Cloud services that are not subject to the Service Perimeter\nrestrictions. Deprecated. Must be set to a single wildcard \"*\".\n\nThe wildcard means that unless explicitly specified by\n\"restricted_services\" list, any service is treated as unrestricted.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"vpcServiceRestriction": {
|
||||
"$ref": "VpcServiceRestriction",
|
||||
"description": "Alpha. Configuration for within Perimeter allowed APIs."
|
||||
"vpcAccessibleServices": {
|
||||
"$ref": "VpcAccessibleServices",
|
||||
"description": "Beta. Configuration for APIs allowed within Perimeter."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1073,9 +1042,9 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"VpcServiceRestriction": {
|
||||
"description": "Alpha. Specifies how APIs are allowed to communicate within the Service\nPerimeter.",
|
||||
"id": "VpcServiceRestriction",
|
||||
"VpcAccessibleServices": {
|
||||
"description": "Specifies how APIs are allowed to communicate within the Service\nPerimeter.",
|
||||
"id": "VpcAccessibleServices",
|
||||
"properties": {
|
||||
"allowedServices": {
|
||||
"description": "The list of APIs usable within the Service Perimeter. Must be empty\nunless 'enable_restriction' is True.",
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
"description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/uOrrz0XZXUWjq05UnBmp2O_KkFY\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/NqH-dIwRC63Jam7EMg3FwCUSX_o\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
|
||||
"x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
|
||||
@@ -259,7 +259,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190614",
|
||||
"revision": "20191204",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Account": {
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
"description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/hcIsQyAOKgIG-XNmjJJ2qekVMV8\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/q3PXuYjke5DLC1iS16IMMN2X5Kc\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
|
||||
"x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
|
||||
@@ -699,7 +699,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190614",
|
||||
"revision": "20191204",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Account": {
|
||||
@@ -886,6 +886,7 @@
|
||||
"adTechnologyProviders": {
|
||||
"properties": {
|
||||
"detectedProviderIds": {
|
||||
"description": "The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the Authorized Buyers Real-Time Bidding protocol or the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines.",
|
||||
"items": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
@@ -893,6 +894,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"hasUnidentifiedProvider": {
|
||||
"description": "Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
@@ -1571,6 +1573,11 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"maximumQps": {
|
||||
"description": "The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account-level limit may still be imposed).",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"mobileCarriers": {
|
||||
"description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
|
||||
"items": {
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
"description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/CMOrSNVn1gPVhDl3l-t_ud1epbY\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/jeeKbeKt3C57J6G4NBTg4KfprYo\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
|
||||
"x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
|
||||
@@ -1255,7 +1255,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190614",
|
||||
"revision": "20191204",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Account": {
|
||||
@@ -1573,6 +1573,7 @@
|
||||
"adTechnologyProviders": {
|
||||
"properties": {
|
||||
"detectedProviderIds": {
|
||||
"description": "The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the Authorized Buyers Real-Time Bidding protocol or the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines.",
|
||||
"items": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
@@ -1580,6 +1581,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"hasUnidentifiedProvider": {
|
||||
"description": "Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the \"Third-party Ad Technology Vendors\" section of Authorized Buyers Program Guidelines.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
@@ -2098,7 +2100,7 @@
|
||||
"id": "DealTerms",
|
||||
"properties": {
|
||||
"brandingType": {
|
||||
"description": "Visibilty of the URL in bid requests.",
|
||||
"description": "Visibility of the URL in bid requests.",
|
||||
"type": "string"
|
||||
},
|
||||
"crossListedExternalDealIdType": {
|
||||
@@ -2918,6 +2920,11 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"maximumQps": {
|
||||
"description": "The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account-level limit may still be imposed).",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"minimumViewabilityDecile": {
|
||||
"description": "Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored.",
|
||||
"format": "int32",
|
||||
|
||||
@@ -21,6 +21,7 @@
|
||||
},
|
||||
"id": "adexchangebuyer2:v2beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://adexchangebuyer.mtls.googleapis.com/",
|
||||
"name": "adexchangebuyer2",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -2485,7 +2486,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190701",
|
||||
"revision": "20200409",
|
||||
"rootUrl": "https://adexchangebuyer.googleapis.com/",
|
||||
"schemas": {
|
||||
"AbsoluteDateRange": {
|
||||
@@ -2653,7 +2654,7 @@
|
||||
},
|
||||
"impressionsWon": {
|
||||
"$ref": "MetricValue",
|
||||
"description": "The number of bids that won an impression."
|
||||
"description": "The number of bids that won the auction."
|
||||
},
|
||||
"measurableImpressions": {
|
||||
"$ref": "MetricValue",
|
||||
@@ -2693,8 +2694,8 @@
|
||||
"enumDescriptions": [
|
||||
"A placeholder for an undefined status.\nThis value will never be returned in responses.",
|
||||
"The response had no bids.",
|
||||
"The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.",
|
||||
"The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
|
||||
"The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.\nApplies if:\n1. Request is on behalf of a bidder and an account filter is present.\n2. Request is on behalf of a child seat.",
|
||||
"The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs. If request is on behalf of a bidder and an account filter is not\npresent, this also includes responses that have bids on behalf of\naccounts other than the account to which the deal belongs."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
@@ -3093,14 +3094,18 @@
|
||||
"NOT_CHECKED",
|
||||
"CONDITIONALLY_APPROVED",
|
||||
"APPROVED",
|
||||
"DISAPPROVED"
|
||||
"DISAPPROVED",
|
||||
"PENDING_REVIEW",
|
||||
"STATUS_TYPE_UNSPECIFIED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The status is unknown.",
|
||||
"The creative has not been checked.",
|
||||
"The creative has been conditionally approved.\nSee serving_restrictions for details.",
|
||||
"The creative has been approved.",
|
||||
"The creative has been disapproved."
|
||||
"The creative has been disapproved.",
|
||||
"Placeholder for transition to v1beta1. Currently not used.",
|
||||
"Placeholder for transition to v1beta1. Currently not used."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -3171,14 +3176,18 @@
|
||||
"NOT_CHECKED",
|
||||
"CONDITIONALLY_APPROVED",
|
||||
"APPROVED",
|
||||
"DISAPPROVED"
|
||||
"DISAPPROVED",
|
||||
"PENDING_REVIEW",
|
||||
"STATUS_TYPE_UNSPECIFIED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The status is unknown.",
|
||||
"The creative has not been checked.",
|
||||
"The creative has been conditionally approved.\nSee serving_restrictions for details.",
|
||||
"The creative has been approved.",
|
||||
"The creative has been disapproved."
|
||||
"The creative has been disapproved.",
|
||||
"Placeholder for transition to v1beta1. Currently not used.",
|
||||
"Placeholder for transition to v1beta1. Currently not used."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -3939,7 +3948,8 @@
|
||||
"UNSUPPORTED_LANGUAGE",
|
||||
"NON_SSL_COMPLIANT",
|
||||
"TEMPORARY_PAUSE",
|
||||
"BAIL_BONDS"
|
||||
"BAIL_BONDS",
|
||||
"EXPERIMENTAL_MEDICAL_TREATMENT"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The length of the image animation is longer than allowed.",
|
||||
@@ -4042,7 +4052,8 @@
|
||||
"Unsupported language.",
|
||||
"Non-SSL compliant.",
|
||||
"Temporary pausing of creative.",
|
||||
"Promotes services related to bail bonds."
|
||||
"Promotes services related to bail bonds.",
|
||||
"Promotes speculative and/or experimental medical treatments."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
@@ -4101,8 +4112,26 @@
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"format": {
|
||||
"description": "Creative format bidded on or allowed to bid on, can be empty.",
|
||||
"enum": [
|
||||
"FORMAT_UNSPECIFIED",
|
||||
"NATIVE_DISPLAY",
|
||||
"NATIVE_VIDEO",
|
||||
"NON_NATIVE_DISPLAY",
|
||||
"NON_NATIVE_VIDEO"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
|
||||
"The ad impression is a native ad, and display (i.e., image) format.",
|
||||
"The ad impression is a native ad, and video format.",
|
||||
"The ad impression is not a native ad, and display (i.e., image) format.",
|
||||
"The ad impression is not a native ad, and video format."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"formats": {
|
||||
"description": "The list of formats on which to filter; may be empty. The filters\nrepresented by multiple formats are ORed together (i.e., if non-empty,\nresults must match any one of the formats).",
|
||||
"description": "Creative formats bidded on or allowed to bid on, can be empty. Although\nthis field is a list, it can only be populated with a single item. A\nHTTP 400 bad request error will be returned in the response if you specify\nmultiple items.",
|
||||
"enumDescriptions": [
|
||||
"A placeholder for an undefined format; indicates that no format filter\nwill be applied.",
|
||||
"The ad impression is a native ad, and display (i.e., image) format.",
|
||||
|
||||
@@ -1,13 +1,4 @@
|
||||
{
|
||||
"auth": {
|
||||
"oauth2": {
|
||||
"scopes": {
|
||||
"https://www.googleapis.com/auth/xapi.zoo": {
|
||||
"description": "Test scope for access to the Zoo service"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"basePath": "",
|
||||
"baseUrl": "https://adexperiencereport.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
@@ -21,6 +12,7 @@
|
||||
},
|
||||
"id": "adexperiencereport:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://adexperiencereport.mtls.googleapis.com/",
|
||||
"name": "adexperiencereport",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -106,7 +98,7 @@
|
||||
"sites": {
|
||||
"methods": {
|
||||
"get": {
|
||||
"description": "Gets a summary of the ad experience rating of a site.",
|
||||
"description": "Gets a site's Ad Experience Report summary.",
|
||||
"flatPath": "v1/sites/{sitesId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "adexperiencereport.sites.get",
|
||||
@@ -115,7 +107,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.",
|
||||
"description": "Required. The name of the site whose summary to get, e.g.\n`sites/http%3A%2F%2Fwww.google.com%2F`.\n\nFormat: `sites/{site}`",
|
||||
"location": "path",
|
||||
"pattern": "^sites/[^/]+$",
|
||||
"required": true,
|
||||
@@ -125,17 +117,14 @@
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "SiteSummaryResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/xapi.zoo"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"violatingSites": {
|
||||
"methods": {
|
||||
"list": {
|
||||
"description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".",
|
||||
"description": "Lists sites that are failing in the Ad Experience Report on at least one\nplatform.",
|
||||
"flatPath": "v1/violatingSites",
|
||||
"httpMethod": "GET",
|
||||
"id": "adexperiencereport.violatingSites.list",
|
||||
@@ -144,23 +133,20 @@
|
||||
"path": "v1/violatingSites",
|
||||
"response": {
|
||||
"$ref": "ViolatingSitesResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/xapi.zoo"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190624",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://adexperiencereport.googleapis.com/",
|
||||
"schemas": {
|
||||
"PlatformSummary": {
|
||||
"description": "Summary of the ad experience rating of a site for a specific platform.",
|
||||
"description": "A site's Ad Experience Report summary on a single platform.",
|
||||
"id": "PlatformSummary",
|
||||
"properties": {
|
||||
"betterAdsStatus": {
|
||||
"description": "The status of the site reviewed for the Better Ads Standards.",
|
||||
"description": "The site's Ad Experience Report status on this platform.",
|
||||
"enum": [
|
||||
"UNKNOWN",
|
||||
"PASSING",
|
||||
@@ -170,18 +156,18 @@
|
||||
"enumDescriptions": [
|
||||
"Not reviewed.",
|
||||
"Passing.",
|
||||
"Warning.",
|
||||
"Warning. No longer a possible status.",
|
||||
"Failing."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"enforcementTime": {
|
||||
"description": "The date on which ad filtering begins.",
|
||||
"description": "The time at which\n[enforcement](https://support.google.com/webtools/answer/7308033) against\nthe site began or will begin on this platform.\n\nNot set when the\nfilter_status\nis OFF.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"filterStatus": {
|
||||
"description": "The ad filtering status of the site.",
|
||||
"description": "The site's [enforcement\nstatus](https://support.google.com/webtools/answer/7308033) on this\nplatform.",
|
||||
"enum": [
|
||||
"UNKNOWN",
|
||||
"ON",
|
||||
@@ -199,12 +185,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"lastChangeTime": {
|
||||
"description": "The last time that the site changed status.",
|
||||
"description": "The time at which the site's status last changed on this platform.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"region": {
|
||||
"description": "The assigned regions for the site and platform.",
|
||||
"description": "The site's regions on this platform.\n\nNo longer populated, because there is no longer any semantic difference\nbetween sites in different regions.",
|
||||
"enumDescriptions": [
|
||||
"Ad standard not yet defined for your region.",
|
||||
"Region A.",
|
||||
@@ -223,11 +209,11 @@
|
||||
"type": "array"
|
||||
},
|
||||
"reportUrl": {
|
||||
"description": "A link that leads to a full ad experience report.",
|
||||
"description": "A link to the full Ad Experience Report for the site on this platform..\n\nNot set in\nViolatingSitesResponse.\n\nNote that you must complete the [Search Console verification\nprocess](https://support.google.com/webmasters/answer/9008080) for the site\nbefore you can access the full report.",
|
||||
"type": "string"
|
||||
},
|
||||
"underReview": {
|
||||
"description": "Whether the site is currently under review.",
|
||||
"description": "Whether the site is currently under review on this platform.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
@@ -239,14 +225,14 @@
|
||||
"properties": {
|
||||
"desktopSummary": {
|
||||
"$ref": "PlatformSummary",
|
||||
"description": "Summary for the desktop review of the site."
|
||||
"description": "The site's Ad Experience Report summary on desktop."
|
||||
},
|
||||
"mobileSummary": {
|
||||
"$ref": "PlatformSummary",
|
||||
"description": "Summary for the mobile review of the site."
|
||||
"description": "The site's Ad Experience Report summary on mobile."
|
||||
},
|
||||
"reviewedSite": {
|
||||
"description": "The name of the site reviewed.",
|
||||
"description": "The name of the reviewed site, e.g. `google.com`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -257,7 +243,7 @@
|
||||
"id": "ViolatingSitesResponse",
|
||||
"properties": {
|
||||
"violatingSites": {
|
||||
"description": "A list of summaries of violating sites.",
|
||||
"description": "The list of violating sites.",
|
||||
"items": {
|
||||
"$ref": "SiteSummaryResponse"
|
||||
},
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
"description": "Transfers user data from one user to another.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/admin-sdk/data-transfer/",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/sO76R3ImJWyHTWFAs7zvdNuGNOQ\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/o-H78Id0Lcq1iHheSzpqURY4CLE\"",
|
||||
"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"
|
||||
@@ -109,7 +109,7 @@
|
||||
"id": "datatransfer.applications.list",
|
||||
"parameters": {
|
||||
"customerId": {
|
||||
"description": "Immutable ID of the Google Apps account.",
|
||||
"description": "Immutable ID of the G Suite account.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -185,7 +185,7 @@
|
||||
"id": "datatransfer.transfers.list",
|
||||
"parameters": {
|
||||
"customerId": {
|
||||
"description": "Immutable ID of the Google Apps account.",
|
||||
"description": "Immutable ID of the G Suite account.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -230,7 +230,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20160223",
|
||||
"revision": "20191105",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Application": {
|
||||
@@ -256,7 +256,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"transferParams": {
|
||||
"description": "The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transfered.",
|
||||
"description": "The list of all possible transfer parameters for this application. These parameters can be used to select the data of the user in this application to be transferred.",
|
||||
"items": {
|
||||
"$ref": "ApplicationTransferParam"
|
||||
},
|
||||
@@ -275,7 +275,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"applicationTransferParams": {
|
||||
"description": "The transfer parameters for the application. These parameters are used to select the data which will get transfered in context of this application.",
|
||||
"description": "The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application.",
|
||||
"items": {
|
||||
"$ref": "ApplicationTransferParam"
|
||||
},
|
||||
@@ -297,7 +297,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"description": "The value of the coressponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
|
||||
"description": "The value of the corresponding transfer parameter. eg: 'PRIVATE' or 'SHARED'",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -358,11 +358,11 @@
|
||||
"type": "string"
|
||||
},
|
||||
"newOwnerUserId": {
|
||||
"description": "ID of the user to whom the data is being transfered.",
|
||||
"description": "ID of the user to whom the data is being transferred.",
|
||||
"type": "string"
|
||||
},
|
||||
"oldOwnerUserId": {
|
||||
"description": "ID of the user whose data is being transfered.",
|
||||
"description": "ID of the user whose data is being transferred.",
|
||||
"type": "string"
|
||||
},
|
||||
"overallTransferStatusCode": {
|
||||
|
||||
@@ -82,6 +82,9 @@
|
||||
},
|
||||
"https://www.googleapis.com/auth/admin.directory.userschema.readonly": {
|
||||
"description": "View user schemas on your domain"
|
||||
},
|
||||
"https://www.googleapis.com/auth/cloud-platform": {
|
||||
"description": "View and manage your data across Google Cloud Platform services"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -93,7 +96,7 @@
|
||||
"description": "Manages enterprise resources such as users and groups, administrative notifications, security features, and more.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/admin-sdk/directory/",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/eWNDpeAZuk1gV8zhFqMfz4qmrho\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/Q_N7e9cs3A1-s8__TCCHlsbCI_c\"",
|
||||
"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"
|
||||
@@ -252,7 +255,8 @@
|
||||
"https://www.googleapis.com/auth/admin.directory.user",
|
||||
"https://www.googleapis.com/auth/admin.directory.user.alias",
|
||||
"https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
|
||||
"https://www.googleapis.com/auth/admin.directory.user.readonly"
|
||||
"https://www.googleapis.com/auth/admin.directory.user.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
@@ -348,7 +352,8 @@
|
||||
"type": "string"
|
||||
},
|
||||
"maxResults": {
|
||||
"description": "Maximum number of results to return. Default is 100",
|
||||
"default": "100",
|
||||
"description": "Maximum number of results to return. Max allowed value is 200.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"minimum": "1",
|
||||
@@ -938,7 +943,8 @@
|
||||
"type": "string"
|
||||
},
|
||||
"maxResults": {
|
||||
"description": "Maximum number of results to return. Default is 200",
|
||||
"default": "200",
|
||||
"description": "Maximum number of results to return. Max allowed value is 200.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"minimum": "1",
|
||||
@@ -979,7 +985,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"userKey": {
|
||||
"description": "Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object",
|
||||
"description": "Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -1274,7 +1280,8 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"maxResults": {
|
||||
"description": "Maximum number of results to return. Default is 200",
|
||||
"default": "200",
|
||||
"description": "Maximum number of results to return. Max allowed value is 200.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"minimum": "1",
|
||||
@@ -1492,7 +1499,8 @@
|
||||
"type": "string"
|
||||
},
|
||||
"maxResults": {
|
||||
"description": "Maximum number of results to return. Default is 100",
|
||||
"default": "100",
|
||||
"description": "Maximum number of results to return. Max allowed value is 100.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"minimum": "1",
|
||||
@@ -1967,28 +1975,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"resolvedAppAccessSettings": {
|
||||
"methods": {
|
||||
"GetSettings": {
|
||||
"description": "Retrieves resolved app access settings of the logged in user.",
|
||||
"httpMethod": "GET",
|
||||
"id": "directory.resolvedAppAccessSettings.GetSettings",
|
||||
"path": "resolvedappaccesssettings",
|
||||
"response": {
|
||||
"$ref": "AppAccessCollections"
|
||||
}
|
||||
},
|
||||
"ListTrustedApps": {
|
||||
"description": "Retrieves the list of apps trusted by the admin of the logged in user.",
|
||||
"httpMethod": "GET",
|
||||
"id": "directory.resolvedAppAccessSettings.ListTrustedApps",
|
||||
"path": "trustedapps",
|
||||
"response": {
|
||||
"$ref": "TrustedApps"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"resources": {
|
||||
"buildings": {
|
||||
@@ -3378,7 +3364,8 @@
|
||||
"type": "string"
|
||||
},
|
||||
"maxResults": {
|
||||
"description": "Maximum number of results to return. Default is 100. Max allowed is 500",
|
||||
"default": "100",
|
||||
"description": "Maximum number of results to return.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"maximum": "500",
|
||||
@@ -3427,7 +3414,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"showDeleted": {
|
||||
"description": "If set to true retrieves the list of deleted users. Default is false",
|
||||
"description": "If set to true, retrieves the list of deleted users. (Default: false)",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -3465,7 +3452,8 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/admin.directory.user",
|
||||
"https://www.googleapis.com/auth/admin.directory.user.readonly"
|
||||
"https://www.googleapis.com/auth/admin.directory.user.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
],
|
||||
"supportsSubscription": true
|
||||
},
|
||||
@@ -3607,7 +3595,8 @@
|
||||
"type": "string"
|
||||
},
|
||||
"maxResults": {
|
||||
"description": "Maximum number of results to return. Default is 100. Max allowed is 500",
|
||||
"default": "100",
|
||||
"description": "Maximum number of results to return.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"maximum": "500",
|
||||
@@ -3656,7 +3645,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"showDeleted": {
|
||||
"description": "If set to true retrieves the list of deleted users. Default is false",
|
||||
"description": "If set to true, retrieves the list of deleted users. (Default: false)",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -3698,7 +3687,8 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/admin.directory.user",
|
||||
"https://www.googleapis.com/auth/admin.directory.user.readonly"
|
||||
"https://www.googleapis.com/auth/admin.directory.user.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
],
|
||||
"supportsSubscription": true
|
||||
}
|
||||
@@ -4017,7 +4007,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190214",
|
||||
"revision": "20200204",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Alias": {
|
||||
@@ -4071,50 +4061,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AppAccessCollections": {
|
||||
"description": "JSON template for App Access Collections Resource object in Directory API.",
|
||||
"id": "AppAccessCollections",
|
||||
"properties": {
|
||||
"blockedApiAccessBuckets": {
|
||||
"description": "List of blocked api access buckets.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"enforceSettingsForAndroidDrive": {
|
||||
"description": "Boolean to indicate whether to enforce app access settings on Android Drive or not.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"errorMessage": {
|
||||
"description": "Error message provided by the Admin that will be shown to the user when an app is blocked.",
|
||||
"type": "string"
|
||||
},
|
||||
"etag": {
|
||||
"description": "ETag of the resource.",
|
||||
"type": "string"
|
||||
},
|
||||
"kind": {
|
||||
"default": "admin#directory#appaccesscollection",
|
||||
"description": "Identifies the resource as an app access collection. Value: admin#directory#appaccesscollection",
|
||||
"type": "string"
|
||||
},
|
||||
"resourceId": {
|
||||
"description": "Unique ID of app access collection. (Readonly)",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"resourceName": {
|
||||
"description": "Resource name given by the customer while creating/updating. Should be unique under given customer.",
|
||||
"type": "string"
|
||||
},
|
||||
"trustDomainOwnedApps": {
|
||||
"description": "Boolean that indicates whether to trust domain owned apps.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Asp": {
|
||||
"description": "The template that returns individual ASP (Access Code) data.",
|
||||
"id": "Asp",
|
||||
@@ -4494,6 +4440,11 @@
|
||||
"description": "User of the device",
|
||||
"type": "string"
|
||||
},
|
||||
"autoUpdateExpiration": {
|
||||
"description": "(Read-only) The timestamp after which the device will stop receiving Chrome updates or support",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"bootMode": {
|
||||
"description": "Chromebook boot mode (Read-only)",
|
||||
"type": "string"
|
||||
@@ -4599,6 +4550,10 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"dockMacAddress": {
|
||||
"description": "(Read-only) Built-in MAC address for the docking station that the device connected to. Factory sets Media access control address (MAC address) assigned for use by a dock. Currently this is only supported on the Dell Arcada / Sarien devices and the Dell WD19 / WD19TB Docking Station. It is reserved specifically for MAC pass through device policy. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for Dell devices.",
|
||||
"type": "string"
|
||||
},
|
||||
"etag": {
|
||||
"description": "ETag of the resource.",
|
||||
"type": "string"
|
||||
@@ -4607,6 +4562,10 @@
|
||||
"description": "Chromebook Mac Address on ethernet network interface (Read-only)",
|
||||
"type": "string"
|
||||
},
|
||||
"ethernetMacAddress0": {
|
||||
"description": "(Read-only) MAC address used by the Chromebook\u2019s internal ethernet port, and for onboard network (ethernet) interface. The format is twelve (12) hexadecimal digits without any delimiter (uppercase letters). This is only relevant for some devices.",
|
||||
"type": "string"
|
||||
},
|
||||
"firmwareVersion": {
|
||||
"description": "Chromebook firmware version (Read-only)",
|
||||
"type": "string"
|
||||
@@ -4630,8 +4589,12 @@
|
||||
"description": "Chromebook Mac Address on wifi network interface (Read-only)",
|
||||
"type": "string"
|
||||
},
|
||||
"manufactureDate": {
|
||||
"description": "(Read-only) The date the device was manufactured in yyyy-mm-dd format.",
|
||||
"type": "string"
|
||||
},
|
||||
"meid": {
|
||||
"description": "Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)",
|
||||
"description": "Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only)",
|
||||
"type": "string"
|
||||
},
|
||||
"model": {
|
||||
@@ -5216,7 +5179,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"description": "Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)",
|
||||
"description": "The unique ID of the group member. A member id can be used as a member request URI's memberKey. Unique identifier of group (Read-only) Unique identifier of member (Read-only)",
|
||||
"type": "string"
|
||||
},
|
||||
"kind": {
|
||||
@@ -5709,7 +5672,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"serviceId": {
|
||||
"description": "The obfuscated ID of the service this privilege is for.",
|
||||
"description": "The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list().",
|
||||
"type": "string"
|
||||
},
|
||||
"serviceName": {
|
||||
@@ -5795,7 +5758,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"serviceId": {
|
||||
"description": "The obfuscated ID of the service this privilege is for.",
|
||||
"description": "The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list().",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -6116,59 +6079,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TrustedAppId": {
|
||||
"description": "JSON template for Trusted App Ids Resource object in Directory API.",
|
||||
"id": "TrustedAppId",
|
||||
"properties": {
|
||||
"androidPackageName": {
|
||||
"description": "Android package name.",
|
||||
"type": "string"
|
||||
},
|
||||
"certificateHashSHA1": {
|
||||
"description": "SHA1 signature of the app certificate.",
|
||||
"type": "string"
|
||||
},
|
||||
"certificateHashSHA256": {
|
||||
"description": "SHA256 signature of the app certificate.",
|
||||
"type": "string"
|
||||
},
|
||||
"etag": {
|
||||
"type": "string"
|
||||
},
|
||||
"kind": {
|
||||
"default": "admin#directory#trustedappid",
|
||||
"description": "Identifies the resource as a trusted AppId.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TrustedApps": {
|
||||
"description": "JSON template for Trusted Apps response object of a user in Directory API.",
|
||||
"id": "TrustedApps",
|
||||
"properties": {
|
||||
"etag": {
|
||||
"description": "ETag of the resource.",
|
||||
"type": "string"
|
||||
},
|
||||
"kind": {
|
||||
"default": "admin#directory#trustedapplist",
|
||||
"description": "Identifies the resource as trusted apps response.",
|
||||
"type": "string"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"type": "string"
|
||||
},
|
||||
"trustedApps": {
|
||||
"description": "Trusted Apps list.",
|
||||
"items": {
|
||||
"$ref": "TrustedAppId"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"User": {
|
||||
"description": "JSON template for User object in Directory API.",
|
||||
"id": "User",
|
||||
@@ -6350,6 +6260,14 @@
|
||||
"description": "username of User",
|
||||
"type": "string"
|
||||
},
|
||||
"recoveryEmail": {
|
||||
"description": "Recovery email of the user.",
|
||||
"type": "string"
|
||||
},
|
||||
"recoveryPhone": {
|
||||
"description": "Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.",
|
||||
"type": "string"
|
||||
},
|
||||
"relations": {
|
||||
"type": "any"
|
||||
},
|
||||
@@ -6693,7 +6611,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"fullTimeEquivalent": {
|
||||
"description": "The full-time equivalent percent within the organization (100000 = 100%).",
|
||||
"description": "The full-time equivalent millipercent within the organization (100000 = 100%).",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
|
||||
@@ -17,8 +17,8 @@
|
||||
"canonicalName": "reports",
|
||||
"description": "Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/admin-sdk/reports/",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Tjl9ZZXM6pyNHTApQara35wGpUg\"",
|
||||
"documentationLink": "/admin-sdk/reports/",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/cjy_qN1sx94qX1efDr-Kt6Rsqlk\"",
|
||||
"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"
|
||||
@@ -79,7 +79,7 @@
|
||||
"activities": {
|
||||
"methods": {
|
||||
"list": {
|
||||
"description": "Retrieves a list of activities for a specific customer and application.",
|
||||
"description": "Retrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For more information, see the guides for administrator and Google Drive activity reports. For more information about the activity report's parameters, see the activity parameters reference guides.",
|
||||
"httpMethod": "GET",
|
||||
"id": "reports.activities.list",
|
||||
"parameterOrder": [
|
||||
@@ -88,42 +88,81 @@
|
||||
],
|
||||
"parameters": {
|
||||
"actorIpAddress": {
|
||||
"description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
|
||||
"description": "The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"applicationName": {
|
||||
"description": "Application name for which the events are to be retrieved.",
|
||||
"enum": [
|
||||
"access_transparency",
|
||||
"admin",
|
||||
"calendar",
|
||||
"chat",
|
||||
"drive",
|
||||
"gcp",
|
||||
"gplus",
|
||||
"groups",
|
||||
"groups_enterprise",
|
||||
"jamboard",
|
||||
"login",
|
||||
"meet",
|
||||
"mobile",
|
||||
"rules",
|
||||
"saml",
|
||||
"token",
|
||||
"user_accounts"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The G Suite Access Transparency activity reports return information about different types of Access Transparency activity events.",
|
||||
"The Admin console application's activity reports return account information about different types of administrator activity events.",
|
||||
"The G Suite Calendar application's activity reports return information about various Calendar activity events.",
|
||||
"The Chat activity reports return information about various Chat activity events.",
|
||||
"The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for G Suite Business customers.",
|
||||
"The Google Cloud Platform application's activity reports return information about various GCP activity events.",
|
||||
"The Google+ application's activity reports return information about various Google+ activity events.",
|
||||
"The Google Groups application's activity reports return information about various Groups activity events.",
|
||||
"The Enterprise Groups activity reports return information about various Enterprise group activity events.",
|
||||
"The Jamboard activity reports return information about various Jamboard activity events.",
|
||||
"The Login application's activity reports return account information about different types of Login activity events.",
|
||||
"The Meet Audit activity report return information about different types of Meet Audit activity events.",
|
||||
"The Mobile Audit activity report return information about different types of Mobile Audit activity events.",
|
||||
"The Rules activity report return information about different types of Rules activity events.",
|
||||
"The SAML activity report return information about different types of SAML activity events.",
|
||||
"The Token application's activity reports return account information about different types of Token activity events.",
|
||||
"The User Accounts application's activity reports return account information about different types of User Accounts activity events."
|
||||
],
|
||||
"location": "path",
|
||||
"pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)|(groups_enterprise)",
|
||||
"pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)|(groups_enterprise)|(gcp)",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"customerId": {
|
||||
"description": "Represents the customer for which the data is to be fetched.",
|
||||
"description": "The unique ID of the customer to retrieve data for.",
|
||||
"location": "query",
|
||||
"pattern": "C.+",
|
||||
"type": "string"
|
||||
},
|
||||
"endTime": {
|
||||
"description": "Return events which occurred at or before this time.",
|
||||
"description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: \n- Date of the API's request for a report: When the API created and retrieved the report. \n- Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. \n- Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past.",
|
||||
"location": "query",
|
||||
"pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
|
||||
"type": "string"
|
||||
},
|
||||
"eventName": {
|
||||
"description": "Name of the event being queried.",
|
||||
"description": "The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"filters": {
|
||||
"description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
|
||||
"description": "The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],... \nThese event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName.\n\nIn the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E):\nGET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS\n\nIn the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E):\n\nGET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765\n\nThe relational operators include: \n- == - 'equal to'. \n- <> - 'not equal to'. It is URL-encoded (%3C%3E). \n- < - 'less than'. It is URL-encoded (%3C). \n- <= - 'less than or equal to'. It is URL-encoded (%3C=). \n- > - 'greater than'. It is URL-encoded (%3E). \n- >= - 'greater than or equal to'. It is URL-encoded (%3E=). \nNote: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter.\nIn addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned.",
|
||||
"location": "query",
|
||||
"pattern": "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)",
|
||||
"type": "string"
|
||||
},
|
||||
"maxResults": {
|
||||
"description": "Number of activity records to be shown in each page.",
|
||||
"default": "1000",
|
||||
"description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"maximum": "1000",
|
||||
@@ -132,24 +171,24 @@
|
||||
},
|
||||
"orgUnitID": {
|
||||
"default": "",
|
||||
"description": "the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)",
|
||||
"description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
|
||||
"location": "query",
|
||||
"pattern": "(id:[a-z0-9]+)",
|
||||
"type": "string"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Token to specify next page.",
|
||||
"description": "The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"startTime": {
|
||||
"description": "Return events which occurred at or after this time.",
|
||||
"description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.",
|
||||
"location": "query",
|
||||
"pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
|
||||
"type": "string"
|
||||
},
|
||||
"userKey": {
|
||||
"description": "Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.",
|
||||
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -165,7 +204,7 @@
|
||||
"supportsSubscription": true
|
||||
},
|
||||
"watch": {
|
||||
"description": "Push changes to activities",
|
||||
"description": "Start receiving notifications for account activities. For more information, see Receiving Push Notifications.",
|
||||
"httpMethod": "POST",
|
||||
"id": "reports.activities.watch",
|
||||
"parameterOrder": [
|
||||
@@ -174,42 +213,81 @@
|
||||
],
|
||||
"parameters": {
|
||||
"actorIpAddress": {
|
||||
"description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
|
||||
"description": "The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"applicationName": {
|
||||
"description": "Application name for which the events are to be retrieved.",
|
||||
"enum": [
|
||||
"access_transparency",
|
||||
"admin",
|
||||
"calendar",
|
||||
"chat",
|
||||
"drive",
|
||||
"gcp",
|
||||
"gplus",
|
||||
"groups",
|
||||
"groups_enterprise",
|
||||
"jamboard",
|
||||
"login",
|
||||
"meet",
|
||||
"mobile",
|
||||
"rules",
|
||||
"saml",
|
||||
"token",
|
||||
"user_accounts"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The G Suite Access Transparency activity reports return information about different types of Access Transparency activity events.",
|
||||
"The Admin console application's activity reports return account information about different types of administrator activity events.",
|
||||
"The G Suite Calendar application's activity reports return information about various Calendar activity events.",
|
||||
"The Chat activity reports return information about various Chat activity events.",
|
||||
"The Google Drive application's activity reports return information about various Google Drive activity events. The Drive activity report is only available for G Suite Business customers.",
|
||||
"The Google Cloud Platform application's activity reports return information about various GCP activity events.",
|
||||
"The Google+ application's activity reports return information about various Google+ activity events.",
|
||||
"The Google Groups application's activity reports return information about various Groups activity events.",
|
||||
"The Enterprise Groups activity reports return information about various Enterprise group activity events.",
|
||||
"The Jamboard activity reports return information about various Jamboard activity events.",
|
||||
"The Login application's activity reports return account information about different types of Login activity events.",
|
||||
"The Meet Audit activity report return information about different types of Meet Audit activity events.",
|
||||
"The Mobile Audit activity report return information about different types of Mobile Audit activity events.",
|
||||
"The Rules activity report return information about different types of Rules activity events.",
|
||||
"The SAML activity report return information about different types of SAML activity events.",
|
||||
"The Token application's activity reports return account information about different types of Token activity events.",
|
||||
"The User Accounts application's activity reports return account information about different types of User Accounts activity events."
|
||||
],
|
||||
"location": "path",
|
||||
"pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)|(groups_enterprise)",
|
||||
"pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)|(groups_enterprise)|(gcp)",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"customerId": {
|
||||
"description": "Represents the customer for which the data is to be fetched.",
|
||||
"description": "The unique ID of the customer to retrieve data for.",
|
||||
"location": "query",
|
||||
"pattern": "C.+",
|
||||
"type": "string"
|
||||
},
|
||||
"endTime": {
|
||||
"description": "Return events which occurred at or before this time.",
|
||||
"description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: \n- Date of the API's request for a report: When the API created and retrieved the report. \n- Report's start time: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. \n- Report's end time: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past.",
|
||||
"location": "query",
|
||||
"pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
|
||||
"type": "string"
|
||||
},
|
||||
"eventName": {
|
||||
"description": "Name of the event being queried.",
|
||||
"description": "The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"filters": {
|
||||
"description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
|
||||
"description": "The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form [parameter1 name][relational operator][parameter1 value],[parameter2 name][relational operator][parameter2 value],... \nThese event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName.\n\nIn the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E):\nGET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS\n\nIn the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E):\n\nGET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765\n\nThe relational operators include: \n- == - 'equal to'. \n- <> - 'not equal to'. It is URL-encoded (%3C%3E). \n- < - 'less than'. It is URL-encoded (%3C). \n- <= - 'less than or equal to'. It is URL-encoded (%3C=). \n- > - 'greater than'. It is URL-encoded (%3E). \n- >= - 'greater than or equal to'. It is URL-encoded (%3E=). \nNote: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter.\nIn addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned.",
|
||||
"location": "query",
|
||||
"pattern": "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)",
|
||||
"type": "string"
|
||||
},
|
||||
"maxResults": {
|
||||
"description": "Number of activity records to be shown in each page.",
|
||||
"default": "1000",
|
||||
"description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"maximum": "1000",
|
||||
@@ -218,24 +296,24 @@
|
||||
},
|
||||
"orgUnitID": {
|
||||
"default": "",
|
||||
"description": "the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)",
|
||||
"description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
|
||||
"location": "query",
|
||||
"pattern": "(id:[a-z0-9]+)",
|
||||
"type": "string"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Token to specify next page.",
|
||||
"description": "The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"startTime": {
|
||||
"description": "Return events which occurred at or after this time.",
|
||||
"description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.",
|
||||
"location": "query",
|
||||
"pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
|
||||
"type": "string"
|
||||
},
|
||||
"userKey": {
|
||||
"description": "Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.",
|
||||
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -276,7 +354,7 @@
|
||||
"customerUsageReports": {
|
||||
"methods": {
|
||||
"get": {
|
||||
"description": "Retrieves a report which is a collection of properties / statistics for a specific customer.",
|
||||
"description": "Retrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report guide. For more information about the customer report's parameters, see the Customers Usage parameters reference guides.",
|
||||
"httpMethod": "GET",
|
||||
"id": "reports.customerUsageReports.get",
|
||||
"parameterOrder": [
|
||||
@@ -284,25 +362,25 @@
|
||||
],
|
||||
"parameters": {
|
||||
"customerId": {
|
||||
"description": "Represents the customer for which the data is to be fetched.",
|
||||
"description": "The unique ID of the customer to retrieve data for.",
|
||||
"location": "query",
|
||||
"pattern": "C.+",
|
||||
"type": "string"
|
||||
},
|
||||
"date": {
|
||||
"description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
|
||||
"description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
|
||||
"location": "path",
|
||||
"pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Token to specify next page.",
|
||||
"description": "Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parameters": {
|
||||
"description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
|
||||
"description": "The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites.\nA parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2.\nNote: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter.\nIn addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters.\n\nAn example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.",
|
||||
"location": "query",
|
||||
"pattern": "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)",
|
||||
"type": "string"
|
||||
@@ -321,7 +399,7 @@
|
||||
"entityUsageReports": {
|
||||
"methods": {
|
||||
"get": {
|
||||
"description": "Retrieves a report which is a collection of properties / statistics for a set of objects.",
|
||||
"description": "Retrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities Usage Report guide. For more information about the entities report's parameters, see the Entities Usage parameters reference guides.",
|
||||
"httpMethod": "GET",
|
||||
"id": "reports.entityUsageReports.get",
|
||||
"parameterOrder": [
|
||||
@@ -331,51 +409,67 @@
|
||||
],
|
||||
"parameters": {
|
||||
"customerId": {
|
||||
"description": "Represents the customer for which the data is to be fetched.",
|
||||
"description": "The unique ID of the customer to retrieve data for.",
|
||||
"location": "query",
|
||||
"pattern": "C.+",
|
||||
"type": "string"
|
||||
},
|
||||
"date": {
|
||||
"description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
|
||||
"description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
|
||||
"location": "path",
|
||||
"pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"entityKey": {
|
||||
"description": "Represents the key of object for which the data should be filtered.",
|
||||
"description": "Represents the key of the object to filter the data with.",
|
||||
"enum": [
|
||||
"all",
|
||||
"entityKey"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Returns activity events for all users.",
|
||||
"Represents an app-specific identifier for the entity. For details on how to obtain the entityKey for a particular entityType, see the Entities Usage parameters reference guides."
|
||||
],
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"entityType": {
|
||||
"description": "Type of object. Should be one of - gplus_communities.",
|
||||
"description": "Represents the type of entity for the report.",
|
||||
"enum": [
|
||||
"gplus_communities"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Returns a report on Google+ communities."
|
||||
],
|
||||
"location": "path",
|
||||
"pattern": "(gplus_communities)",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"filters": {
|
||||
"description": "Represents the set of filters including parameter operator value.",
|
||||
"description": "The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include accounts, docs, and gmail.\nFilters are in the form [application name]:[parameter name][relational operator][parameter value],....\n\nIn this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E):\nGET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members>0\n\n\nThe relational operators include: \n- == - 'equal to'. \n- <> - 'not equal to'. It is URL-encoded (%3C%3E). \n- < - 'less than'. It is URL-encoded (%3C). \n- <= - 'less than or equal to'. It is URL-encoded (%3C=). \n- > - 'greater than'. It is URL-encoded (%3E). \n- >= - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.",
|
||||
"location": "query",
|
||||
"pattern": "(((gplus)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((gplus)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)",
|
||||
"type": "string"
|
||||
},
|
||||
"maxResults": {
|
||||
"description": "Maximum number of results to return. Maximum allowed is 1000",
|
||||
"default": "1000",
|
||||
"description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page.",
|
||||
"format": "uint32",
|
||||
"location": "query",
|
||||
"maximum": "1000",
|
||||
"minimum": "1",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Token to specify next page.",
|
||||
"description": "Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parameters": {
|
||||
"description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
|
||||
"description": "The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Entities usage report are only gplus.\nA parameter query string is in the CSV form of [app_name1:param_name1], [app_name2:param_name2]....\nNote: The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter.\nIn addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters.\n\nAn example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.",
|
||||
"location": "query",
|
||||
"pattern": "(((gplus)):[^,]+,)*(((gplus)):[^,]+)",
|
||||
"type": "string"
|
||||
@@ -394,7 +488,7 @@
|
||||
"userUsageReport": {
|
||||
"methods": {
|
||||
"get": {
|
||||
"description": "Retrieves a report which is a collection of properties / statistics for a set of users.",
|
||||
"description": "Retrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report guide. For more information about the user report's parameters, see the Users Usage parameters reference guides.",
|
||||
"httpMethod": "GET",
|
||||
"id": "reports.userUsageReport.get",
|
||||
"parameterOrder": [
|
||||
@@ -403,51 +497,53 @@
|
||||
],
|
||||
"parameters": {
|
||||
"customerId": {
|
||||
"description": "Represents the customer for which the data is to be fetched.",
|
||||
"description": "The unique ID of the customer to retrieve data for.",
|
||||
"location": "query",
|
||||
"pattern": "C.+",
|
||||
"type": "string"
|
||||
},
|
||||
"date": {
|
||||
"description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
|
||||
"description": "Represents the date the usage occurred. The timestamp is in the ISO 8601 format, yyyy-mm-dd. We recommend you use your account's time zone for this.",
|
||||
"location": "path",
|
||||
"pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"filters": {
|
||||
"description": "Represents the set of filters including parameter operator value.",
|
||||
"description": "The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include accounts, docs, and gmail.\nFilters are in the form [application name]:[parameter name][relational operator][parameter value],....\n\nIn this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E):\nGET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time>2010-10-28T10:26:35.000Z\n\n\nThe relational operators include: \n- == - 'equal to'. \n- <> - 'not equal to'. It is URL-encoded (%3C%3E). \n- < - 'less than'. It is URL-encoded (%3C). \n- <= - 'less than or equal to'. It is URL-encoded (%3C=). \n- > - 'greater than'. It is URL-encoded (%3E). \n- >= - 'greater than or equal to'. It is URL-encoded (%3E=).",
|
||||
"location": "query",
|
||||
"pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)",
|
||||
"type": "string"
|
||||
},
|
||||
"maxResults": {
|
||||
"description": "Maximum number of results to return. Maximum allowed is 1000",
|
||||
"default": "1000",
|
||||
"description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page.\nThe maxResults query string is optional.",
|
||||
"format": "uint32",
|
||||
"location": "query",
|
||||
"maximum": "1000",
|
||||
"minimum": "1",
|
||||
"type": "integer"
|
||||
},
|
||||
"orgUnitID": {
|
||||
"default": "",
|
||||
"description": "the organizational unit's ID to filter usage parameters from users belonging to a specific OU or one of its sub-OU(s).",
|
||||
"description": "ID of the organizational unit to report on. User activity will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
|
||||
"location": "query",
|
||||
"pattern": "(id:[a-z0-9]+)",
|
||||
"type": "string"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Token to specify next page.",
|
||||
"description": "Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parameters": {
|
||||
"description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
|
||||
"description": "The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites.\nA parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2.\nNote: The API doesn't accept multiple values of a parameter.\nIf a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters.\n\nAn example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned.",
|
||||
"location": "query",
|
||||
"pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)",
|
||||
"type": "string"
|
||||
},
|
||||
"userKey": {
|
||||
"description": "Represents the profile id or the user email for which the data should be filtered.",
|
||||
"description": "Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -464,7 +560,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190521",
|
||||
"revision": "20191014",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Activities": {
|
||||
@@ -476,7 +572,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"items": {
|
||||
"description": "Each record in read response.",
|
||||
"description": "Each activity record in the response.",
|
||||
"items": {
|
||||
"$ref": "Activity"
|
||||
},
|
||||
@@ -484,11 +580,11 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "admin#reports#activities",
|
||||
"description": "Kind of list response this is.",
|
||||
"description": "The type of API resource. For an activity report, the value is reports#activities.",
|
||||
"type": "string"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "Token for retrieving the next page",
|
||||
"description": "Token for retrieving the follow-on next page of the report. The nextPageToken value is used in the request's pageToken query string.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -502,19 +598,19 @@
|
||||
"description": "User doing the action.",
|
||||
"properties": {
|
||||
"callerType": {
|
||||
"description": "User or OAuth 2LO request.",
|
||||
"description": "The type of actor.",
|
||||
"type": "string"
|
||||
},
|
||||
"email": {
|
||||
"description": "Email address of the user.",
|
||||
"description": "The primary email address of the actor. May be absent if there is no email address associated with the actor.",
|
||||
"type": "string"
|
||||
},
|
||||
"key": {
|
||||
"description": "For OAuth 2LO API requests, consumer_key of the requestor.",
|
||||
"description": "Only present when callerType is KEY. Can be the consumer_key of the requestor for OAuth 2LO API requests or an identifier for robot accounts.",
|
||||
"type": "string"
|
||||
},
|
||||
"profileId": {
|
||||
"description": "Obfuscated user id of the user.",
|
||||
"description": "The unique G Suite profile ID of the actor. May be absent if the actor is not a G Suite user.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -525,15 +621,15 @@
|
||||
"type": "string"
|
||||
},
|
||||
"events": {
|
||||
"description": "Activity events.",
|
||||
"description": "Activity events in the report.",
|
||||
"items": {
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "Name of event.",
|
||||
"description": "Name of the event. This is the specific name of the activity reported by the API. And each eventName is related to a specific G Suite service or feature which the API organizes into types of events.\nFor eventName request parameters in general: \n- If no eventName is given, the report returns all possible instances of an eventName. \n- When you request an eventName, the API's response returns all activities which contain that eventName. It is possible that the returned activities will have other eventName properties in addition to the one requested. \nFor more information about eventName properties, see the list of event names for various applications above in applicationName.",
|
||||
"type": "string"
|
||||
},
|
||||
"parameters": {
|
||||
"description": "Parameter value pairs for various applications.",
|
||||
"description": "Parameter value pairs for various applications. For more information about eventName parameters, see the list of event names for various applications above in applicationName.",
|
||||
"items": {
|
||||
"properties": {
|
||||
"boolValue": {
|
||||
@@ -541,15 +637,15 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"intValue": {
|
||||
"description": "Integral value of the parameter.",
|
||||
"description": "Integer value of the parameter.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"messageValue": {
|
||||
"description": "Nested value of the parameter.",
|
||||
"description": "Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as [{parameter: [{name: city, value: abc}]}]",
|
||||
"properties": {
|
||||
"parameter": {
|
||||
"description": "Looping to get parameter values.",
|
||||
"description": "Parameter values",
|
||||
"items": {
|
||||
"$ref": "NestedParameter"
|
||||
},
|
||||
@@ -559,7 +655,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"multiIntValue": {
|
||||
"description": "Multi-int value of the parameter.",
|
||||
"description": "Integer values of the parameter.",
|
||||
"items": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
@@ -567,11 +663,11 @@
|
||||
"type": "array"
|
||||
},
|
||||
"multiMessageValue": {
|
||||
"description": "Nested values of the parameter.",
|
||||
"description": "List of messageValue objects.",
|
||||
"items": {
|
||||
"properties": {
|
||||
"parameter": {
|
||||
"description": "Parameter value.",
|
||||
"description": "Parameter values",
|
||||
"items": {
|
||||
"$ref": "NestedParameter"
|
||||
},
|
||||
@@ -583,7 +679,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"multiValue": {
|
||||
"description": "Multi-string value of the parameter.",
|
||||
"description": "String values of the parameter.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -603,7 +699,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"type": {
|
||||
"description": "Type of event.",
|
||||
"description": "Type of event. The G Suite service or feature that an administrator changes is identified in the type property which identifies an event using the eventName property. For a full list of the API's type categories, see the list of event names for various applications above in applicationName.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -615,15 +711,15 @@
|
||||
"description": "Unique identifier for each activity record.",
|
||||
"properties": {
|
||||
"applicationName": {
|
||||
"description": "Application name to which the event belongs.",
|
||||
"description": "Application name to which the event belongs. For possible values see the list of applications above in applicationName.",
|
||||
"type": "string"
|
||||
},
|
||||
"customerId": {
|
||||
"description": "Obfuscated customer ID of the source customer.",
|
||||
"description": "The unique identifier for a G suite account.",
|
||||
"type": "string"
|
||||
},
|
||||
"time": {
|
||||
"description": "Time of occurrence of the activity.",
|
||||
"description": "Time of occurrence of the activity. This is in UNIX epoch time in seconds.",
|
||||
"format": "date-time",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -636,16 +732,16 @@
|
||||
"type": "object"
|
||||
},
|
||||
"ipAddress": {
|
||||
"description": "IP Address of the user doing the action.",
|
||||
"description": "IP address of the user doing the action. This is the Internet Protocol (IP) address of the user when logging into G Suite which may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. The API supports IPv4 and IPv6.",
|
||||
"type": "string"
|
||||
},
|
||||
"kind": {
|
||||
"default": "admin#reports#activity",
|
||||
"description": "Kind of resource this is.",
|
||||
"description": "The type of API resource. For an activity report, the value is audit#activity.",
|
||||
"type": "string"
|
||||
},
|
||||
"ownerDomain": {
|
||||
"description": "Domain of source customer.",
|
||||
"description": "This is the domain that is affected by the report's event. For example domain of Admin console or the Drive application's document owner.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -713,7 +809,7 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"intValue": {
|
||||
"description": "Integral value of the parameter.",
|
||||
"description": "Integer value of the parameter.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -725,7 +821,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"multiIntValue": {
|
||||
"description": "Multiple integral values of the parameter.",
|
||||
"description": "Multiple integer values of the parameter.",
|
||||
"items": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
@@ -755,7 +851,7 @@
|
||||
"id": "UsageReport",
|
||||
"properties": {
|
||||
"date": {
|
||||
"description": "The date to which the record belongs.",
|
||||
"description": "The date of the report request.",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
@@ -763,7 +859,7 @@
|
||||
"description": "Information about the type of the item.",
|
||||
"properties": {
|
||||
"customerId": {
|
||||
"description": "Obfuscated customer id for the record.",
|
||||
"description": "The unique identifier of the customer's account.",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
@@ -773,17 +869,17 @@
|
||||
"type": "string"
|
||||
},
|
||||
"profileId": {
|
||||
"description": "Obfuscated user id for the record.",
|
||||
"description": "The user's immutable G Suite profile identifier.",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The type of item, can be customer, user, or entity (aka. object).",
|
||||
"description": "The type of item. The value is customer.",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"userEmail": {
|
||||
"description": "user's email. Only relevant if entity.type = \"USER\"",
|
||||
"description": "The user's email address. Only relevant if entity.type = \"USER\"",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -797,11 +893,11 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "admin#reports#usageReport",
|
||||
"description": "The kind of object.",
|
||||
"description": "The type of API resource. For a usage report, the value is admin#reports#usageReport.",
|
||||
"type": "string"
|
||||
},
|
||||
"parameters": {
|
||||
"description": "Parameter value pairs for various applications.",
|
||||
"description": "Parameter value pairs for various applications. For the Customers usage report parameters and values, see the customer usage parameters reference.",
|
||||
"items": {
|
||||
"properties": {
|
||||
"boolValue": {
|
||||
@@ -810,13 +906,13 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"datetimeValue": {
|
||||
"description": "RFC 3339 formatted value of the parameter.",
|
||||
"description": "The RFC 3339 formatted value of the parameter, for example 2010-10-28T10:26:35.000Z.",
|
||||
"format": "date-time",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"intValue": {
|
||||
"description": "Integral value of the parameter.",
|
||||
"description": "Integer value of the parameter.",
|
||||
"format": "int64",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
@@ -833,7 +929,6 @@
|
||||
"type": "array"
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the parameter.",
|
||||
"type": "string"
|
||||
},
|
||||
"stringValue": {
|
||||
@@ -851,7 +946,6 @@
|
||||
"type": "object"
|
||||
},
|
||||
"UsageReports": {
|
||||
"description": "JSON template for a collection of usage reports.",
|
||||
"id": "UsageReports",
|
||||
"properties": {
|
||||
"etag": {
|
||||
@@ -860,11 +954,11 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "admin#reports#usageReports",
|
||||
"description": "The kind of object.",
|
||||
"description": "The type of API resource. For a usage report, the value is admin#reports#usageReports.",
|
||||
"type": "string"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "Token for retrieving the next page",
|
||||
"description": "Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string.",
|
||||
"type": "string"
|
||||
},
|
||||
"usageReports": {
|
||||
@@ -875,15 +969,15 @@
|
||||
"type": "array"
|
||||
},
|
||||
"warnings": {
|
||||
"description": "Warnings if any.",
|
||||
"description": "Warnings, if any.",
|
||||
"items": {
|
||||
"properties": {
|
||||
"code": {
|
||||
"description": "Machine readable code / warning type.",
|
||||
"description": "Machine readable code or warning type. The warning code value is 200.",
|
||||
"type": "string"
|
||||
},
|
||||
"data": {
|
||||
"description": "Key-Value pairs to give detailed information on the warning.",
|
||||
"description": "Key-value pairs to give detailed information on the warning.",
|
||||
"items": {
|
||||
"properties": {
|
||||
"key": {
|
||||
@@ -900,7 +994,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"message": {
|
||||
"description": "Human readable message for the warning.",
|
||||
"description": "The human readable messages for a warning are: \n- Data is not available warning - Sorry, data for date yyyy-mm-dd for application \"application name\" is not available. \n- Partial data is available warning - Data for date yyyy-mm-dd for application \"application name\" is not available right now, please try again after a few hours.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
950
etc/api/admob/v1/admob-api.json
Normal file
950
etc/api/admob/v1/admob-api.json
Normal file
@@ -0,0 +1,950 @@
|
||||
{
|
||||
"basePath": "",
|
||||
"baseUrl": "https://admob.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "AdMob",
|
||||
"description": "The Google AdMob API lets you programmatically get reports on earnings.\n",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/admob/api/",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
||||
},
|
||||
"id": "admob:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://admob.mtls.googleapis.com/",
|
||||
"name": "admob",
|
||||
"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 response.",
|
||||
"enum": [
|
||||
"json",
|
||||
"media",
|
||||
"proto"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"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",
|
||||
"type": "string"
|
||||
},
|
||||
"key": {
|
||||
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"oauth_token": {
|
||||
"description": "OAuth 2.0 token for the current user.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"prettyPrint": {
|
||||
"default": "true",
|
||||
"description": "Returns response with indentations and line breaks.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"quotaUser": {
|
||||
"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"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"protocol": "rest",
|
||||
"resources": {
|
||||
"accounts": {
|
||||
"methods": {
|
||||
"get": {
|
||||
"description": "Gets information about the specified AdMob publisher account.",
|
||||
"flatPath": "v1/accounts/{accountsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "admob.accounts.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Resource name of the publisher account to retrieve.\nExample: accounts/pub-9876543210987654",
|
||||
"location": "path",
|
||||
"pattern": "^accounts/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "PublisherAccount"
|
||||
}
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists the AdMob publisher account accessible with the client credential.\nCurrently, all credentials have access to at most one AdMob account.",
|
||||
"flatPath": "v1/accounts",
|
||||
"httpMethod": "GET",
|
||||
"id": "admob.accounts.list",
|
||||
"parameterOrder": [],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "Maximum number of accounts to return.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The value returned by the last `ListPublisherAccountsResponse`; indicates\nthat this is a continuation of a prior `ListPublisherAccounts` call, and\nthat the system should return the next page of data.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/accounts",
|
||||
"response": {
|
||||
"$ref": "ListPublisherAccountsResponse"
|
||||
}
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"mediationReport": {
|
||||
"methods": {
|
||||
"generate": {
|
||||
"description": "Generates an AdMob Mediation report based on the provided report\nspecification.",
|
||||
"flatPath": "v1/accounts/{accountsId}/mediationReport:generate",
|
||||
"httpMethod": "POST",
|
||||
"id": "admob.accounts.mediationReport.generate",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Resource name of the account to generate the report for.\nExample: accounts/pub-9876543210987654",
|
||||
"location": "path",
|
||||
"pattern": "^accounts/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/mediationReport:generate",
|
||||
"request": {
|
||||
"$ref": "GenerateMediationReportRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "GenerateMediationReportResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"networkReport": {
|
||||
"methods": {
|
||||
"generate": {
|
||||
"description": "Generates an AdMob Network report based on the provided report\nspecification.",
|
||||
"flatPath": "v1/accounts/{accountsId}/networkReport:generate",
|
||||
"httpMethod": "POST",
|
||||
"id": "admob.accounts.networkReport.generate",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Resource name of the account to generate the report for.\nExample: accounts/pub-9876543210987654",
|
||||
"location": "path",
|
||||
"pattern": "^accounts/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/networkReport:generate",
|
||||
"request": {
|
||||
"$ref": "GenerateNetworkReportRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "GenerateNetworkReportResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20200409",
|
||||
"rootUrl": "https://admob.googleapis.com/",
|
||||
"schemas": {
|
||||
"Date": {
|
||||
"description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day\nand time zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. This can represent:\n\n* A full date, with non-zero year, month and day values\n* A month and day value, with a zero year, e.g. an anniversary\n* A year on its own, with zero month and day values\n* A year and month value, with a zero day, e.g. a credit card expiration date\n\nRelated types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
|
||||
"id": "Date",
|
||||
"properties": {
|
||||
"day": {
|
||||
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year by itself or a year and month where the day is not\nsignificant.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"month": {
|
||||
"description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a\nmonth and day.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"year": {
|
||||
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DateRange": {
|
||||
"description": "Specification of a single date range. Both dates are inclusive.",
|
||||
"id": "DateRange",
|
||||
"properties": {
|
||||
"endDate": {
|
||||
"$ref": "Date",
|
||||
"description": "End date of the date range, inclusive. Must be greater than or equal to the\nstart date."
|
||||
},
|
||||
"startDate": {
|
||||
"$ref": "Date",
|
||||
"description": "Start date of the date range, inclusive. Must be less than or equal to the\nend date."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GenerateMediationReportRequest": {
|
||||
"description": "Request to generate an AdMob Mediation report.",
|
||||
"id": "GenerateMediationReportRequest",
|
||||
"properties": {
|
||||
"reportSpec": {
|
||||
"$ref": "MediationReportSpec",
|
||||
"description": "Network report specification."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GenerateMediationReportResponse": {
|
||||
"description": "The streaming response for the AdMob Mediation report where the first\nresponse contains the report header, then a stream of row responses, and\nfinally a footer as the last response message.\n\nFor example:\n\n [{\n \"header\": {\n \"date_range\": {\n \"start_date\": {\"year\": 2018, \"month\": 9, \"day\": 1},\n \"end_date\": {\"year\": 2018, \"month\": 9, \"day\": 30}\n }\n \"localization_settings\": {\n \"currency_code\": \"USD\",\n \"language_code\": \"en-US\"\n }\n }\n },\n {\n \"row\": {\n \"dimension_values\": {\n \"DATE\": {\"value\": \"20180918\"},\n \"APP\": {\n \"value\": \"ca-app-pub-8123415297019784~1001342552\",\n \"display_label\": \"My app name!\"\n }\n },\n \"metric_values\": {\n \"ESTIMATED_EARNINGS\": {\"decimal_value\": \"1324746\"}\n }\n }\n },\n {\n \"footer\": {\"matching_row_count\": 1}\n }]",
|
||||
"id": "GenerateMediationReportResponse",
|
||||
"properties": {
|
||||
"footer": {
|
||||
"$ref": "ReportFooter",
|
||||
"description": "Additional information about the generated report, such as warnings about\nthe data."
|
||||
},
|
||||
"header": {
|
||||
"$ref": "ReportHeader",
|
||||
"description": "Report generation settings that describes the report contents, such as\nthe report date range and localization settings."
|
||||
},
|
||||
"row": {
|
||||
"$ref": "ReportRow",
|
||||
"description": "Actual report data."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GenerateNetworkReportRequest": {
|
||||
"description": "Request to generate an AdMob Network report.",
|
||||
"id": "GenerateNetworkReportRequest",
|
||||
"properties": {
|
||||
"reportSpec": {
|
||||
"$ref": "NetworkReportSpec",
|
||||
"description": "Network report specification."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GenerateNetworkReportResponse": {
|
||||
"description": "The streaming response for the AdMob Network report where the first response\ncontains the report header, then a stream of row responses, and finally a\nfooter as the last response message.\n\nFor example:\n\n [{\n \"header\": {\n \"dateRange\": {\n \"startDate\": {\"year\": 2018, \"month\": 9, \"day\": 1},\n \"endDate\": {\"year\": 2018, \"month\": 9, \"day\": 30}\n }\n \"localizationSettings\": {\n \"currencyCode\": \"USD\",\n \"languageCode\": \"en-US\"\n }\n }\n },\n {\n \"row\": {\n \"dimensionValues\": {\n \"DATE\": {\"value\": \"20180918\"},\n \"APP\": {\n \"value\": \"ca-app-pub-8123415297019784~1001342552\",\n displayLabel: \"My app name!\"\n }\n },\n \"metricValues\": {\n \"ESTIMATED_EARNINGS\": {\"microsValue\": 6500000}\n }\n }\n },\n ...\n {\n \"footer\": {\"matchingRowCount\": 5}\n }]",
|
||||
"id": "GenerateNetworkReportResponse",
|
||||
"properties": {
|
||||
"footer": {
|
||||
"$ref": "ReportFooter",
|
||||
"description": "Additional information about the generated report, such as warnings about\nthe data."
|
||||
},
|
||||
"header": {
|
||||
"$ref": "ReportHeader",
|
||||
"description": "Report generation settings that describes the report contents, such as\nthe report date range and localization settings."
|
||||
},
|
||||
"row": {
|
||||
"$ref": "ReportRow",
|
||||
"description": "Actual report data."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListPublisherAccountsResponse": {
|
||||
"description": "Response for the publisher account list request.",
|
||||
"id": "ListPublisherAccountsResponse",
|
||||
"properties": {
|
||||
"account": {
|
||||
"description": "Publisher that the client credentials can access.",
|
||||
"items": {
|
||||
"$ref": "PublisherAccount"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "If not empty, indicates that there might be more accounts for the request;\nyou must pass this value in a new `ListPublisherAccountsRequest`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"LocalizationSettings": {
|
||||
"description": "Localization settings for reports, such as currency and language. It affects\nhow metrics are calculated.",
|
||||
"id": "LocalizationSettings",
|
||||
"properties": {
|
||||
"currencyCode": {
|
||||
"description": "Currency code of the earning related metrics, which is the 3-letter code\ndefined in ISO 4217. The daily average rate is used for the currency\nconversion. Defaults to the account currency code if unspecified.",
|
||||
"type": "string"
|
||||
},
|
||||
"languageCode": {
|
||||
"description": "Language used for any localized text, such as some dimension value display\nlabels. The language tag defined in the IETF BCP47. Defaults to 'en-US' if\nunspecified.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MediationReportSpec": {
|
||||
"description": "The specification for generating an AdMob Mediation report.\nFor example, the specification to get observed ECPM sliced by ad source and\napp for the 'US' and 'CN' countries can look like the following example:\n\n {\n \"date_range\": {\n \"start_date\": {\"year\": 2018, \"month\": 9, \"day\": 1},\n \"end_date\": {\"year\": 2018, \"month\": 9, \"day\": 30}\n },\n \"dimensions\": [\"AD_SOURCE\", \"APP\", \"COUNTRY\"],\n \"metrics\": [\"OBSERVED_ECPM\"],\n \"dimension_filters\": [\n {\n \"dimension\": \"COUNTRY\",\n \"matches_any\": {\"values\": [{\"value\": \"US\", \"value\": \"CN\"}]}\n }\n ],\n \"sort_conditions\": [\n {\"dimension\":\"APP\", order: \"ASCENDING\"}\n ],\n \"localization_settings\": {\n \"currency_code\": \"USD\",\n \"language_code\": \"en-US\"\n }\n }\n\nFor a better understanding, you can treat the preceding specification like\nthe following pseudo SQL:\n\n SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM\n FROM MEDIATION_REPORT\n WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30'\n AND COUNTRY IN ('US', 'CN')\n GROUP BY AD_SOURCE, APP, COUNTRY\n ORDER BY APP ASC;",
|
||||
"id": "MediationReportSpec",
|
||||
"properties": {
|
||||
"dateRange": {
|
||||
"$ref": "DateRange",
|
||||
"description": "The date range for which the report is generated."
|
||||
},
|
||||
"dimensionFilters": {
|
||||
"description": "Describes which report rows to match based on their dimension values.",
|
||||
"items": {
|
||||
"$ref": "MediationReportSpecDimensionFilter"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"dimensions": {
|
||||
"description": "List of dimensions of the report. The value combination of these dimensions\ndetermines the row of the report. If no dimensions are specified, the\nreport returns a single row of requested metrics for the entire account.",
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can\nspecify at most one time dimension.",
|
||||
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can\nspecify at most one time dimension.",
|
||||
"The date of the first day of a week in the YYYY-MM-DD format\n(for example, \"2018-12-21\"). Requests can specify at most one time\ndimension.",
|
||||
"The unique ID of the ad source (for example, \"5450213213286189855\" and\n\"AdMob Network\" as label value).",
|
||||
"The unique ID of the ad source instance (for example,\n\"ca-app-pub-1234#5678\" and \"AdMob (default)\" as label value).\n\n**Warning:** The dimension is incompatible with\n[ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) and\n[OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
|
||||
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\").\nIf AD_UNIT dimension is specified, then APP is included automatically.",
|
||||
"The unique ID of the mobile application (for example,\n\"ca-app-pub-1234~1234\").",
|
||||
"The unique ID of the mediation group (for example,\n\"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).\n\n**Warning:** The dimension is incompatible with\n[ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) and\n[OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
|
||||
"CLDR country code of the place where the ad views/clicks occur (for\nexample, \"US\" or \"FR\"). This is a geography dimension.",
|
||||
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery\ndimension.",
|
||||
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
|
||||
],
|
||||
"items": {
|
||||
"enum": [
|
||||
"DIMENSION_UNSPECIFIED",
|
||||
"DATE",
|
||||
"MONTH",
|
||||
"WEEK",
|
||||
"AD_SOURCE",
|
||||
"AD_SOURCE_INSTANCE",
|
||||
"AD_UNIT",
|
||||
"APP",
|
||||
"MEDIATION_GROUP",
|
||||
"COUNTRY",
|
||||
"FORMAT",
|
||||
"PLATFORM"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"localizationSettings": {
|
||||
"$ref": "LocalizationSettings",
|
||||
"description": "Localization settings of the report."
|
||||
},
|
||||
"maxReportRows": {
|
||||
"description": "Maximum number of report data rows to return. If the value is not set, the\nAPI returns as many rows as possible, up to 100000. Acceptable values are\n1-100000, inclusive. Any other values are treated as 100000.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"metrics": {
|
||||
"description": "List of metrics of the report. A report must specify at least one metric.",
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"The number of requests. The value is an integer.",
|
||||
"The number of times a user clicks an ad. The value is an integer.",
|
||||
"The estimated earnings of the AdMob publisher. The currency unit (USD,\nEUR, or other) of the earning metrics are determined by the localization\nsetting for currency. The amount is in micros. For example, $6.50 would\nbe represented as 6500000.\n\n**Warning:** The metric is incompatible with\n[AD_SOURCE_INSTANCE](#Dimension.ENUM_VALUES.AD_SOURCE_INSTANCE) and\n[MEDIATION_GROUP](#Dimension.ENUM_VALUES.MEDIATION_GROUP) dimensions.",
|
||||
"The total number of ads shown to users. The value is an integer.",
|
||||
"The ratio of clicks over impressions. The value is a double precision\n(approximate) decimal value.",
|
||||
"The number of times ads are returned in response to a request. The value\nis an integer.",
|
||||
"The ratio of matched ad requests over the total ad requests. The value is\na double precision (approximate) decimal value.",
|
||||
"The third-party ad network's estimated average eCPM. The currency unit\n(USD, EUR, or other) of the earning metrics are determined by the\nlocalization setting for currency. The amount is in micros. For example,\n$2.30 would be represented as 2300000.\n\n**Warning:** The metric is incompatible with\n[AD_SOURCE_INSTANCE](#Dimension.ENUM_VALUES.AD_SOURCE_INSTANCE) and\n[MEDIATION_GROUP](#Dimension.ENUM_VALUES.MEDIATION_GROUP) dimensions."
|
||||
],
|
||||
"items": {
|
||||
"enum": [
|
||||
"METRIC_UNSPECIFIED",
|
||||
"AD_REQUESTS",
|
||||
"CLICKS",
|
||||
"ESTIMATED_EARNINGS",
|
||||
"IMPRESSIONS",
|
||||
"IMPRESSION_CTR",
|
||||
"MATCHED_REQUESTS",
|
||||
"MATCH_RATE",
|
||||
"OBSERVED_ECPM"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"sortConditions": {
|
||||
"description": "Describes the sorting of report rows. The order of the condition in the\nlist defines its precedence; the earlier the condition, the higher its\nprecedence. If no sort conditions are specified, the row ordering is\nundefined.",
|
||||
"items": {
|
||||
"$ref": "MediationReportSpecSortCondition"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"timeZone": {
|
||||
"description": "A report time zone. Accepts an IANA TZ name values, such as\n\"America/Los_Angeles.\" If no time zone is defined, the account default\ntakes effect. Check default value by the get account action.\n\n**Warning:** The \"America/Los_Angeles\" is the only supported value at\nthe moment.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MediationReportSpecDimensionFilter": {
|
||||
"description": "Describes which report rows to match based on their dimension values.",
|
||||
"id": "MediationReportSpecDimensionFilter",
|
||||
"properties": {
|
||||
"dimension": {
|
||||
"description": "Applies the filter criterion to the specified dimension.",
|
||||
"enum": [
|
||||
"DIMENSION_UNSPECIFIED",
|
||||
"DATE",
|
||||
"MONTH",
|
||||
"WEEK",
|
||||
"AD_SOURCE",
|
||||
"AD_SOURCE_INSTANCE",
|
||||
"AD_UNIT",
|
||||
"APP",
|
||||
"MEDIATION_GROUP",
|
||||
"COUNTRY",
|
||||
"FORMAT",
|
||||
"PLATFORM"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can\nspecify at most one time dimension.",
|
||||
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can\nspecify at most one time dimension.",
|
||||
"The date of the first day of a week in the YYYY-MM-DD format\n(for example, \"2018-12-21\"). Requests can specify at most one time\ndimension.",
|
||||
"The unique ID of the ad source (for example, \"5450213213286189855\" and\n\"AdMob Network\" as label value).",
|
||||
"The unique ID of the ad source instance (for example,\n\"ca-app-pub-1234#5678\" and \"AdMob (default)\" as label value).\n\n**Warning:** The dimension is incompatible with\n[ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) and\n[OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
|
||||
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\").\nIf AD_UNIT dimension is specified, then APP is included automatically.",
|
||||
"The unique ID of the mobile application (for example,\n\"ca-app-pub-1234~1234\").",
|
||||
"The unique ID of the mediation group (for example,\n\"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).\n\n**Warning:** The dimension is incompatible with\n[ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) and\n[OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
|
||||
"CLDR country code of the place where the ad views/clicks occur (for\nexample, \"US\" or \"FR\"). This is a geography dimension.",
|
||||
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery\ndimension.",
|
||||
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"matchesAny": {
|
||||
"$ref": "StringList",
|
||||
"description": "Matches a row if its value for the specified dimension is in one of the\nvalues specified in this condition."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MediationReportSpecSortCondition": {
|
||||
"description": "Sorting direction to be applied on a dimension or a metric.",
|
||||
"id": "MediationReportSpecSortCondition",
|
||||
"properties": {
|
||||
"dimension": {
|
||||
"description": "Sort by the specified dimension.",
|
||||
"enum": [
|
||||
"DIMENSION_UNSPECIFIED",
|
||||
"DATE",
|
||||
"MONTH",
|
||||
"WEEK",
|
||||
"AD_SOURCE",
|
||||
"AD_SOURCE_INSTANCE",
|
||||
"AD_UNIT",
|
||||
"APP",
|
||||
"MEDIATION_GROUP",
|
||||
"COUNTRY",
|
||||
"FORMAT",
|
||||
"PLATFORM"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can\nspecify at most one time dimension.",
|
||||
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can\nspecify at most one time dimension.",
|
||||
"The date of the first day of a week in the YYYY-MM-DD format\n(for example, \"2018-12-21\"). Requests can specify at most one time\ndimension.",
|
||||
"The unique ID of the ad source (for example, \"5450213213286189855\" and\n\"AdMob Network\" as label value).",
|
||||
"The unique ID of the ad source instance (for example,\n\"ca-app-pub-1234#5678\" and \"AdMob (default)\" as label value).\n\n**Warning:** The dimension is incompatible with\n[ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) and\n[OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
|
||||
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\").\nIf AD_UNIT dimension is specified, then APP is included automatically.",
|
||||
"The unique ID of the mobile application (for example,\n\"ca-app-pub-1234~1234\").",
|
||||
"The unique ID of the mediation group (for example,\n\"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).\n\n**Warning:** The dimension is incompatible with\n[ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) and\n[OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.",
|
||||
"CLDR country code of the place where the ad views/clicks occur (for\nexample, \"US\" or \"FR\"). This is a geography dimension.",
|
||||
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery\ndimension.",
|
||||
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"metric": {
|
||||
"description": "Sort by the specified metric.",
|
||||
"enum": [
|
||||
"METRIC_UNSPECIFIED",
|
||||
"AD_REQUESTS",
|
||||
"CLICKS",
|
||||
"ESTIMATED_EARNINGS",
|
||||
"IMPRESSIONS",
|
||||
"IMPRESSION_CTR",
|
||||
"MATCHED_REQUESTS",
|
||||
"MATCH_RATE",
|
||||
"OBSERVED_ECPM"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"The number of requests. The value is an integer.",
|
||||
"The number of times a user clicks an ad. The value is an integer.",
|
||||
"The estimated earnings of the AdMob publisher. The currency unit (USD,\nEUR, or other) of the earning metrics are determined by the localization\nsetting for currency. The amount is in micros. For example, $6.50 would\nbe represented as 6500000.\n\n**Warning:** The metric is incompatible with\n[AD_SOURCE_INSTANCE](#Dimension.ENUM_VALUES.AD_SOURCE_INSTANCE) and\n[MEDIATION_GROUP](#Dimension.ENUM_VALUES.MEDIATION_GROUP) dimensions.",
|
||||
"The total number of ads shown to users. The value is an integer.",
|
||||
"The ratio of clicks over impressions. The value is a double precision\n(approximate) decimal value.",
|
||||
"The number of times ads are returned in response to a request. The value\nis an integer.",
|
||||
"The ratio of matched ad requests over the total ad requests. The value is\na double precision (approximate) decimal value.",
|
||||
"The third-party ad network's estimated average eCPM. The currency unit\n(USD, EUR, or other) of the earning metrics are determined by the\nlocalization setting for currency. The amount is in micros. For example,\n$2.30 would be represented as 2300000.\n\n**Warning:** The metric is incompatible with\n[AD_SOURCE_INSTANCE](#Dimension.ENUM_VALUES.AD_SOURCE_INSTANCE) and\n[MEDIATION_GROUP](#Dimension.ENUM_VALUES.MEDIATION_GROUP) dimensions."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"order": {
|
||||
"description": "Sorting order of the dimension or metric.",
|
||||
"enum": [
|
||||
"SORT_ORDER_UNSPECIFIED",
|
||||
"ASCENDING",
|
||||
"DESCENDING"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"Sort dimension value or metric value in ascending order.",
|
||||
"Sort dimension value or metric value in descending order."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"NetworkReportSpec": {
|
||||
"description": "The specification for generating an AdMob Network report.\nFor example, the specification to get clicks and estimated earnings for only\nthe 'US' and 'CN' countries can look like the following example:\n\n {\n 'date_range': {\n 'start_date': {'year': 2018, 'month': 9, 'day': 1},\n 'end_date': {'year': 2018, 'month': 9, 'day': 30}\n },\n 'dimensions': ['DATE', 'APP', 'COUNTRY'],\n 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],\n 'dimension_filters': [\n {\n 'dimension': 'COUNTRY',\n 'matches_any': {'values': [{'value': 'US', 'value': 'CN'}]}\n }\n ],\n 'sort_conditions': [\n {'dimension':'APP', order: 'ASCENDING'},\n {'metric':'CLICKS', order: 'DESCENDING'}\n ],\n 'localization_settings': {\n 'currency_code': 'USD',\n 'language_code': 'en-US'\n }\n }\n\nFor a better understanding, you can treat the preceding specification like\nthe following pseudo SQL:\n\n SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS\n FROM NETWORK_REPORT\n WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30'\n AND COUNTRY IN ('US', 'CN')\n GROUP BY DATE, APP, COUNTRY\n ORDER BY APP ASC, CLICKS DESC;",
|
||||
"id": "NetworkReportSpec",
|
||||
"properties": {
|
||||
"dateRange": {
|
||||
"$ref": "DateRange",
|
||||
"description": "The date range for which the report is generated."
|
||||
},
|
||||
"dimensionFilters": {
|
||||
"description": "Describes which report rows to match based on their dimension values.",
|
||||
"items": {
|
||||
"$ref": "NetworkReportSpecDimensionFilter"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"dimensions": {
|
||||
"description": "List of dimensions of the report. The value combination of these dimensions\ndetermines the row of the report. If no dimensions are specified, the\nreport returns a single row of requested metrics for the entire account.",
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can\nspecify at most one time dimension.",
|
||||
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can\nspecify at most one time dimension.",
|
||||
"The date of the first day of a week in the YYYY-MM-DD format\n(for example, \"2018-12-21\"). Requests can specify at most one time\ndimension.",
|
||||
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\").\nIf AD_UNIT dimension is specified, then APP is included automatically.",
|
||||
"The unique ID of the mobile application (for example,\n\"ca-app-pub-1234~1234\").",
|
||||
"Type of the ad (for example, \"text\" or \"image\"), an ad delivery\ndimension.\n\n**Warning:** The dimension is incompatible with\n[AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS),\n[MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and\n[IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.",
|
||||
"CLDR country code of the place where the ad views/clicks occur (for\nexample, \"US\" or \"FR\"). This is a geography dimension.",
|
||||
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery\ndimension.",
|
||||
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
|
||||
],
|
||||
"items": {
|
||||
"enum": [
|
||||
"DIMENSION_UNSPECIFIED",
|
||||
"DATE",
|
||||
"MONTH",
|
||||
"WEEK",
|
||||
"AD_UNIT",
|
||||
"APP",
|
||||
"AD_TYPE",
|
||||
"COUNTRY",
|
||||
"FORMAT",
|
||||
"PLATFORM"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"localizationSettings": {
|
||||
"$ref": "LocalizationSettings",
|
||||
"description": "Localization settings of the report."
|
||||
},
|
||||
"maxReportRows": {
|
||||
"description": "Maximum number of report data rows to return. If the value is not set, the\nAPI returns as many rows as possible, up to 100000. Acceptable values are\n1-100000, inclusive. Any other values are treated as 100000.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"metrics": {
|
||||
"description": "List of metrics of the report. A report must specify at least one metric.",
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"The number of ad requests. The value is an integer.\n\n**Warning:** The metric is incompatible with\n[AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.",
|
||||
"The number of times a user clicks an ad. The value is an integer.",
|
||||
"The estimated earnings of the AdMob publisher. The currency unit (USD,\nEUR, or other) of the earning metrics are determined by the localization\nsetting for currency. The amount is in micros. For example, $6.50 would\nbe represented as 6500000.",
|
||||
"The total number of ads shown to users. The value is an integer.",
|
||||
"The ratio of clicks over impressions. The value is a double precision\n(approximate) decimal value.",
|
||||
"The estimated earnings per thousand ad impressions. The value is in\nmicros. For example, $1.03 would be represented as 1030000.\n\n**Warning:** The metric is incompatible with\n[AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.",
|
||||
"The number of times ads are returned in response to a request. The value\nis an integer.",
|
||||
"The ratio of matched ad requests over the total ad requests. The value is\na double precision (approximate) decimal value.\n\n**Warning:** The metric is incompatible with\n[AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.",
|
||||
"The ratio of ads that are displayed over ads that are returned, defined\nas impressions / matched requests. The value is a double precision\n(approximate) decimal value."
|
||||
],
|
||||
"items": {
|
||||
"enum": [
|
||||
"METRIC_UNSPECIFIED",
|
||||
"AD_REQUESTS",
|
||||
"CLICKS",
|
||||
"ESTIMATED_EARNINGS",
|
||||
"IMPRESSIONS",
|
||||
"IMPRESSION_CTR",
|
||||
"IMPRESSION_RPM",
|
||||
"MATCHED_REQUESTS",
|
||||
"MATCH_RATE",
|
||||
"SHOW_RATE"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"sortConditions": {
|
||||
"description": "Describes the sorting of report rows. The order of the condition in the\nlist defines its precedence; the earlier the condition, the higher its\nprecedence. If no sort conditions are specified, the row ordering is\nundefined.",
|
||||
"items": {
|
||||
"$ref": "NetworkReportSpecSortCondition"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"timeZone": {
|
||||
"description": "A report time zone. Accepts an IANA TZ name values, such as\n\"America/Los_Angeles.\" If no time zone is defined, the account default\ntakes effect. Check default value by the get account action.\n\n**Warning:** The \"America/Los_Angeles\" is the only supported value at\nthe moment.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"NetworkReportSpecDimensionFilter": {
|
||||
"description": "Describes which report rows to match based on their dimension values.",
|
||||
"id": "NetworkReportSpecDimensionFilter",
|
||||
"properties": {
|
||||
"dimension": {
|
||||
"description": "Applies the filter criterion to the specified dimension.",
|
||||
"enum": [
|
||||
"DIMENSION_UNSPECIFIED",
|
||||
"DATE",
|
||||
"MONTH",
|
||||
"WEEK",
|
||||
"AD_UNIT",
|
||||
"APP",
|
||||
"AD_TYPE",
|
||||
"COUNTRY",
|
||||
"FORMAT",
|
||||
"PLATFORM"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can\nspecify at most one time dimension.",
|
||||
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can\nspecify at most one time dimension.",
|
||||
"The date of the first day of a week in the YYYY-MM-DD format\n(for example, \"2018-12-21\"). Requests can specify at most one time\ndimension.",
|
||||
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\").\nIf AD_UNIT dimension is specified, then APP is included automatically.",
|
||||
"The unique ID of the mobile application (for example,\n\"ca-app-pub-1234~1234\").",
|
||||
"Type of the ad (for example, \"text\" or \"image\"), an ad delivery\ndimension.\n\n**Warning:** The dimension is incompatible with\n[AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS),\n[MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and\n[IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.",
|
||||
"CLDR country code of the place where the ad views/clicks occur (for\nexample, \"US\" or \"FR\"). This is a geography dimension.",
|
||||
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery\ndimension.",
|
||||
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"matchesAny": {
|
||||
"$ref": "StringList",
|
||||
"description": "Matches a row if its value for the specified dimension is in one of the\nvalues specified in this condition."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"NetworkReportSpecSortCondition": {
|
||||
"description": "Sorting direction to be applied on a dimension or a metric.",
|
||||
"id": "NetworkReportSpecSortCondition",
|
||||
"properties": {
|
||||
"dimension": {
|
||||
"description": "Sort by the specified dimension.",
|
||||
"enum": [
|
||||
"DIMENSION_UNSPECIFIED",
|
||||
"DATE",
|
||||
"MONTH",
|
||||
"WEEK",
|
||||
"AD_UNIT",
|
||||
"APP",
|
||||
"AD_TYPE",
|
||||
"COUNTRY",
|
||||
"FORMAT",
|
||||
"PLATFORM"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"A date in the YYYY-MM-DD format (for example, \"2018-12-21\"). Requests can\nspecify at most one time dimension.",
|
||||
"A month in the YYYY-MM format (for example, \"2018-12\"). Requests can\nspecify at most one time dimension.",
|
||||
"The date of the first day of a week in the YYYY-MM-DD format\n(for example, \"2018-12-21\"). Requests can specify at most one time\ndimension.",
|
||||
"The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\").\nIf AD_UNIT dimension is specified, then APP is included automatically.",
|
||||
"The unique ID of the mobile application (for example,\n\"ca-app-pub-1234~1234\").",
|
||||
"Type of the ad (for example, \"text\" or \"image\"), an ad delivery\ndimension.\n\n**Warning:** The dimension is incompatible with\n[AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS),\n[MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and\n[IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.",
|
||||
"CLDR country code of the place where the ad views/clicks occur (for\nexample, \"US\" or \"FR\"). This is a geography dimension.",
|
||||
"Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery\ndimension.",
|
||||
"Mobile OS platform of the app (for example, \"Android\" or \"iOS\")."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"metric": {
|
||||
"description": "Sort by the specified metric.",
|
||||
"enum": [
|
||||
"METRIC_UNSPECIFIED",
|
||||
"AD_REQUESTS",
|
||||
"CLICKS",
|
||||
"ESTIMATED_EARNINGS",
|
||||
"IMPRESSIONS",
|
||||
"IMPRESSION_CTR",
|
||||
"IMPRESSION_RPM",
|
||||
"MATCHED_REQUESTS",
|
||||
"MATCH_RATE",
|
||||
"SHOW_RATE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"The number of ad requests. The value is an integer.\n\n**Warning:** The metric is incompatible with\n[AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.",
|
||||
"The number of times a user clicks an ad. The value is an integer.",
|
||||
"The estimated earnings of the AdMob publisher. The currency unit (USD,\nEUR, or other) of the earning metrics are determined by the localization\nsetting for currency. The amount is in micros. For example, $6.50 would\nbe represented as 6500000.",
|
||||
"The total number of ads shown to users. The value is an integer.",
|
||||
"The ratio of clicks over impressions. The value is a double precision\n(approximate) decimal value.",
|
||||
"The estimated earnings per thousand ad impressions. The value is in\nmicros. For example, $1.03 would be represented as 1030000.\n\n**Warning:** The metric is incompatible with\n[AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.",
|
||||
"The number of times ads are returned in response to a request. The value\nis an integer.",
|
||||
"The ratio of matched ad requests over the total ad requests. The value is\na double precision (approximate) decimal value.\n\n**Warning:** The metric is incompatible with\n[AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.",
|
||||
"The ratio of ads that are displayed over ads that are returned, defined\nas impressions / matched requests. The value is a double precision\n(approximate) decimal value."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"order": {
|
||||
"description": "Sorting order of the dimension or metric.",
|
||||
"enum": [
|
||||
"SORT_ORDER_UNSPECIFIED",
|
||||
"ASCENDING",
|
||||
"DESCENDING"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"Sort dimension value or metric value in ascending order.",
|
||||
"Sort dimension value or metric value in descending order."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PublisherAccount": {
|
||||
"description": "A publisher account contains information relevant to the use of this API,\nsuch as the time zone used for the reports.",
|
||||
"id": "PublisherAccount",
|
||||
"properties": {
|
||||
"currencyCode": {
|
||||
"description": "Currency code of the earning-related metrics, which is the 3-letter code\ndefined in ISO 4217. The daily average rate is used for the currency\nconversion.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Resource name of this account.\nFormat is accounts/{publisher_id}.",
|
||||
"type": "string"
|
||||
},
|
||||
"publisherId": {
|
||||
"description": "The unique ID by which this publisher account can be identified\nin the API requests (for example, pub-1234567890).",
|
||||
"type": "string"
|
||||
},
|
||||
"reportingTimeZone": {
|
||||
"description": "The time zone that is used in reports that are generated for this account.\nThe value is a time-zone ID as specified by the CLDR project,\nfor example, \"America/Los_Angeles\".",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReportFooter": {
|
||||
"description": "Groups data available after report generation, for example, warnings and row\ncounts. Always sent as the last message in the stream response.",
|
||||
"id": "ReportFooter",
|
||||
"properties": {
|
||||
"matchingRowCount": {
|
||||
"description": "Total number of rows that did match the request.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"warnings": {
|
||||
"description": "Warnings associated with generation of the report.",
|
||||
"items": {
|
||||
"$ref": "ReportWarning"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReportHeader": {
|
||||
"description": "Groups data helps to treat the generated report. Always sent as a first\nmessage in the stream response.",
|
||||
"id": "ReportHeader",
|
||||
"properties": {
|
||||
"dateRange": {
|
||||
"$ref": "DateRange",
|
||||
"description": "The date range for which the report is generated. This is identical to the\nrange specified in the report request."
|
||||
},
|
||||
"localizationSettings": {
|
||||
"$ref": "LocalizationSettings",
|
||||
"description": "Localization settings of the report. This is identical to the settings\nin the report request."
|
||||
},
|
||||
"reportingTimeZone": {
|
||||
"description": "The report time zone. The value is a time-zone ID as specified by the CLDR\nproject, for example, \"America/Los_Angeles\".",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReportRow": {
|
||||
"description": "A row of the returning report.",
|
||||
"id": "ReportRow",
|
||||
"properties": {
|
||||
"dimensionValues": {
|
||||
"additionalProperties": {
|
||||
"$ref": "ReportRowDimensionValue"
|
||||
},
|
||||
"description": "Map of dimension values in a row, with keys as enum name of the dimensions.",
|
||||
"type": "object"
|
||||
},
|
||||
"metricValues": {
|
||||
"additionalProperties": {
|
||||
"$ref": "ReportRowMetricValue"
|
||||
},
|
||||
"description": "Map of metric values in a row, with keys as enum name of the metrics. If\na metric being requested has no value returned, the map will not include\nit.",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReportRowDimensionValue": {
|
||||
"description": "Representation of a dimension value.",
|
||||
"id": "ReportRowDimensionValue",
|
||||
"properties": {
|
||||
"displayLabel": {
|
||||
"description": "The localized string representation of the value. If unspecified, the\ndisplay label should be derived from the value.",
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"description": "Dimension value in the format specified in the report's spec Dimension\nenum.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReportRowMetricValue": {
|
||||
"description": "Representation of a metric value.",
|
||||
"id": "ReportRowMetricValue",
|
||||
"properties": {
|
||||
"doubleValue": {
|
||||
"description": "Double precision (approximate) decimal values. Rates are from 0 to 1.",
|
||||
"format": "double",
|
||||
"type": "number"
|
||||
},
|
||||
"integerValue": {
|
||||
"description": "Metric integer value.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"microsValue": {
|
||||
"description": "Amount in micros. One million is equivalent to one unit. Currency value\nis in the unit (USD, EUR or other) specified by the request.\nFor example, $6.50 whould be represented as 6500000 micros.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReportWarning": {
|
||||
"description": "Warnings associated with generation of the report.",
|
||||
"id": "ReportWarning",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "Describes the details of the warning message, in English.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "Type of the warning.",
|
||||
"enum": [
|
||||
"TYPE_UNSPECIFIED",
|
||||
"DATA_BEFORE_ACCOUNT_TIMEZONE_CHANGE",
|
||||
"DATA_DELAYED",
|
||||
"OTHER",
|
||||
"REPORT_CURRENCY_NOT_ACCOUNT_CURRENCY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value for an unset field. Do not use.",
|
||||
"Some data in this report is aggregated based on a time zone different\nfrom the requested time zone. This could happen if a local time-zone\nreport has the start time before the last time this time zone changed.\nThe description field will contain the date of the last time zone\nchange.",
|
||||
"There is an unusual delay in processing the source data for the\nrequested date range. The report results might be less up to date than\nusual. AdMob is aware of the issue and is actively working to resolve\nit.",
|
||||
"Warnings that are exposed without a specific type. Useful when new\nwarning types are added but the API is not changed yet.",
|
||||
"The currency being requested is not the account currency. The earning\nmetrics will be based on the requested currency, and thus not a good\nestimation of the final payment anymore, due to the currency rate\nfluctuation."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"StringList": {
|
||||
"description": "List of string values.",
|
||||
"id": "StringList",
|
||||
"properties": {
|
||||
"values": {
|
||||
"description": "The string values.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "AdMob API",
|
||||
"version": "v1",
|
||||
"version_module": true
|
||||
}
|
||||
@@ -18,7 +18,6 @@
|
||||
"description": "Accesses AdSense publishers' inventory and generates performance reports.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/adsense/management/",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/I7MtTz0vV-32AsDbiGoDB0m4F_E\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/adsense-16.png",
|
||||
"x32": "https://www.google.com/images/icons/product/adsense-32.png"
|
||||
@@ -1655,7 +1654,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190703",
|
||||
"revision": "20200407",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Account": {
|
||||
|
||||
@@ -15,7 +15,6 @@
|
||||
"description": "Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/adsense/host/",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/JG41eEpvCwrEtxQxrYypFYYmUHY\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/adsense-16.png",
|
||||
"x32": "https://www.google.com/images/icons/product/adsense-32.png"
|
||||
@@ -633,6 +632,11 @@
|
||||
"websiteUrl"
|
||||
],
|
||||
"parameters": {
|
||||
"callbackUrl": {
|
||||
"description": "The URL to redirect the user to once association is completed. It receives a token parameter that can then be used to retrieve the associated account.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"productCode": {
|
||||
"description": "Products to associate with the user.",
|
||||
"enum": [
|
||||
@@ -1072,7 +1076,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190703",
|
||||
"revision": "20200407",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Account": {
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "alertcenter:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://alertcenter.mtls.googleapis.com/",
|
||||
"name": "alertcenter",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -106,6 +107,42 @@
|
||||
"resources": {
|
||||
"alerts": {
|
||||
"methods": {
|
||||
"batchDelete": {
|
||||
"description": "Performs batch delete operation on alerts.",
|
||||
"flatPath": "v1beta1/alerts:batchDelete",
|
||||
"httpMethod": "POST",
|
||||
"id": "alertcenter.alerts.batchDelete",
|
||||
"parameterOrder": [],
|
||||
"parameters": {},
|
||||
"path": "v1beta1/alerts:batchDelete",
|
||||
"request": {
|
||||
"$ref": "BatchDeleteAlertsRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "BatchDeleteAlertsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/apps.alerts"
|
||||
]
|
||||
},
|
||||
"batchUndelete": {
|
||||
"description": "Performs batch undelete operation on alerts.",
|
||||
"flatPath": "v1beta1/alerts:batchUndelete",
|
||||
"httpMethod": "POST",
|
||||
"id": "alertcenter.alerts.batchUndelete",
|
||||
"parameterOrder": [],
|
||||
"parameters": {},
|
||||
"path": "v1beta1/alerts:batchUndelete",
|
||||
"request": {
|
||||
"$ref": "BatchUndeleteAlertsRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "BatchUndeleteAlertsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/apps.alerts"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Marks the specified alert for deletion. An alert that has been marked for\ndeletion is removed from Alert Center after 30 days.\nMarking an alert for deletion has no effect on an alert which has\nalready been marked for deletion. Attempting to mark a nonexistent alert\nfor deletion results in a `NOT_FOUND` error.",
|
||||
"flatPath": "v1beta1/alerts/{alertId}",
|
||||
@@ -164,6 +201,35 @@
|
||||
"https://www.googleapis.com/auth/apps.alerts"
|
||||
]
|
||||
},
|
||||
"getMetadata": {
|
||||
"description": "Returns the metadata of an alert. Attempting to get metadata for\na non-existent alert returns `NOT_FOUND` error.",
|
||||
"flatPath": "v1beta1/alerts/{alertId}/metadata",
|
||||
"httpMethod": "GET",
|
||||
"id": "alertcenter.alerts.getMetadata",
|
||||
"parameterOrder": [
|
||||
"alertId"
|
||||
],
|
||||
"parameters": {
|
||||
"alertId": {
|
||||
"description": "Required. The identifier of the alert this metadata belongs to.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"customerId": {
|
||||
"description": "Optional. The unique identifier of the G Suite organization account of the\ncustomer the alert metadata is associated with.\nInferred from the caller identity if not provided.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/alerts/{alertId}/metadata",
|
||||
"response": {
|
||||
"$ref": "AlertMetadata"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/apps.alerts"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists the alerts.",
|
||||
"flatPath": "v1beta1/alerts",
|
||||
@@ -238,7 +304,7 @@
|
||||
"feedback": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates new feedback for an alert. Attempting to create a feedback for\na non-existent alert returns `NOT_FOUND` error.",
|
||||
"description": "Creates new feedback for an alert. Attempting to create a feedback for\na non-existent alert returns `NOT_FOUND` error. Attempting to create a\nfeedback for an alert that is marked for deletion returns\n`FAILED_PRECONDITION' error.",
|
||||
"flatPath": "v1beta1/alerts/{alertId}/feedback",
|
||||
"httpMethod": "POST",
|
||||
"id": "alertcenter.alerts.feedback.create",
|
||||
@@ -357,7 +423,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190628",
|
||||
"revision": "20200406",
|
||||
"rootUrl": "https://alertcenter.googleapis.com/",
|
||||
"schemas": {
|
||||
"AccountWarning": {
|
||||
@@ -408,14 +474,14 @@
|
||||
"type": "string"
|
||||
},
|
||||
"supersededAlerts": {
|
||||
"description": "List of alert ids superseded by this alert. It is used to indicate that\nthis alert is essentially extension of superseded alerts and we found the\nrelationship after creating these alerts.",
|
||||
"description": "List of alert IDs superseded by this alert. It is used to indicate that\nthis alert is essentially extension of superseded alerts and we found the\nrelationship after creating these alerts.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"supersedingAlert": {
|
||||
"description": "Alert id superseding this alert. It is used to indicate that superseding\nalert is essentially extension of this alert and we found the relationship\nafter creating both alerts.",
|
||||
"description": "Alert ID superseding this alert. It is used to indicate that superseding\nalert is essentially extension of this alert and we found the relationship\nafter creating both alerts.",
|
||||
"type": "string"
|
||||
},
|
||||
"threshold": {
|
||||
@@ -473,12 +539,20 @@
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"etag": {
|
||||
"description": "Optional. `etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of an alert from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform alert updates in order to avoid race\nconditions: An `etag` is returned in the response which contains alerts,\nand systems are expected to put that etag in the request to update alert to\nensure that their change will be applied to the same version of the alert.\n\nIf no `etag` is provided in the call to update alert, then the existing\nalert is overwritten blindly.",
|
||||
"type": "string"
|
||||
},
|
||||
"metadata": {
|
||||
"$ref": "AlertMetadata",
|
||||
"description": "Output only. The metadata associated with this alert."
|
||||
},
|
||||
"securityInvestigationToolLink": {
|
||||
"description": "Output only. An optional\n[Security Investigation Tool](https://support.google.com/a/answer/7575955)\nquery for this alert.",
|
||||
"type": "string"
|
||||
},
|
||||
"source": {
|
||||
"description": "Required. A unique identifier for the system that reported the alert.\nThis is output only after alert is created.\n\nSupported sources are any of the following:\n\n* Google Operations\n* Mobile device management\n* Gmail phishing\n* Domain wide takeout\n* Government attack warning\n* Google identity",
|
||||
"description": "Required. A unique identifier for the system that reported the alert.\nThis is output only after alert is created.\n\nSupported sources are any of the following:\n\n* Google Operations\n* Mobile device management\n* Gmail phishing\n* Domain wide takeout\n* State sponsored attack\n* Google identity",
|
||||
"type": "string"
|
||||
},
|
||||
"startTime": {
|
||||
@@ -542,6 +616,56 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AlertMetadata": {
|
||||
"description": "An alert metadata.",
|
||||
"id": "AlertMetadata",
|
||||
"properties": {
|
||||
"alertId": {
|
||||
"description": "Output only. The alert identifier.",
|
||||
"type": "string"
|
||||
},
|
||||
"assignee": {
|
||||
"description": "The email address of the user assigned to the alert.",
|
||||
"type": "string"
|
||||
},
|
||||
"customerId": {
|
||||
"description": "Output only. The unique identifier of the Google account of the customer.",
|
||||
"type": "string"
|
||||
},
|
||||
"etag": {
|
||||
"description": "Optional. `etag` is used for optimistic concurrency control as a way to\nhelp prevent simultaneous updates of an alert metadata from overwriting\neach other. It is strongly suggested that systems make use of the `etag` in\nthe read-modify-write cycle to perform metatdata updates in order to avoid\nrace conditions: An `etag` is returned in the response which contains alert\nmetadata, and systems are expected to put that etag in the request to\nupdate alert metadata to ensure that their change will be applied to the\nsame version of the alert metadata.\n\nIf no `etag` is provided in the call to update alert metadata, then the\nexisting alert metadata is overwritten blindly.",
|
||||
"type": "string"
|
||||
},
|
||||
"severity": {
|
||||
"description": "The severity value of the alert. Alert Center will set this field at alert\ncreation time, default's to an empty string when it could not be\ndetermined.\nThe supported values for update actions on this field are the following:\n\n* HIGH\n* MEDIUM\n* LOW",
|
||||
"type": "string"
|
||||
},
|
||||
"status": {
|
||||
"description": "The current status of the alert.\nThe supported values are the following:\n\n* NOT_STARTED\n* IN_PROGRESS\n* CLOSED",
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only. The time this metadata was last updated.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AppMakerSqlSetupNotification": {
|
||||
"description": "Alerts from App Maker to notify admins to set up default SQL instance.",
|
||||
"id": "AppMakerSqlSetupNotification",
|
||||
"properties": {
|
||||
"requestInfo": {
|
||||
"description": "List of applications with requests for default SQL set up.",
|
||||
"items": {
|
||||
"$ref": "RequestInfo"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Attachment": {
|
||||
"description": "Attachment with application-specific information about an alert.",
|
||||
"id": "Attachment",
|
||||
@@ -579,6 +703,84 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"BatchDeleteAlertsRequest": {
|
||||
"description": "A request to perform batch delete on alerts.",
|
||||
"id": "BatchDeleteAlertsRequest",
|
||||
"properties": {
|
||||
"alertId": {
|
||||
"description": "Required. list of alert IDs.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"customerId": {
|
||||
"description": "Optional. The unique identifier of the G Suite organization account of the\ncustomer the alerts are associated with.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"BatchDeleteAlertsResponse": {
|
||||
"description": "Response to batch delete operation on alerts.",
|
||||
"id": "BatchDeleteAlertsResponse",
|
||||
"properties": {
|
||||
"failedAlertStatus": {
|
||||
"additionalProperties": {
|
||||
"$ref": "Status"
|
||||
},
|
||||
"description": "The status details for each failed alert_id.",
|
||||
"type": "object"
|
||||
},
|
||||
"successAlertIds": {
|
||||
"description": "The successful list of alert IDs.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"BatchUndeleteAlertsRequest": {
|
||||
"description": "A request to perform batch undelete on alerts.",
|
||||
"id": "BatchUndeleteAlertsRequest",
|
||||
"properties": {
|
||||
"alertId": {
|
||||
"description": "Required. list of alert IDs.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"customerId": {
|
||||
"description": "Optional. The unique identifier of the G Suite organization account of the\ncustomer the alerts are associated with.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"BatchUndeleteAlertsResponse": {
|
||||
"description": "Response to batch undelete operation on alerts.",
|
||||
"id": "BatchUndeleteAlertsResponse",
|
||||
"properties": {
|
||||
"failedAlertStatus": {
|
||||
"additionalProperties": {
|
||||
"$ref": "Status"
|
||||
},
|
||||
"description": "The status details for each failed alert_id.",
|
||||
"type": "object"
|
||||
},
|
||||
"successAlertIds": {
|
||||
"description": "The successful list of alert IDs.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CloudPubsubTopic": {
|
||||
"description": "A reference to a Cloud Pubsub topic.\n\nTo register for notifications, the owner of the topic must grant\n`alerts-api-push-notifications@system.gserviceaccount.com` the\n `projects.topics.publish` permission.",
|
||||
"id": "CloudPubsubTopic",
|
||||
@@ -690,6 +892,17 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DlpRuleViolation": {
|
||||
"description": "Alerts that get triggered on violations of Data Loss Prevention (DLP) rules.",
|
||||
"id": "DlpRuleViolation",
|
||||
"properties": {
|
||||
"ruleViolationInfo": {
|
||||
"$ref": "RuleViolationInfo",
|
||||
"description": "Details about the violated DLP rule.\n\nAdmins can use the predefined detectors provided by Google Cloud DLP\nhttps://cloud.google.com/dlp/ when setting up a DLP rule. Matched Cloud DLP\ndetectors in this violation if any will be captured in the\nMatchInfo.predefined_detector."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DomainId": {
|
||||
"description": "Domain ID of Gmail phishing alerts.",
|
||||
"id": "DomainId",
|
||||
@@ -832,7 +1045,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"loginTime": {
|
||||
"description": "Optional. The successful login time that is associated with the warning\nevent. This will not be present for blocked login attempts.",
|
||||
"description": "Optional. The successful login time that is associated with the warning\nevent. This isn't present for blocked login attempts.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -840,7 +1053,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"MailPhishing": {
|
||||
"description": "Proto for all phishing alerts with common payload.\nSupported types are any of the following:\n\n* User reported phishing\n* User reported spam spike\n* Suspicious message reported\n* Phishing reclassification\n* Malware reclassification",
|
||||
"description": "Proto for all phishing alerts with common payload.\nSupported types are any of the following:\n\n* User reported phishing\n* User reported spam spike\n* Suspicious message reported\n* Phishing reclassification\n* Malware reclassification\n* Gmail potential employee spoofing",
|
||||
"id": "MailPhishing",
|
||||
"properties": {
|
||||
"domainId": {
|
||||
@@ -861,6 +1074,20 @@
|
||||
"$ref": "GmailMessageInfo"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"systemActionType": {
|
||||
"description": "System actions on the messages.",
|
||||
"enum": [
|
||||
"SYSTEM_ACTION_TYPE_UNSPECIFIED",
|
||||
"NO_OPERATION",
|
||||
"REMOVED_FROM_INBOX"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"System action is unspecified.",
|
||||
"No operation.",
|
||||
"Messages were removed from the inbox."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -873,6 +1100,10 @@
|
||||
"description": "The header from display name.",
|
||||
"type": "string"
|
||||
},
|
||||
"entity": {
|
||||
"$ref": "User",
|
||||
"description": "The actor who triggered a gmail phishing alert."
|
||||
},
|
||||
"fromHeader": {
|
||||
"description": "The sender email address.",
|
||||
"type": "string"
|
||||
@@ -880,6 +1111,21 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MatchInfo": {
|
||||
"description": "Proto that contains match information from the condition part of the rule.",
|
||||
"id": "MatchInfo",
|
||||
"properties": {
|
||||
"predefinedDetector": {
|
||||
"$ref": "PredefinedDetectorInfo",
|
||||
"description": "For matched detector predefined by Google."
|
||||
},
|
||||
"userDefinedDetector": {
|
||||
"$ref": "UserDefinedDetectorInfo",
|
||||
"description": "For matched detector defined by administrators."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Notification": {
|
||||
"description": "Settings for callback notifications.\nFor more details see [G Suite Alert\nNotification](/admin-sdk/alertcenter/guides/notifications).",
|
||||
"id": "Notification",
|
||||
@@ -917,6 +1163,165 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PredefinedDetectorInfo": {
|
||||
"description": "Detector provided by Google.",
|
||||
"id": "PredefinedDetectorInfo",
|
||||
"properties": {
|
||||
"detectorName": {
|
||||
"description": "Name that uniquely identifies the detector.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"RequestInfo": {
|
||||
"description": "Requests for one application that needs default SQL setup.",
|
||||
"id": "RequestInfo",
|
||||
"properties": {
|
||||
"appDeveloperEmail": {
|
||||
"description": "List of app developers who triggered notifications for above\napplication.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"appKey": {
|
||||
"description": "Required. The application that requires the SQL setup.",
|
||||
"type": "string"
|
||||
},
|
||||
"numberOfRequests": {
|
||||
"description": "Required. Number of requests sent for this application to set up default\nSQL instance.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ResourceInfo": {
|
||||
"description": "Proto that contains resource information.",
|
||||
"id": "ResourceInfo",
|
||||
"properties": {
|
||||
"documentId": {
|
||||
"description": "Drive file ID.",
|
||||
"type": "string"
|
||||
},
|
||||
"resourceTitle": {
|
||||
"description": "Title of the resource, for example email subject, or document title.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"RuleInfo": {
|
||||
"description": "Proto that contains rule information.",
|
||||
"id": "RuleInfo",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "User provided name of the rule.",
|
||||
"type": "string"
|
||||
},
|
||||
"resourceName": {
|
||||
"description": "Resource name that uniquely identifies the rule.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"RuleViolationInfo": {
|
||||
"description": "Common alert information about violated rules that are configured by G Suite\nadministrators.",
|
||||
"id": "RuleViolationInfo",
|
||||
"properties": {
|
||||
"dataSource": {
|
||||
"description": "Source of the data.",
|
||||
"enum": [
|
||||
"DATA_SOURCE_UNSPECIFIED",
|
||||
"DRIVE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Data source is unspecified.",
|
||||
"Drive data source."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"matchInfo": {
|
||||
"description": "List of matches that were found in the resource content.",
|
||||
"items": {
|
||||
"$ref": "MatchInfo"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"recipients": {
|
||||
"description": "Resource recipients.\n\nFor Drive, they are grantees that the Drive file was shared with at the\ntime of rule triggering. Valid values include user emails, group emails,\ndomains, or 'anyone' if the file was publicly accessible. If the file was\nprivate the recipients list will be empty.\n\nFor Gmail, they are emails of the users or groups that the Gmail message\nwas sent to.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"resourceInfo": {
|
||||
"$ref": "ResourceInfo",
|
||||
"description": "Details of the resource which violated the rule."
|
||||
},
|
||||
"ruleInfo": {
|
||||
"$ref": "RuleInfo",
|
||||
"description": "Details of the violated rule."
|
||||
},
|
||||
"suppressedActionTypes": {
|
||||
"description": "Actions suppressed due to other actions with higher priority.",
|
||||
"enumDescriptions": [
|
||||
"Action type is unspecified.",
|
||||
"Block sharing a file externally.",
|
||||
"Show a warning message when sharing a file externally.",
|
||||
"Send alert."
|
||||
],
|
||||
"items": {
|
||||
"enum": [
|
||||
"ACTION_TYPE_UNSPECIFIED",
|
||||
"DRIVE_BLOCK_EXTERNAL_SHARING",
|
||||
"DRIVE_WARN_ON_EXTERNAL_SHARING",
|
||||
"ALERT"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"trigger": {
|
||||
"description": "Trigger of the rule.",
|
||||
"enum": [
|
||||
"TRIGGER_UNSPECIFIED",
|
||||
"DRIVE_SHARE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Trigger is unspecified.",
|
||||
"A Drive file is shared."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"triggeredActionTypes": {
|
||||
"description": "Actions applied as a consequence of the rule being triggered.",
|
||||
"enumDescriptions": [
|
||||
"Action type is unspecified.",
|
||||
"Block sharing a file externally.",
|
||||
"Show a warning message when sharing a file externally.",
|
||||
"Send alert."
|
||||
],
|
||||
"items": {
|
||||
"enum": [
|
||||
"ACTION_TYPE_UNSPECIFIED",
|
||||
"DRIVE_BLOCK_EXTERNAL_SHARING",
|
||||
"DRIVE_WARN_ON_EXTERNAL_SHARING",
|
||||
"ALERT"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"triggeringUserEmail": {
|
||||
"description": "Email of the user who caused the violation. Value could be empty if not\napplicable, for example, a violation found by drive continuous scan.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Settings": {
|
||||
"description": "Customer-level settings.",
|
||||
"id": "Settings",
|
||||
@@ -942,6 +1347,33 @@
|
||||
},
|
||||
"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",
|
||||
"properties": {
|
||||
"code": {
|
||||
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"details": {
|
||||
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
|
||||
"items": {
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object. Contains field @type with type URL.",
|
||||
"type": "any"
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"message": {
|
||||
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SuspiciousActivity": {
|
||||
"description": "A mobile suspicious activity alert. Derived from audit logs.",
|
||||
"id": "SuspiciousActivity",
|
||||
@@ -1013,6 +1445,36 @@
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"User": {
|
||||
"description": "A user.",
|
||||
"id": "User",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "Display name of the user.",
|
||||
"type": "string"
|
||||
},
|
||||
"emailAddress": {
|
||||
"description": "Email address of the user.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"UserDefinedDetectorInfo": {
|
||||
"description": "Detector defined by administrators.",
|
||||
"id": "UserDefinedDetectorInfo",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "Display name of the detector.",
|
||||
"type": "string"
|
||||
},
|
||||
"resourceName": {
|
||||
"description": "Resource name that uniquely identifies the detector.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
|
||||
@@ -32,7 +32,7 @@
|
||||
"description": "Views and manages your Google Analytics data.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/analytics/",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/H4vWgpd1MCO4wKLGF823qtL1fw0\"",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/o_TVyaWurnALX6ZIQ952-U5m22Y\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/analytics-16.png",
|
||||
"x32": "https://www.google.com/images/icons/product/analytics-32.png"
|
||||
@@ -3805,7 +3805,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190604",
|
||||
"revision": "20190807",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Account": {
|
||||
@@ -7174,6 +7174,10 @@
|
||||
"description": "Value is \"analytics#userDeletionRequest\".",
|
||||
"type": "string"
|
||||
},
|
||||
"propertyId": {
|
||||
"description": "Property ID",
|
||||
"type": "string"
|
||||
},
|
||||
"webPropertyId": {
|
||||
"description": "Web property ID of the form UA-XXXXX-YY.",
|
||||
"type": "string"
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
},
|
||||
"id": "analyticsreporting:v4",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://analyticsreporting.mtls.googleapis.com/",
|
||||
"name": "analyticsreporting",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -154,7 +155,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190625",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://analyticsreporting.googleapis.com/",
|
||||
"schemas": {
|
||||
"Activity": {
|
||||
@@ -162,7 +163,7 @@
|
||||
"id": "Activity",
|
||||
"properties": {
|
||||
"activityTime": {
|
||||
"description": "Timestamp of the activity.",
|
||||
"description": "Timestamp of the activity. If activities for a visit cross midnight and\noccur in two separate dates, then two sessions (one per date)\nshare the session identifier.\nFor example, say session ID 113472 has activity within 2019-08-20, and\nsession ID 243742 has activity within 2019-08-25 and 2019-08-26. Session ID\n113472 is one session, and session ID 243742 is two sessions.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -283,7 +284,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"lifetimeValue": {
|
||||
"description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
|
||||
"description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view\n ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
@@ -578,7 +579,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"useResourceQuotas": {
|
||||
"description": "Enables\n[resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4),\n(defaults to `False`). If this field is set to `True` the\nper view (profile) quotas are governed by the computational\ncost of the request. Note that using cost based quotas will\nhigher enable sampling rates. (10 Million for `SMALL`,\n100M for `LARGE`. See the\n[limits and quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details.",
|
||||
"description": "Enables\n[resource based\nquotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4),\n(defaults to `False`). If this field is set to `True` the\nper view (profile) quotas are governed by the computational\ncost of the request. Note that using cost based quotas will\nhigher enable sampling rates. (10 Million for `SMALL`,\n100M for `LARGE`. See the\n[limits and quotas\ndocumentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4)\nfor details.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
@@ -1117,14 +1118,14 @@
|
||||
"type": "array"
|
||||
},
|
||||
"dimensions": {
|
||||
"description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
|
||||
"description": "The dimensions requested.\nRequests can have a total of 9 dimensions.",
|
||||
"items": {
|
||||
"$ref": "Dimension"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"filtersExpression": {
|
||||
"description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
|
||||
"description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters\nreference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
|
||||
"type": "string"
|
||||
},
|
||||
"hideTotals": {
|
||||
|
||||
@@ -13,6 +13,7 @@
|
||||
},
|
||||
"id": "androiddeviceprovisioning:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://androiddeviceprovisioning.mtls.googleapis.com/",
|
||||
"name": "androiddeviceprovisioning",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -425,7 +426,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -824,7 +825,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190622",
|
||||
"revision": "20200408",
|
||||
"rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
|
||||
"schemas": {
|
||||
"ClaimDeviceRequest": {
|
||||
@@ -896,7 +897,7 @@
|
||||
"id": "Company",
|
||||
"properties": {
|
||||
"adminEmails": {
|
||||
"description": "Input only. Optional. Email address of customer's users in the admin role.\nEach email address must be associated with a Google Account.",
|
||||
"description": "Optional. Input only. Email address of customer's users in the admin role.\nEach email address must be associated with a Google Account.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1761,13 +1762,13 @@
|
||||
"properties": {
|
||||
"deviceMetadata": {
|
||||
"$ref": "DeviceMetadata",
|
||||
"description": "Required. The metdata to attach to the device."
|
||||
"description": "Required. The metadata to attach to the device."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"UpdateMetadataArguments": {
|
||||
"description": "Identifies metdata updates to one device.",
|
||||
"description": "Identifies metadata updates to one device.",
|
||||
"id": "UpdateMetadataArguments",
|
||||
"properties": {
|
||||
"deviceId": {
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
"description": "Manages the deployment of apps to Android for Work users.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/android/work/play/emm-api",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/cVTv8b9hTTB3FqZyWpqQbG2zALc\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/dchEQv1fOU-CrzLmTHLQqSguxQA\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/android-16.png",
|
||||
"x32": "https://www.google.com/images/icons/product/android-32.png"
|
||||
@@ -212,51 +212,6 @@
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates the device policy. This method supports patch semantics.",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "androidenterprise.devices.patch",
|
||||
"parameterOrder": [
|
||||
"enterpriseId",
|
||||
"userId",
|
||||
"deviceId"
|
||||
],
|
||||
"parameters": {
|
||||
"deviceId": {
|
||||
"description": "The ID of the device.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"enterpriseId": {
|
||||
"description": "The ID of the enterprise.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Mask that identifies which fields to update. If not set, all modifiable fields will be modified.\n\nWhen set in a query parameter, this field should be specified as updateMask=<field1>,<field2>,...",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"userId": {
|
||||
"description": "The ID of the user.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}",
|
||||
"request": {
|
||||
"$ref": "Device"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Device"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"setState": {
|
||||
"description": "Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.",
|
||||
"httpMethod": "PUT",
|
||||
@@ -789,51 +744,6 @@
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Adds or updates an entitlement to an app for a user. This method supports patch semantics.",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "androidenterprise.entitlements.patch",
|
||||
"parameterOrder": [
|
||||
"enterpriseId",
|
||||
"userId",
|
||||
"entitlementId"
|
||||
],
|
||||
"parameters": {
|
||||
"enterpriseId": {
|
||||
"description": "The ID of the enterprise.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"entitlementId": {
|
||||
"description": "The ID of the entitlement (a product ID), e.g. \"app:com.google.android.gm\".",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"install": {
|
||||
"description": "Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"userId": {
|
||||
"description": "The ID of the user.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}",
|
||||
"request": {
|
||||
"$ref": "Entitlement"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Entitlement"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"update": {
|
||||
"description": "Adds or updates an entitlement to an app for a user.",
|
||||
"httpMethod": "PUT",
|
||||
@@ -1096,53 +1006,6 @@
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary. This method supports patch semantics.",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "androidenterprise.installs.patch",
|
||||
"parameterOrder": [
|
||||
"enterpriseId",
|
||||
"userId",
|
||||
"deviceId",
|
||||
"installId"
|
||||
],
|
||||
"parameters": {
|
||||
"deviceId": {
|
||||
"description": "The Android ID of the device.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"enterpriseId": {
|
||||
"description": "The ID of the enterprise.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"installId": {
|
||||
"description": "The ID of the product represented by the install, e.g. \"app:com.google.android.gm\".",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"userId": {
|
||||
"description": "The ID of the user.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}",
|
||||
"request": {
|
||||
"$ref": "Install"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Install"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"update": {
|
||||
"description": "Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary.",
|
||||
"httpMethod": "PUT",
|
||||
@@ -1316,53 +1179,6 @@
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics.",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "androidenterprise.managedconfigurationsfordevice.patch",
|
||||
"parameterOrder": [
|
||||
"enterpriseId",
|
||||
"userId",
|
||||
"deviceId",
|
||||
"managedConfigurationForDeviceId"
|
||||
],
|
||||
"parameters": {
|
||||
"deviceId": {
|
||||
"description": "The Android ID of the device.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"enterpriseId": {
|
||||
"description": "The ID of the enterprise.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"managedConfigurationForDeviceId": {
|
||||
"description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"userId": {
|
||||
"description": "The ID of the user.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}",
|
||||
"request": {
|
||||
"$ref": "ManagedConfiguration"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "ManagedConfiguration"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"update": {
|
||||
"description": "Adds or updates a per-device managed configuration for an app for the specified device.",
|
||||
"httpMethod": "PUT",
|
||||
@@ -1515,46 +1331,6 @@
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties. This method supports patch semantics.",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "androidenterprise.managedconfigurationsforuser.patch",
|
||||
"parameterOrder": [
|
||||
"enterpriseId",
|
||||
"userId",
|
||||
"managedConfigurationForUserId"
|
||||
],
|
||||
"parameters": {
|
||||
"enterpriseId": {
|
||||
"description": "The ID of the enterprise.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"managedConfigurationForUserId": {
|
||||
"description": "The ID of the managed configuration (a product ID), e.g. \"app:com.google.android.gm\".",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"userId": {
|
||||
"description": "The ID of the user.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}",
|
||||
"request": {
|
||||
"$ref": "ManagedConfiguration"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "ManagedConfiguration"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"update": {
|
||||
"description": "Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties.",
|
||||
"httpMethod": "PUT",
|
||||
@@ -1600,7 +1376,7 @@
|
||||
"managedconfigurationssettings": {
|
||||
"methods": {
|
||||
"list": {
|
||||
"description": "Lists all the managed configurations settings for the specified app. Only the ID and the name is set.",
|
||||
"description": "Lists all the managed configurations settings for the specified app.",
|
||||
"httpMethod": "GET",
|
||||
"id": "androidenterprise.managedconfigurationssettings.list",
|
||||
"parameterOrder": [
|
||||
@@ -2124,46 +1900,6 @@
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates a cluster. This method supports patch semantics.",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "androidenterprise.storelayoutclusters.patch",
|
||||
"parameterOrder": [
|
||||
"enterpriseId",
|
||||
"pageId",
|
||||
"clusterId"
|
||||
],
|
||||
"parameters": {
|
||||
"clusterId": {
|
||||
"description": "The ID of the cluster.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"enterpriseId": {
|
||||
"description": "The ID of the enterprise.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"pageId": {
|
||||
"description": "The ID of the page.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}",
|
||||
"request": {
|
||||
"$ref": "StoreCluster"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "StoreCluster"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"update": {
|
||||
"description": "Updates a cluster.",
|
||||
"httpMethod": "PUT",
|
||||
@@ -2314,39 +2050,6 @@
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates the content of a store page. This method supports patch semantics.",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "androidenterprise.storelayoutpages.patch",
|
||||
"parameterOrder": [
|
||||
"enterpriseId",
|
||||
"pageId"
|
||||
],
|
||||
"parameters": {
|
||||
"enterpriseId": {
|
||||
"description": "The ID of the enterprise.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"pageId": {
|
||||
"description": "The ID of the page.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "enterprises/{enterpriseId}/storeLayout/pages/{pageId}",
|
||||
"request": {
|
||||
"$ref": "StorePage"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "StorePage"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"update": {
|
||||
"description": "Updates the content of a store page.",
|
||||
"httpMethod": "PUT",
|
||||
@@ -2587,39 +2290,6 @@
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates the details of an EMM-managed user.\n\nCan be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics.",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "androidenterprise.users.patch",
|
||||
"parameterOrder": [
|
||||
"enterpriseId",
|
||||
"userId"
|
||||
],
|
||||
"parameters": {
|
||||
"enterpriseId": {
|
||||
"description": "The ID of the enterprise.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"userId": {
|
||||
"description": "The ID of the user.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "enterprises/{enterpriseId}/users/{userId}",
|
||||
"request": {
|
||||
"$ref": "User"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "User"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"revokeDeviceAccess": {
|
||||
"description": "Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices.\n\nThis call only works with EMM-managed accounts.",
|
||||
"httpMethod": "DELETE",
|
||||
@@ -2850,39 +2520,6 @@
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates an existing web app. This method supports patch semantics.",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "androidenterprise.webapps.patch",
|
||||
"parameterOrder": [
|
||||
"enterpriseId",
|
||||
"webAppId"
|
||||
],
|
||||
"parameters": {
|
||||
"enterpriseId": {
|
||||
"description": "The ID of the enterprise.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"webAppId": {
|
||||
"description": "The ID of the web app.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "enterprises/{enterpriseId}/webApps/{webAppId}",
|
||||
"request": {
|
||||
"$ref": "WebApp"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "WebApp"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidenterprise"
|
||||
]
|
||||
},
|
||||
"update": {
|
||||
"description": "Updates an existing web app.",
|
||||
"httpMethod": "PUT",
|
||||
@@ -2919,7 +2556,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190624",
|
||||
"revision": "20200325",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Administrator": {
|
||||
@@ -2939,7 +2576,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#administratorWebToken",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#administratorWebToken\".",
|
||||
"type": "string"
|
||||
},
|
||||
"token": {
|
||||
@@ -2955,7 +2591,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#administratorWebTokenSpec",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#administratorWebTokenSpec\".",
|
||||
"type": "string"
|
||||
},
|
||||
"managedConfigurations": {
|
||||
@@ -2963,7 +2598,7 @@
|
||||
"description": "Options for displaying the Managed Configuration page."
|
||||
},
|
||||
"parent": {
|
||||
"description": "The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https.",
|
||||
"description": "The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https. Use whitespaces to separate multiple parent URIs.",
|
||||
"type": "string"
|
||||
},
|
||||
"permission": {
|
||||
@@ -3051,8 +2686,7 @@
|
||||
"id": "AppRestrictionsSchema",
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#appRestrictionsSchema",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#appRestrictionsSchema\".",
|
||||
"description": "Deprecated.",
|
||||
"type": "string"
|
||||
},
|
||||
"restrictions": {
|
||||
@@ -3225,7 +2859,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#approvalUrlInfo",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#approvalUrlInfo\".",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -3237,7 +2870,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#authenticationToken",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#authenticationToken\".",
|
||||
"type": "string"
|
||||
},
|
||||
"token": {
|
||||
@@ -3286,7 +2918,7 @@
|
||||
"type": "integer"
|
||||
},
|
||||
"minimumVersionCode": {
|
||||
"description": "The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update.",
|
||||
"description": "The minimum version of the app. If a lower version of the app is installed, then the app will be auto-updated according to the auto-install constraints, instead of waiting for the regular auto-update. You can set a minimum version code for at most 20 apps per device.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -3299,7 +2931,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#configurationVariables",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#configurationVariables\".",
|
||||
"type": "string"
|
||||
},
|
||||
"mcmId": {
|
||||
@@ -3326,7 +2957,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#device",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#device\".",
|
||||
"type": "string"
|
||||
},
|
||||
"managementType": {
|
||||
@@ -3392,7 +3022,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#deviceState",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#deviceState\".",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -3434,7 +3063,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#enterprise",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterprise\".",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
@@ -3458,7 +3086,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#enterpriseAccount",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#enterpriseAccount\".",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -3503,7 +3130,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#entitlement",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#entitlement\".",
|
||||
"type": "string"
|
||||
},
|
||||
"productId": {
|
||||
@@ -3550,7 +3176,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#groupLicense",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#groupLicense\".",
|
||||
"type": "string"
|
||||
},
|
||||
"numProvisioned": {
|
||||
@@ -3622,7 +3247,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#install",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#install\".",
|
||||
"type": "string"
|
||||
},
|
||||
"productId": {
|
||||
@@ -3752,8 +3376,7 @@
|
||||
"description": "Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user."
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#managedConfiguration",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfiguration\".",
|
||||
"description": "Deprecated.",
|
||||
"type": "string"
|
||||
},
|
||||
"managedProperty": {
|
||||
@@ -3814,7 +3437,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#managedConfigurationsSettings",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#managedConfigurationsSettings\".",
|
||||
"type": "string"
|
||||
},
|
||||
"lastUpdatedTimestampMillis": {
|
||||
@@ -3822,13 +3444,6 @@
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"managedProperty": {
|
||||
"description": "The set of managed properties for this configuration.",
|
||||
"items": {
|
||||
"$ref": "ManagedProperty"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"mcmId": {
|
||||
"description": "The ID of the managed configurations settings.",
|
||||
"type": "string"
|
||||
@@ -4021,7 +3636,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#notificationSet",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#notificationSet\".",
|
||||
"type": "string"
|
||||
},
|
||||
"notification": {
|
||||
@@ -4066,7 +3680,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#permission",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#permission\".",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
@@ -4166,13 +3779,19 @@
|
||||
"description": "How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted.",
|
||||
"type": "string"
|
||||
},
|
||||
"features": {
|
||||
"description": "Noteworthy features (if any) of this product.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"iconUrl": {
|
||||
"description": "A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px.",
|
||||
"type": "string"
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#product",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#product\".",
|
||||
"type": "string"
|
||||
},
|
||||
"lastUpdatedTimestampMillis": {
|
||||
@@ -4285,7 +3904,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#productPermissions",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productPermissions\".",
|
||||
"type": "string"
|
||||
},
|
||||
"permission": {
|
||||
@@ -4341,7 +3959,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#productSet",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productSet\".",
|
||||
"type": "string"
|
||||
},
|
||||
"productId": {
|
||||
@@ -4465,7 +4082,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#serviceAccount",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#serviceAccount\".",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
@@ -4489,7 +4105,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#serviceAccountKey",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#serviceAccountKey\".",
|
||||
"type": "string"
|
||||
},
|
||||
"publicData": {
|
||||
@@ -4530,8 +4145,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#signupInfo",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#signupInfo\".",
|
||||
"description": "Deprecated.",
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
@@ -4551,7 +4165,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#storeCluster",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeCluster\".",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
@@ -4585,7 +4198,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#storeLayout",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeLayout\".",
|
||||
"type": "string"
|
||||
},
|
||||
"storeLayoutType": {
|
||||
@@ -4643,7 +4255,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#storePage",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storePage\".",
|
||||
"type": "string"
|
||||
},
|
||||
"link": {
|
||||
@@ -4722,7 +4333,6 @@
|
||||
},
|
||||
"kind": {
|
||||
"default": "androidenterprise#user",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#user\".",
|
||||
"type": "string"
|
||||
},
|
||||
"managementType": {
|
||||
@@ -4742,7 +4352,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#userToken",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#userToken\".",
|
||||
"type": "string"
|
||||
},
|
||||
"token": {
|
||||
@@ -4781,7 +4390,6 @@
|
||||
"properties": {
|
||||
"kind": {
|
||||
"default": "androidenterprise#variableSet",
|
||||
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#variableSet\".",
|
||||
"type": "string"
|
||||
},
|
||||
"placeholder": {
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "androidmanagement:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://androidmanagement.mtls.googleapis.com/",
|
||||
"name": "androidmanagement",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -263,6 +264,11 @@
|
||||
"location": "query",
|
||||
"repeated": true,
|
||||
"type": "string"
|
||||
},
|
||||
"wipeReasonMessage": {
|
||||
"description": "Optional. A short message displayed to the user before wiping the work profile on personal devices. This has no effect on company owned devices. The maximum message length is 200 characters.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
@@ -918,9 +924,32 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190624",
|
||||
"revision": "20200330",
|
||||
"rootUrl": "https://androidmanagement.googleapis.com/",
|
||||
"schemas": {
|
||||
"AdvancedSecurityOverrides": {
|
||||
"description": "Security policies set to the most secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values.",
|
||||
"id": "AdvancedSecurityOverrides",
|
||||
"properties": {
|
||||
"untrustedAppsPolicy": {
|
||||
"description": "The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated).",
|
||||
"enum": [
|
||||
"UNTRUSTED_APPS_POLICY_UNSPECIFIED",
|
||||
"DISALLOW_INSTALL",
|
||||
"ALLOW_INSTALL_IN_PERSONAL_PROFILE_ONLY",
|
||||
"ALLOW_INSTALL_DEVICE_WIDE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified. Defaults to DISALLOW_INSTALL.",
|
||||
"Default. Disallow untrusted app installs on entire device.",
|
||||
"For devices with work profiles, allow untrusted app installs in the device's personal profile only.",
|
||||
"Allow untrusted app installs on entire device."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AlwaysOnVpnPackage": {
|
||||
"description": "Configuration for an always-on VPN connection.",
|
||||
"id": "AlwaysOnVpnPackage",
|
||||
@@ -948,10 +977,32 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AppTrackInfo": {
|
||||
"description": "Id to name association of a app track.",
|
||||
"id": "AppTrackInfo",
|
||||
"properties": {
|
||||
"trackAlias": {
|
||||
"description": "The track name associated with the trackId, set in the Play Console. The name is modifiable from Play Console.",
|
||||
"type": "string"
|
||||
},
|
||||
"trackId": {
|
||||
"description": "The unmodifiable unique track identifier, taken from the releaseTrackId in the URL of the Play Console page that displays the app\u2019s track information.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Application": {
|
||||
"description": "Information about an app.",
|
||||
"id": "Application",
|
||||
"properties": {
|
||||
"appTracks": {
|
||||
"description": "Application tracks visible to the enterprise.",
|
||||
"items": {
|
||||
"$ref": "AppTrackInfo"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"managedProperties": {
|
||||
"description": "The set of managed properties available to be pre-configured for the app.",
|
||||
"items": {
|
||||
@@ -1038,6 +1089,13 @@
|
||||
"description": "Policy for an individual app.",
|
||||
"id": "ApplicationPolicy",
|
||||
"properties": {
|
||||
"accessibleTrackIds": {
|
||||
"description": "List of the app\u2019s track IDs that a device belonging to the enterprise can access. If the list contains multiple track IDs, devices receive the latest version among all accessible tracks. If the list contains no track IDs, devices only have access to the app\u2019s production track. More details about each track are available in AppTrackInfo.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"defaultPermissionPolicy": {
|
||||
"description": "The default policy for all permissions requested by the app. If specified, this overrides the policy-level default_permission_policy which applies to all apps. It does not override the permission_grants which applies to all apps.",
|
||||
"enum": [
|
||||
@@ -1091,7 +1149,8 @@
|
||||
"FORCE_INSTALLED",
|
||||
"BLOCKED",
|
||||
"AVAILABLE",
|
||||
"REQUIRED_FOR_SETUP"
|
||||
"REQUIRED_FOR_SETUP",
|
||||
"KIOSK"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified. Defaults to AVAILABLE.",
|
||||
@@ -1099,12 +1158,13 @@
|
||||
"The app is automatically installed and can't be removed by the user.",
|
||||
"The app is blocked and can't be installed. If the app was installed under a previous policy, it will be uninstalled.",
|
||||
"The app is available to install.",
|
||||
"The app is automatically installed and can't be removed by the user and will prevent setup from completion until installation is complete."
|
||||
"The app is automatically installed and can't be removed by the user and will prevent setup from completion until installation is complete.",
|
||||
"The app is automatically installed in kiosk mode: it's set as the preferred home intent and whitelisted for lock task mode. Device setup won't complete until the app is installed. After installation, users won't be able to remove the app. You can only set this installType for one app per policy. When this is present in the policy, status bar will be automatically disabled."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"lockTaskAllowed": {
|
||||
"description": "Whether the app is allowed to lock itself in full-screen mode.",
|
||||
"description": "Whether the app is allowed to lock itself in full-screen mode. DEPRECATED. Use InstallType KIOSK or kioskCustomLauncherEnabled to to configure a dedicated device.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"managedConfiguration": {
|
||||
@@ -1198,12 +1258,14 @@
|
||||
"state": {
|
||||
"description": "Application state.",
|
||||
"enum": [
|
||||
"INSTALLED",
|
||||
"REMOVED"
|
||||
"APPLICATION_STATE_UNSPECIFIED",
|
||||
"REMOVED",
|
||||
"INSTALLED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"App is installed on the device",
|
||||
"App was removed from the device"
|
||||
"App state is unspecified",
|
||||
"App was removed from the device",
|
||||
"App is installed on the device"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1370,6 +1432,28 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Date": {
|
||||
"description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:\nA full date, with non-zero year, month and day values\nA month and day value, with a zero year, e.g. an anniversary\nA year on its own, with zero month and day values\nA year and month value, with a zero day, e.g. a credit card expiration dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp.",
|
||||
"id": "Date",
|
||||
"properties": {
|
||||
"day": {
|
||||
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"month": {
|
||||
"description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"year": {
|
||||
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Device": {
|
||||
"description": "A device owned by an enterprise. Unless otherwise noted, all fields are read-only and can't be modified by enterprises.devices.patch.",
|
||||
"id": "Device",
|
||||
@@ -1529,6 +1613,10 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"securityPosture": {
|
||||
"$ref": "SecurityPosture",
|
||||
"description": "Device's security posture value that reflects how secure the device is."
|
||||
},
|
||||
"softwareInfo": {
|
||||
"$ref": "SoftwareInfo",
|
||||
"description": "Detailed information about the device software. This information is only available if softwareInfoEnabled is true in the device's policy."
|
||||
@@ -1555,7 +1643,7 @@
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Map of selected system properties name and value related to the device.",
|
||||
"description": "Map of selected system properties name and value related to the device. This information is only available if systemPropertiesEnabled is true in the device's policy.",
|
||||
"type": "object"
|
||||
},
|
||||
"user": {
|
||||
@@ -1778,7 +1866,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"signinDetails": {
|
||||
"description": "Sign-in details of the enterprise. Maximum of 1 SigninDetail is supported.",
|
||||
"description": "Sign-in details of the enterprise.",
|
||||
"items": {
|
||||
"$ref": "SigninDetail"
|
||||
},
|
||||
@@ -1809,6 +1897,21 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"FreezePeriod": {
|
||||
"description": "A system freeze period. When a device\u2019s clock is within the freeze period, all incoming system updates (including security patches) are blocked and won\u2019t be installed. When a device is outside the freeze period, normal update behavior applies. Leap years are ignored in freeze period calculations, in particular: * If Feb. 29th is set as the start or end date of a freeze period, the freeze period will start or end on Feb. 28th instead. * When a device\u2019s system clock reads Feb. 29th, it\u2019s treated as Feb. 28th. * When calculating the number of days in a freeze period or the time between two freeze periods, Feb. 29th is ignored and not counted as a day.",
|
||||
"id": "FreezePeriod",
|
||||
"properties": {
|
||||
"endDate": {
|
||||
"$ref": "Date",
|
||||
"description": "The end date (inclusive) of the freeze period. Must be no later than 90 days from the start date. If the end date is earlier than the start date, the freeze period is considered wrapping year-end. Note: year must not be set. For example, {\"month\": 1,\"date\": 30}."
|
||||
},
|
||||
"startDate": {
|
||||
"$ref": "Date",
|
||||
"description": "The start date (inclusive) of the freeze period. Note: year must not be set. For example, {\"month\": 1,\"date\": 30}."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"HardwareInfo": {
|
||||
"description": "Information about device hardware. The fields related to temperature thresholds are only available if hardwareStatusEnabled is true in the device's policy.",
|
||||
"id": "HardwareInfo",
|
||||
@@ -2007,6 +2110,87 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"KioskCustomization": {
|
||||
"description": "Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK.",
|
||||
"id": "KioskCustomization",
|
||||
"properties": {
|
||||
"deviceSettings": {
|
||||
"description": "Specifies whether the Settings app is allowed in kiosk mode.",
|
||||
"enum": [
|
||||
"DEVICE_SETTINGS_UNSPECIFIED",
|
||||
"SETTINGS_ACCESS_ALLOWED",
|
||||
"SETTINGS_ACCESS_BLOCKED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified, defaults to SETTINGS_ACCESS_ALLOWED.",
|
||||
"Access to the Settings app is allowed in kiosk mode.",
|
||||
"Access to the Settings app is not allowed in kiosk mode."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"powerButtonActions": {
|
||||
"description": "Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button.",
|
||||
"enum": [
|
||||
"POWER_BUTTON_ACTIONS_UNSPECIFIED",
|
||||
"POWER_BUTTON_AVAILABLE",
|
||||
"POWER_BUTTON_BLOCKED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified, defaults to POWER_BUTTON_AVAILABLE.",
|
||||
"The power menu (e.g. Power off, Restart) is shown when a user long-presses the Power button of a device in kiosk mode.",
|
||||
"The power menu (e.g. Power off, Restart) is not shown when a user long-presses the Power button of a device in kiosk mode. Note: this may prevent users from turning off the device."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"statusBar": {
|
||||
"description": "Specifies whether system info and notifications are disabled in kiosk mode.",
|
||||
"enum": [
|
||||
"STATUS_BAR_UNSPECIFIED",
|
||||
"NOTIFICATIONS_AND_SYSTEM_INFO_ENABLED",
|
||||
"NOTIFICATIONS_AND_SYSTEM_INFO_DISABLED",
|
||||
"SYSTEM_INFO_ONLY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified, defaults to INFO_AND_NOTIFICATIONS_DISABLED.",
|
||||
"System info and notifications are shown on the status bar in kiosk mode.Note: For this policy to take effect, the device's home button must be enabled using kioskCustomization.systemNavigation.",
|
||||
"System info and notifications are disabled in kiosk mode.",
|
||||
"Only system info is shown on the status bar."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"systemErrorWarnings": {
|
||||
"description": "Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the \"close app\" option on the UI.",
|
||||
"enum": [
|
||||
"SYSTEM_ERROR_WARNINGS_UNSPECIFIED",
|
||||
"ERROR_AND_WARNINGS_ENABLED",
|
||||
"ERROR_AND_WARNINGS_MUTED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified, defaults to ERROR_AND_WARNINGS_MUTED.",
|
||||
"All system error dialogs such as crash and app not responding (ANR) are displayed.",
|
||||
"All system error dialogs, such as crash and app not responding (ANR) are blocked. When blocked, the system force-stops the app as if the user closes the app from the UI."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"systemNavigation": {
|
||||
"description": "Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode.",
|
||||
"enum": [
|
||||
"SYSTEM_NAVIGATION_UNSPECIFIED",
|
||||
"NAVIGATION_ENABLED",
|
||||
"NAVIGATION_DISABLED",
|
||||
"HOME_BUTTON_ONLY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified, defaults to NAVIGATION_DISABLED.",
|
||||
"Home and overview buttons are enabled.",
|
||||
"The home and Overview buttons are not accessible.",
|
||||
"Only the home button is enabled."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"LaunchAppAction": {
|
||||
"description": "An action to launch an app.",
|
||||
"id": "LaunchAppAction",
|
||||
@@ -2152,6 +2336,7 @@
|
||||
"CHOICE",
|
||||
"MULTISELECT",
|
||||
"HIDDEN",
|
||||
"BUNDLE",
|
||||
"BUNDLE_ARRAY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
@@ -2162,6 +2347,7 @@
|
||||
"A choice of one item from a set.",
|
||||
"A choice of multiple items from a set.",
|
||||
"A hidden restriction of string type (the default value can be used to pass along information that can't be modified, such as a version code).",
|
||||
"A bundle of properties",
|
||||
"An array of property bundles."
|
||||
],
|
||||
"type": "string"
|
||||
@@ -2512,7 +2698,7 @@
|
||||
"The password must contain numeric characters with no repeating (4444) or ordered (1234, 4321, 2468) sequences.",
|
||||
"The password must contain alphabetic (or symbol) characters.",
|
||||
"The password must contain both numeric and alphabetic (or symbol) characters.",
|
||||
"The password must contain at least a letter, a numerical digit and a special symbol. Other password constraints, for example, password_minimum_letters are enforced."
|
||||
"The password must meet the minimum requirements specified in passwordMinimumLength, passwordMinimumLetters, passwordMinimumSymbols, etc. For example, if passwordMinimumSymbols is 2, the password must contain at least two symbols."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -2529,6 +2715,20 @@
|
||||
"The password requirements are only applied to the work profile."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"requirePasswordUnlock": {
|
||||
"description": "The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.",
|
||||
"enum": [
|
||||
"REQUIRE_PASSWORD_UNLOCK_UNSPECIFIED",
|
||||
"USE_DEFAULT_DEVICE_TIMEOUT",
|
||||
"REQUIRE_EVERY_DAY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified. Defaults to USE_DEFAULT_DEVICE_TIMEOUT.",
|
||||
"The timeout period is set to the device\u2019s default.",
|
||||
"The timeout period is set to 24 hours."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -2561,7 +2761,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"PersistentPreferredActivity": {
|
||||
"description": "A default activity for handling intents that match a particular intent filter.",
|
||||
"description": "A default activity for handling intents that match a particular intent filter. Note: To set up a kiosk, use InstallType to KIOSK rather than use persistent preferred activities.",
|
||||
"id": "PersistentPreferredActivity",
|
||||
"properties": {
|
||||
"actions": {
|
||||
@@ -2586,7 +2786,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "A policy resources represents a group settings that govern the behavior of a managed device and the apps installed on it.",
|
||||
"description": "A policy resource represents a group of settings that govern the behavior of a managed device and the apps installed on it.",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"accountTypesWithManagementDisabled": {
|
||||
@@ -2604,6 +2804,10 @@
|
||||
"description": "Whether adjusting the master volume is disabled.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"advancedSecurityOverrides": {
|
||||
"$ref": "AdvancedSecurityOverrides",
|
||||
"description": "Security policies set to the most secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values."
|
||||
},
|
||||
"alwaysOnVpnPackage": {
|
||||
"$ref": "AlwaysOnVpnPackage",
|
||||
"description": "Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting."
|
||||
@@ -2781,8 +2985,11 @@
|
||||
"Disable showing all notifications on secure keyguard screens.",
|
||||
"Disable unredacted notifications on secure keyguard screens.",
|
||||
"Ignore trust agent state on secure keyguard screens.",
|
||||
"Disable fingerprint sensor on keyguard secure screens.",
|
||||
"Disable fingerprint sensor on secure keyguard screens.",
|
||||
"Disable text entry into notifications on secure keyguard screens.",
|
||||
"Disable face authentication on secure keyguard screens.",
|
||||
"Disable iris authentication on secure keyguard screens.",
|
||||
"Disable all biometric authentication on secure keyguard screens.",
|
||||
"Disable all current and future keyguard customizations."
|
||||
],
|
||||
"items": {
|
||||
@@ -2794,6 +3001,9 @@
|
||||
"TRUST_AGENTS",
|
||||
"DISABLE_FINGERPRINT",
|
||||
"DISABLE_REMOTE_INPUT",
|
||||
"FACE",
|
||||
"IRIS",
|
||||
"BIOMETRICS",
|
||||
"ALL_FEATURES"
|
||||
],
|
||||
"type": "string"
|
||||
@@ -2801,9 +3011,13 @@
|
||||
"type": "array"
|
||||
},
|
||||
"kioskCustomLauncherEnabled": {
|
||||
"description": "Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. The apps appear on a single page in alphabetical order. It is recommended to also use status_bar_disabled to block access to device settings.",
|
||||
"description": "Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. Use kioskCustomization to further configure the kiosk device behavior.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"kioskCustomization": {
|
||||
"$ref": "KioskCustomization",
|
||||
"description": "Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK."
|
||||
},
|
||||
"locationMode": {
|
||||
"description": "The degree of location detection enabled. The user may change the value unless the user is otherwise blocked from accessing device settings.",
|
||||
"enum": [
|
||||
@@ -2885,7 +3099,7 @@
|
||||
},
|
||||
"passwordRequirements": {
|
||||
"$ref": "PasswordRequirements",
|
||||
"description": "Password requirements. DEPRECATED - Use password_policies"
|
||||
"description": "Password requirements. The field password_requirements.require_password_unlock must not be set. DEPRECATED - Use password_policies."
|
||||
},
|
||||
"permissionGrants": {
|
||||
"description": "Explicit permission or group grants or denials for all apps. These values override the default_permission_policy.",
|
||||
@@ -2894,6 +3108,10 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"permittedAccessibilityServices": {
|
||||
"$ref": "PackageNameList",
|
||||
"description": "Specifies permitted accessibility services. If the field is not set, any accessibility service can be used. If the field is set, only the accessibility services in this list and the system's built-in accessibility service can be used. In particular, if the field is set to empty, only the system's built-in accessibility servicess can be used."
|
||||
},
|
||||
"permittedInputMethods": {
|
||||
"$ref": "PackageNameList",
|
||||
"description": "If present, only the input methods provided by packages in this list are permitted. If this field is present, but the list is empty, then only system input methods are permitted."
|
||||
@@ -2967,7 +3185,7 @@
|
||||
},
|
||||
"shortSupportMessage": {
|
||||
"$ref": "UserFacingMessage",
|
||||
"description": "A message displayed to the user in the settings screen wherever functionality has been disabled by the admin."
|
||||
"description": "A message displayed to the user in the settings screen wherever functionality has been disabled by the admin. If the message is longer than 200 characters it may be truncated."
|
||||
},
|
||||
"skipFirstUseHintsEnabled": {
|
||||
"description": "Flag to skip hints on the first use. Enterprise admin can enable the system recommendation for apps to skip their user tutorial and other introductory hints on first start-up.",
|
||||
@@ -2978,7 +3196,7 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"statusBarDisabled": {
|
||||
"description": "Whether the status bar is disabled. This disables notifications, quick settings, and other screen overlays that allow escape from full-screen mode.",
|
||||
"description": "Whether the status bar is disabled. This disables notifications, quick settings, and other screen overlays that allow escape from full-screen mode. DEPRECATED. To disable the status bar on a kiosk device, use InstallType KIOSK or kioskCustomLauncherEnabled.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"statusReportingSettings": {
|
||||
@@ -3067,6 +3285,34 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PostureDetail": {
|
||||
"description": "Additional details regarding the security posture of the device.",
|
||||
"id": "PostureDetail",
|
||||
"properties": {
|
||||
"advice": {
|
||||
"description": "Corresponding admin-facing advice to mitigate this security risk and improve the security posture of the device.",
|
||||
"items": {
|
||||
"$ref": "UserFacingMessage"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"securityRisk": {
|
||||
"description": "A specific security risk that negatively affects the security posture of the device.",
|
||||
"enum": [
|
||||
"SECURITY_RISK_UNSPECIFIED",
|
||||
"UNKNOWN_OS",
|
||||
"COMPROMISED_OS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified.",
|
||||
"SafetyNet detects that the device is running an unknown OS (basicIntegrity check succeeds but ctsProfileMatch fails).",
|
||||
"SafetyNet detects that the device is running a compromised OS (basicIntegrity check fails)."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PowerManagementEvent": {
|
||||
"description": "A power management event.",
|
||||
"id": "PowerManagementEvent",
|
||||
@@ -3135,6 +3381,36 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SecurityPosture": {
|
||||
"description": "The security posture of the device, as determined by the current device state and the policies applied.",
|
||||
"id": "SecurityPosture",
|
||||
"properties": {
|
||||
"devicePosture": {
|
||||
"description": "Device's security posture value.",
|
||||
"enum": [
|
||||
"POSTURE_UNSPECIFIED",
|
||||
"SECURE",
|
||||
"AT_RISK",
|
||||
"POTENTIALLY_COMPROMISED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified. There is no posture detail for this posture value.",
|
||||
"This device is secure.",
|
||||
"This device may be more vulnerable to malicious actors than is recommended for use with corporate data.",
|
||||
"This device may be compromised and corporate data may be accessible to unauthorized actors."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"postureDetails": {
|
||||
"description": "Additional details regarding the security posture of the device.",
|
||||
"items": {
|
||||
"$ref": "PostureDetail"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SetupAction": {
|
||||
"description": "An action executed during setup.",
|
||||
"id": "SetupAction",
|
||||
@@ -3281,11 +3557,11 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"displayInfoEnabled": {
|
||||
"description": "Whether displays reporting is enabled.",
|
||||
"description": "Whether displays reporting is enabled. Report data is not available for personally owned devices with work profiles.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"hardwareStatusEnabled": {
|
||||
"description": "Whether hardware status reporting is enabled.",
|
||||
"description": "Whether hardware status reporting is enabled. Report data is not available for personally owned devices with work profiles.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"memoryInfoEnabled": {
|
||||
@@ -3297,12 +3573,16 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"powerManagementEventsEnabled": {
|
||||
"description": "Whether power management event reporting is enabled.",
|
||||
"description": "Whether power management event reporting is enabled. Report data is not available for personally owned devices with work profiles.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"softwareInfoEnabled": {
|
||||
"description": "Whether software info reporting is enabled.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"systemPropertiesEnabled": {
|
||||
"description": "Whether system properties reporting is enabled.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -3316,6 +3596,13 @@
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"freezePeriods": {
|
||||
"description": "An annually repeating time period in which over-the-air (OTA) system updates are postponed to freeze the OS version running on a device. To prevent freezing the device indefinitely, each freeze period must be separated by at least 60 days.",
|
||||
"items": {
|
||||
"$ref": "FreezePeriod"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"startMinutes": {
|
||||
"description": "If the type is WINDOWED, the start of the maintenance window, measured as the number of minutes after midnight in the device's local time. This value must be between 0 and 1439, inclusive.",
|
||||
"format": "int32",
|
||||
@@ -3424,7 +3711,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"versionCode": {
|
||||
"description": "The current version of the app.<p>Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.",
|
||||
"description": "The current version of the app.Note that the version can automatically increase during the lifetime of the web app, while Google does internal housekeeping to keep the web app up-to-date.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -3446,6 +3733,29 @@
|
||||
"description": "A web token used to access the managed Google Play iframe.",
|
||||
"id": "WebToken",
|
||||
"properties": {
|
||||
"enabledFeatures": {
|
||||
"description": "The features to enable. Use this if you want to control exactly which feature(s) will be activated; leave empty to allow all features.Restrictions / things to note: <ul> <li> If no features are listed here, all features are enabled \u2014 this is the default behavior where you give access to all features to your admins. <li> This must not contain any FEATURE_UNSPECIFIED values. <li> Repeated values are ignored </ul>",
|
||||
"enumDescriptions": [
|
||||
"Unspecified feature.",
|
||||
"The Managed Play search apps page (https://developers.google.com/android/management/apps#search-apps).",
|
||||
"The private apps page (https://developers.google.com/android/management/apps#private-apps).",
|
||||
"The Web Apps page (https://developers.google.com/android/management/apps#web-apps).",
|
||||
"The organize apps page (https://developers.google.com/android/management/apps#organize-apps).",
|
||||
"The managed configurations page (https://developers.google.com/android/management/managed-configurations-iframe)."
|
||||
],
|
||||
"items": {
|
||||
"enum": [
|
||||
"FEATURE_UNSPECIFIED",
|
||||
"PLAY_SEARCH",
|
||||
"PRIVATE_APPS",
|
||||
"WEB_APPS",
|
||||
"STORE_BUILDER",
|
||||
"MANAGED_CONFIGURATIONS"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the web token, which is generated by the server during creation in the form enterprises/{enterpriseId}/webTokens/{webTokenId}.",
|
||||
"type": "string"
|
||||
@@ -3455,7 +3765,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"permissions": {
|
||||
"description": "Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI.",
|
||||
"description": "Permissions available to an admin in the embedded UI. An admin must have all of these permissions in order to view the UI. This field is deprecated.",
|
||||
"enumDescriptions": [
|
||||
"This value is ignored.",
|
||||
"The permission to approve apps for the enterprise."
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
"description": "Accesses Android application developers' Google Play accounts.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/android-publisher",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Smmb-YrB3v4AA7xw1tkHqin8N68\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/dJDKYQiuTbXRABwAgpvNRKTp6J8\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/android-16.png",
|
||||
"x32": "https://www.google.com/images/icons/product/android-32.png"
|
||||
@@ -189,7 +189,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190702",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"InappPurchase": {
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
"description": "Accesses Android application developers' Google Play accounts.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/android-publisher",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/ntYqdbu8sX8YWLKgjvBOuA7H100\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/smKt4-KPxysOVRYukiTlrZzcTAU\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/android-16.png",
|
||||
"x32": "https://www.google.com/images/icons/product/android-32.png"
|
||||
@@ -148,7 +148,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190702",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"SubscriptionPurchase": {
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
"description": "Accesses Android application developers' Google Play accounts.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/android-publisher",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Xzykam64w9J0PZpvN6-fPRpjjvM\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/k6ve9mvJLQYNtOLJVCwlyhkSP30\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/android-16.png",
|
||||
"x32": "https://www.google.com/images/icons/product/android-32.png"
|
||||
@@ -2328,7 +2328,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"endTime": {
|
||||
"description": "The time, in milliseconds since the Epoch, of the newest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.",
|
||||
"description": "The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.",
|
||||
"format": "int64",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -2350,7 +2350,7 @@
|
||||
"type": "integer"
|
||||
},
|
||||
"startTime": {
|
||||
"description": "The time, in milliseconds since the Epoch, of the oldest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.",
|
||||
"description": "The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.",
|
||||
"format": "int64",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -2483,7 +2483,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190702",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Apk": {
|
||||
@@ -2895,6 +2895,10 @@
|
||||
"description": "A sha1 hash of the image that was uploaded.",
|
||||
"type": "string"
|
||||
},
|
||||
"sha256": {
|
||||
"description": "A sha256 hash of the image that was uploaded.",
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"description": "A URL that will serve a preview of the image.",
|
||||
"type": "string"
|
||||
@@ -2947,7 +2951,7 @@
|
||||
"description": "Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency."
|
||||
},
|
||||
"gracePeriod": {
|
||||
"description": "Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = \"P3D\" (three days) and \"P7D\" (seven days)",
|
||||
"description": "Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = \"P3D\" (three days), \"P7D\" (seven days), \"P14D\" (fourteen days), and \"P30D\" (thirty days)",
|
||||
"type": "string"
|
||||
},
|
||||
"listings": {
|
||||
@@ -2974,10 +2978,6 @@
|
||||
"description": "Purchase type enum value. Unmodifiable after creation.",
|
||||
"type": "string"
|
||||
},
|
||||
"season": {
|
||||
"$ref": "Season",
|
||||
"description": "Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions."
|
||||
},
|
||||
"sku": {
|
||||
"description": "The stock-keeping-unit (SKU) of the product, unique within an app.",
|
||||
"type": "string"
|
||||
@@ -3074,22 +3074,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MonthDay": {
|
||||
"id": "MonthDay",
|
||||
"properties": {
|
||||
"day": {
|
||||
"description": "Day of a month, value in [1, 31] range. Valid range depends on the specified month.",
|
||||
"format": "uint32",
|
||||
"type": "integer"
|
||||
},
|
||||
"month": {
|
||||
"description": "Month of a year. e.g. 1 = JAN, 2 = FEB etc.",
|
||||
"format": "uint32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PageInfo": {
|
||||
"id": "PageInfo",
|
||||
"properties": {
|
||||
@@ -3162,20 +3146,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Prorate": {
|
||||
"id": "Prorate",
|
||||
"properties": {
|
||||
"defaultPrice": {
|
||||
"$ref": "Price",
|
||||
"description": "Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price."
|
||||
},
|
||||
"start": {
|
||||
"$ref": "MonthDay",
|
||||
"description": "Defines the first day on which the price takes effect."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Review": {
|
||||
"id": "Review",
|
||||
"properties": {
|
||||
@@ -3248,27 +3218,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Season": {
|
||||
"id": "Season",
|
||||
"properties": {
|
||||
"end": {
|
||||
"$ref": "MonthDay",
|
||||
"description": "Inclusive end date of the recurrence period."
|
||||
},
|
||||
"prorations": {
|
||||
"description": "Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.",
|
||||
"items": {
|
||||
"$ref": "Prorate"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"start": {
|
||||
"$ref": "MonthDay",
|
||||
"description": "Inclusive start date of the recurrence period."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SubscriptionCancelSurveyResult": {
|
||||
"description": "Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey).",
|
||||
"id": "SubscriptionCancelSurveyResult",
|
||||
@@ -3400,7 +3349,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"purchaseType": {
|
||||
"description": "The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: \n- Test (i.e. purchased from a license testing account)",
|
||||
"description": "The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: \n- Test (i.e. purchased from a license testing account) \n- Promo (i.e. purchased using a promo code)",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
@@ -3447,13 +3396,6 @@
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"googlePlusCommunities": {
|
||||
"description": "A list of all Google+ Communities, as URLs, that define testers for this track.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -3597,7 +3539,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"purchaseToken": {
|
||||
"description": "The token that was generated when a purchase was made. This uniquely identifies a purchase.",
|
||||
"description": "The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API).",
|
||||
"type": "string"
|
||||
},
|
||||
"voidedTimeMillis": {
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
"description": "Accesses Android application developers' Google Play accounts.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/android-publisher",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/tLEn1KkE5NEmlpywSz1Qx5p8WMk\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/4LB2xyDuShFcAwfdsvXJqDirMa4\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/android-16.png",
|
||||
"x32": "https://www.google.com/images/icons/product/android-32.png"
|
||||
@@ -851,6 +851,8 @@
|
||||
},
|
||||
"imageType": {
|
||||
"enum": [
|
||||
"automotiveScreenshots",
|
||||
"daydreamStereoImage",
|
||||
"featureGraphic",
|
||||
"icon",
|
||||
"phoneScreenshots",
|
||||
@@ -870,6 +872,8 @@
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
""
|
||||
],
|
||||
"location": "path",
|
||||
@@ -913,6 +917,8 @@
|
||||
},
|
||||
"imageType": {
|
||||
"enum": [
|
||||
"automotiveScreenshots",
|
||||
"daydreamStereoImage",
|
||||
"featureGraphic",
|
||||
"icon",
|
||||
"phoneScreenshots",
|
||||
@@ -932,6 +938,8 @@
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
""
|
||||
],
|
||||
"location": "path",
|
||||
@@ -978,6 +986,8 @@
|
||||
},
|
||||
"imageType": {
|
||||
"enum": [
|
||||
"automotiveScreenshots",
|
||||
"daydreamStereoImage",
|
||||
"featureGraphic",
|
||||
"icon",
|
||||
"phoneScreenshots",
|
||||
@@ -997,6 +1007,8 @@
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
""
|
||||
],
|
||||
"location": "path",
|
||||
@@ -1059,6 +1071,8 @@
|
||||
},
|
||||
"imageType": {
|
||||
"enum": [
|
||||
"automotiveScreenshots",
|
||||
"daydreamStereoImage",
|
||||
"featureGraphic",
|
||||
"icon",
|
||||
"phoneScreenshots",
|
||||
@@ -1078,6 +1092,8 @@
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
""
|
||||
],
|
||||
"location": "path",
|
||||
@@ -2227,7 +2243,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"endTime": {
|
||||
"description": "The time, in milliseconds since the Epoch, of the newest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.",
|
||||
"description": "The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.",
|
||||
"format": "int64",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -2249,7 +2265,7 @@
|
||||
"type": "integer"
|
||||
},
|
||||
"startTime": {
|
||||
"description": "The time, in milliseconds since the Epoch, of the oldest voided in-app product purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.",
|
||||
"description": "The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.",
|
||||
"format": "int64",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -2257,6 +2273,12 @@
|
||||
"token": {
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The type of voided purchases that you want to see in the response. Possible values are: \n- 0: Only voided in-app product purchases will be returned in the response. This is the default value.\n- 1: Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"path": "{packageName}/purchases/voidedpurchases",
|
||||
@@ -2380,9 +2402,158 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"systemapks": {
|
||||
"resources": {
|
||||
"variants": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates a new variant of APK which is suitable for inclusion in a system image.",
|
||||
"httpMethod": "POST",
|
||||
"id": "androidpublisher.systemapks.variants.create",
|
||||
"parameterOrder": [
|
||||
"packageName",
|
||||
"versionCode"
|
||||
],
|
||||
"parameters": {
|
||||
"packageName": {
|
||||
"description": "Unique identifier for the Android app; for example, \"com.spiffygame\".",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"versionCode": {
|
||||
"description": "The version code of the App Bundle.",
|
||||
"format": "int64",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "{packageName}/systemApks/{versionCode}/variants",
|
||||
"request": {
|
||||
"$ref": "SystemApkVariantsCreateRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Variant"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidpublisher"
|
||||
]
|
||||
},
|
||||
"download": {
|
||||
"description": "Download a previously created APK which is suitable for inclusion in a system image.",
|
||||
"httpMethod": "GET",
|
||||
"id": "androidpublisher.systemapks.variants.download",
|
||||
"parameterOrder": [
|
||||
"packageName",
|
||||
"versionCode",
|
||||
"variantId"
|
||||
],
|
||||
"parameters": {
|
||||
"packageName": {
|
||||
"description": "Unique identifier for the Android app; for example, \"com.spiffygame\".",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"variantId": {
|
||||
"format": "uint32",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "integer"
|
||||
},
|
||||
"versionCode": {
|
||||
"description": "The version code of the App Bundle.",
|
||||
"format": "int64",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "{packageName}/systemApks/{versionCode}/variants/{variantId}:download",
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidpublisher"
|
||||
],
|
||||
"supportsMediaDownload": true,
|
||||
"useMediaDownloadService": true
|
||||
},
|
||||
"get": {
|
||||
"description": "Returns a previously created system APK variant.",
|
||||
"httpMethod": "GET",
|
||||
"id": "androidpublisher.systemapks.variants.get",
|
||||
"parameterOrder": [
|
||||
"packageName",
|
||||
"versionCode",
|
||||
"variantId"
|
||||
],
|
||||
"parameters": {
|
||||
"packageName": {
|
||||
"description": "Unique identifier for the Android app; for example, \"com.spiffygame\".",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"variantId": {
|
||||
"description": "Unique identifier for this variant.",
|
||||
"format": "uint32",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "integer"
|
||||
},
|
||||
"versionCode": {
|
||||
"description": "The version code of the App Bundle.",
|
||||
"format": "int64",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "{packageName}/systemApks/{versionCode}/variants/{variantId}",
|
||||
"response": {
|
||||
"$ref": "Variant"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidpublisher"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Returns the list of previously created system APK variants.",
|
||||
"httpMethod": "GET",
|
||||
"id": "androidpublisher.systemapks.variants.list",
|
||||
"parameterOrder": [
|
||||
"packageName",
|
||||
"versionCode"
|
||||
],
|
||||
"parameters": {
|
||||
"packageName": {
|
||||
"description": "Unique identifier for the Android app; for example, \"com.spiffygame\".",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"versionCode": {
|
||||
"description": "The version code of the App Bundle.",
|
||||
"format": "int64",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "{packageName}/systemApks/{versionCode}/variants",
|
||||
"response": {
|
||||
"$ref": "SystemApkVariantsListResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/androidpublisher"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190702",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Apk": {
|
||||
@@ -2392,6 +2563,9 @@
|
||||
"$ref": "ApkBinary",
|
||||
"description": "Information about the binary payload of this APK."
|
||||
},
|
||||
"testBinary": {
|
||||
"$ref": "ApkBinary"
|
||||
},
|
||||
"versionCode": {
|
||||
"description": "The version code of the APK, as specified in the APK's manifest file.",
|
||||
"format": "int32",
|
||||
@@ -2539,6 +2713,31 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Control": {
|
||||
"id": "Control",
|
||||
"properties": {
|
||||
"modRanges": {
|
||||
"items": {
|
||||
"$ref": "ModRange"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"stratifiedSamplings": {
|
||||
"items": {
|
||||
"$ref": "StratifiedSampling"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"versionCodes": {
|
||||
"items": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CountryTargeting": {
|
||||
"id": "CountryTargeting",
|
||||
"properties": {
|
||||
@@ -2643,6 +2842,28 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DeviceSpec": {
|
||||
"id": "DeviceSpec",
|
||||
"properties": {
|
||||
"screenDensity": {
|
||||
"format": "uint32",
|
||||
"type": "integer"
|
||||
},
|
||||
"supportedAbis": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"supportedLocales": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ExpansionFile": {
|
||||
"id": "ExpansionFile",
|
||||
"properties": {
|
||||
@@ -2778,6 +2999,10 @@
|
||||
"description": "A sha1 hash of the image that was uploaded.",
|
||||
"type": "string"
|
||||
},
|
||||
"sha256": {
|
||||
"description": "A sha256 hash of the image that was uploaded.",
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"description": "A URL that will serve a preview of the image.",
|
||||
"type": "string"
|
||||
@@ -2830,7 +3055,7 @@
|
||||
"description": "Default price cannot be zero. In-app products can never be free. Default price is always in the developer's Checkout merchant currency."
|
||||
},
|
||||
"gracePeriod": {
|
||||
"description": "Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = \"P3D\" (three days) and \"P7D\" (seven days)",
|
||||
"description": "Grace period of the subscription, specified in ISO 8601 format. It will allow developers to give their subscribers a grace period when the payment for the new recurrence period is declined. Acceptable values = \"P3D\" (three days), \"P7D\" (seven days), \"P14D\" (fourteen days), and \"P30D\" (thirty days)",
|
||||
"type": "string"
|
||||
},
|
||||
"listings": {
|
||||
@@ -2857,10 +3082,6 @@
|
||||
"description": "Purchase type enum value. Unmodifiable after creation.",
|
||||
"type": "string"
|
||||
},
|
||||
"season": {
|
||||
"$ref": "Season",
|
||||
"description": "Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions."
|
||||
},
|
||||
"sku": {
|
||||
"description": "The stock-keeping-unit (SKU) of the product, unique within an app.",
|
||||
"type": "string"
|
||||
@@ -3015,18 +3236,16 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MonthDay": {
|
||||
"id": "MonthDay",
|
||||
"ModRange": {
|
||||
"id": "ModRange",
|
||||
"properties": {
|
||||
"day": {
|
||||
"description": "Day of a month, value in [1, 31] range. Valid range depends on the specified month.",
|
||||
"format": "uint32",
|
||||
"type": "integer"
|
||||
"end": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"month": {
|
||||
"description": "Month of a year. e.g. 1 = JAN, 2 = FEB etc.",
|
||||
"format": "uint32",
|
||||
"type": "integer"
|
||||
"start": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -3090,6 +3309,10 @@
|
||||
"description": "The order id associated with the purchase of the inapp product.",
|
||||
"type": "string"
|
||||
},
|
||||
"productId": {
|
||||
"description": "The inapp product SKU.",
|
||||
"type": "string"
|
||||
},
|
||||
"purchaseState": {
|
||||
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled \n- Pending",
|
||||
"format": "int32",
|
||||
@@ -3100,10 +3323,19 @@
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"purchaseToken": {
|
||||
"description": "The purchase token generated to identify this purchase.",
|
||||
"type": "string"
|
||||
},
|
||||
"purchaseType": {
|
||||
"description": "The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: \n- Test (i.e. purchased from a license testing account) \n- Promo (i.e. purchased using a promo code) \n- Rewarded (i.e. from watching a video ad instead of paying)",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"quantity": {
|
||||
"description": "The quantity associated with the purchase of the inapp product.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -3118,20 +3350,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Prorate": {
|
||||
"id": "Prorate",
|
||||
"properties": {
|
||||
"defaultPrice": {
|
||||
"$ref": "Price",
|
||||
"description": "Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price."
|
||||
},
|
||||
"start": {
|
||||
"$ref": "MonthDay",
|
||||
"description": "Defines the first day on which the price takes effect."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Review": {
|
||||
"id": "Review",
|
||||
"properties": {
|
||||
@@ -3204,23 +3422,55 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Season": {
|
||||
"id": "Season",
|
||||
"Sampling": {
|
||||
"id": "Sampling",
|
||||
"properties": {
|
||||
"end": {
|
||||
"$ref": "MonthDay",
|
||||
"description": "Inclusive end date of the recurrence period."
|
||||
},
|
||||
"prorations": {
|
||||
"description": "Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information.",
|
||||
"modRanges": {
|
||||
"items": {
|
||||
"$ref": "Prorate"
|
||||
"$ref": "ModRange"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"start": {
|
||||
"$ref": "MonthDay",
|
||||
"description": "Inclusive start date of the recurrence period."
|
||||
"modulus": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"salt": {
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"stratifiedSamplings": {
|
||||
"items": {
|
||||
"$ref": "StratifiedSampling"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"useAndroidId": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"StratifiedSampling": {
|
||||
"id": "StratifiedSampling",
|
||||
"properties": {
|
||||
"modRanges": {
|
||||
"items": {
|
||||
"$ref": "ModRange"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"stratum": {
|
||||
"$ref": "Stratum"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Stratum": {
|
||||
"id": "Stratum",
|
||||
"properties": {
|
||||
"brand": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -3318,6 +3568,10 @@
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"externalAccountId": {
|
||||
"description": "User account identifier in the third-party service. Only present if account linking happened as part of the subscription purchase flow.",
|
||||
"type": "string"
|
||||
},
|
||||
"familyName": {
|
||||
"description": "The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
|
||||
"type": "string"
|
||||
@@ -3369,8 +3623,17 @@
|
||||
"description": "The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
|
||||
"type": "string"
|
||||
},
|
||||
"promotionCode": {
|
||||
"description": "The promotion code applied on this purchase. This field is only set if a vanity code promotion is applied when the subscription was purchased.",
|
||||
"type": "string"
|
||||
},
|
||||
"promotionType": {
|
||||
"description": "The type of promotion applied on this purchase. This field is only set if a promotion is applied when the subscription was purchased. Possible values are: \n- One time code \n- Vanity code",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"purchaseType": {
|
||||
"description": "The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: \n- Test (i.e. purchased from a license testing account)",
|
||||
"description": "The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: \n- Test (i.e. purchased from a license testing account) \n- Promo (i.e. purchased using a promo code)",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
@@ -3418,18 +3681,50 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SystemApkVariantsCreateRequest": {
|
||||
"id": "SystemApkVariantsCreateRequest",
|
||||
"properties": {
|
||||
"deviceSpec": {
|
||||
"$ref": "DeviceSpec"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SystemApkVariantsListResponse": {
|
||||
"id": "SystemApkVariantsListResponse",
|
||||
"properties": {
|
||||
"variants": {
|
||||
"items": {
|
||||
"$ref": "Variant"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Testers": {
|
||||
"id": "Testers",
|
||||
"properties": {
|
||||
"googleGroups": {
|
||||
"description": "A list of all Google Groups, as email addresses, that define testers for this track.",
|
||||
"autoEnrolledAndroidGroups": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"googlePlusCommunities": {
|
||||
"description": "A list of all Google+ Communities, as URLs, that define testers for this track.",
|
||||
"autoEnrolledGoogleGroups": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"excludedGoogleGroups": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"googleGroups": {
|
||||
"description": "A list of all Google Groups, as email addresses, that define testers for this track.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -3484,13 +3779,30 @@
|
||||
"TrackRelease": {
|
||||
"id": "TrackRelease",
|
||||
"properties": {
|
||||
"controls": {
|
||||
"items": {
|
||||
"$ref": "Control"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"countryTargeting": {
|
||||
"$ref": "CountryTargeting"
|
||||
},
|
||||
"inAppUpdatePriority": {
|
||||
"description": "In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 0. See https://developer.android.com/guide/playcore/in-app-updates.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"name": {
|
||||
"description": "The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs.",
|
||||
"type": "string"
|
||||
},
|
||||
"pinnedVersions": {
|
||||
"items": {
|
||||
"$ref": "TrackReleasePin"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"releaseNotes": {
|
||||
"description": "The description of what is new in the app in this release.",
|
||||
"items": {
|
||||
@@ -3498,6 +3810,12 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"rollbackEnabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sampling": {
|
||||
"$ref": "Sampling"
|
||||
},
|
||||
"status": {
|
||||
"description": "The desired status of this release.",
|
||||
"type": "string"
|
||||
@@ -3518,6 +3836,72 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TrackReleasePin": {
|
||||
"id": "TrackReleasePin",
|
||||
"properties": {
|
||||
"targetings": {
|
||||
"items": {
|
||||
"$ref": "TrackReleasePinPinTargeting"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"versionCodes": {
|
||||
"items": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TrackReleasePinPinTargeting": {
|
||||
"id": "TrackReleasePinPinTargeting",
|
||||
"properties": {
|
||||
"countryCodes": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"devices": {
|
||||
"items": {
|
||||
"$ref": "TrackReleasePinPinTargetingDevicePin"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"phoneskyVersions": {
|
||||
"items": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"sdkVersions": {
|
||||
"items": {
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TrackReleasePinPinTargetingDevicePin": {
|
||||
"id": "TrackReleasePinPinTargetingDevicePin",
|
||||
"properties": {
|
||||
"brand": {
|
||||
"type": "string"
|
||||
},
|
||||
"device": {
|
||||
"type": "string"
|
||||
},
|
||||
"product": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TracksListResponse": {
|
||||
"id": "TracksListResponse",
|
||||
"properties": {
|
||||
@@ -3594,6 +3978,20 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Variant": {
|
||||
"description": "Represents the variant of a generated system APK from an uploaded App Bundle.",
|
||||
"id": "Variant",
|
||||
"properties": {
|
||||
"deviceSpec": {
|
||||
"$ref": "DeviceSpec"
|
||||
},
|
||||
"variantId": {
|
||||
"format": "uint32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"VoidedPurchase": {
|
||||
"description": "A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.",
|
||||
"id": "VoidedPurchase",
|
||||
@@ -3603,15 +4001,29 @@
|
||||
"description": "This kind represents a voided purchase object in the androidpublisher service.",
|
||||
"type": "string"
|
||||
},
|
||||
"orderId": {
|
||||
"description": "The order id which uniquely identifies a one-time purchase, subscription purchase, or subscription renewal.",
|
||||
"type": "string"
|
||||
},
|
||||
"purchaseTimeMillis": {
|
||||
"description": "The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"purchaseToken": {
|
||||
"description": "The token that was generated when a purchase was made. This uniquely identifies a purchase.",
|
||||
"description": "The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API).",
|
||||
"type": "string"
|
||||
},
|
||||
"voidedReason": {
|
||||
"description": "The reason why the purchase was voided, possible values are: \n- Other \n- Remorse \n- Not_received \n- Defective \n- Accidental_purchase \n- Fraud \n- Friendly_fraud \n- Chargeback",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"voidedSource": {
|
||||
"description": "The initiator of voided purchase, possible values are: \n- User \n- Developer \n- Google",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"voidedTimeMillis": {
|
||||
"description": "The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).",
|
||||
"format": "int64",
|
||||
|
||||
@@ -26,6 +26,7 @@
|
||||
},
|
||||
"id": "appengine:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://appengine.mtls.googleapis.com/",
|
||||
"name": "appengine",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -1421,7 +1422,7 @@
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Stops a running instance.",
|
||||
"description": "Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see \"How Instances are Managed\" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.",
|
||||
"flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "appengine.apps.services.versions.instances.delete",
|
||||
@@ -1572,7 +1573,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190624",
|
||||
"revision": "20200403",
|
||||
"rootUrl": "https://appengine.googleapis.com/",
|
||||
"schemas": {
|
||||
"ApiConfigHandler": {
|
||||
@@ -2676,7 +2677,7 @@
|
||||
"Certificate is under active attempts to acquire or renew.",
|
||||
"Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
|
||||
"All renewal attempts have been exhausted, likely due to an invalid DNS setup.",
|
||||
"Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
|
||||
"Most recent renewal failed due to an explicit CAA record that does not include one of the in-use CAs (Google CA and Let's Encrypt). Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
|
||||
"Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
|
||||
],
|
||||
"type": "string"
|
||||
|
||||
@@ -26,6 +26,7 @@
|
||||
},
|
||||
"id": "appengine:v1alpha",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://appengine.mtls.googleapis.com/",
|
||||
"name": "appengine",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -694,7 +695,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190624",
|
||||
"revision": "20200403",
|
||||
"rootUrl": "https://appengine.googleapis.com/",
|
||||
"schemas": {
|
||||
"AuthorizedCertificate": {
|
||||
@@ -1010,7 +1011,7 @@
|
||||
"Most recent renewal failed due to a system failure and will be retried. System failure is likely transient, and subsequent renewal attempts may succeed. The last successfully provisioned certificate may still be serving.",
|
||||
"Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
|
||||
"All renewal attempts have been exhausted. Most recent renewal failed due to an invalid DNS setup and will not be retried. The last successfully provisioned certificate may still be serving.",
|
||||
"Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
|
||||
"Most recent renewal failed due to an explicit CAA record that does not include one of the in-use CAs (Google CA and Let's Encrypt). Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
|
||||
"Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
|
||||
],
|
||||
"type": "string"
|
||||
|
||||
@@ -26,6 +26,7 @@
|
||||
},
|
||||
"id": "appengine:v1beta",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://appengine.mtls.googleapis.com/",
|
||||
"name": "appengine",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -1421,7 +1422,7 @@
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Stops a running instance.",
|
||||
"description": "Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see \"How Instances are Managed\" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.",
|
||||
"flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "appengine.apps.services.versions.instances.delete",
|
||||
@@ -1572,7 +1573,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190624",
|
||||
"revision": "20200403",
|
||||
"rootUrl": "https://appengine.googleapis.com/",
|
||||
"schemas": {
|
||||
"ApiConfigHandler": {
|
||||
@@ -2337,10 +2338,6 @@
|
||||
"description": "OAuth2 client ID to use for the authentication flow.",
|
||||
"type": "string"
|
||||
},
|
||||
"oauth2ClientInfo": {
|
||||
"$ref": "OAuth2ClientInfo",
|
||||
"description": "InputOnly OAuth client info required to generate client id to be used for IAP."
|
||||
},
|
||||
"oauth2ClientSecret": {
|
||||
"description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly",
|
||||
"type": "string"
|
||||
@@ -2731,7 +2728,7 @@
|
||||
"Certificate is under active attempts to acquire or renew.",
|
||||
"Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
|
||||
"All renewal attempts have been exhausted, likely due to an invalid DNS setup.",
|
||||
"Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
|
||||
"Most recent renewal failed due to an explicit CAA record that does not include one of the in-use CAs (Google CA and Let's Encrypt). Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
|
||||
"Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
|
||||
],
|
||||
"type": "string"
|
||||
@@ -2808,24 +2805,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"OAuth2ClientInfo": {
|
||||
"id": "OAuth2ClientInfo",
|
||||
"properties": {
|
||||
"applicationName": {
|
||||
"description": "Application name to be used in OAuth consent screen.",
|
||||
"type": "string"
|
||||
},
|
||||
"clientName": {
|
||||
"description": "Nameof the client to be generated. Optional - If not provided, the name will be autogenerated by the backend.",
|
||||
"type": "string"
|
||||
},
|
||||
"developerEmailAddress": {
|
||||
"description": "Developer's information to be used in OAuth consent screen.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Operation": {
|
||||
"description": "This resource represents a long-running operation that is the result of a network API call.",
|
||||
"id": "Operation",
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
"description": "Provides a historical view of activity.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/google-apps/activity/",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/YPqFJe65d5FfTDGB1HI65s4HAx4\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/rwk4WL3MtQtqWL81CbRykDH0ZLo\"",
|
||||
"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"
|
||||
@@ -137,7 +137,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190701",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Activity": {
|
||||
@@ -334,6 +334,7 @@
|
||||
"description": "Indicates the Google Drive permissions role. The role determines a user's ability to read, write, or comment on the file.",
|
||||
"enum": [
|
||||
"commenter",
|
||||
"fileOrganizer",
|
||||
"owner",
|
||||
"publishedReader",
|
||||
"reader",
|
||||
@@ -344,6 +345,7 @@
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
"",
|
||||
""
|
||||
],
|
||||
"type": "string"
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
717
etc/api/bigqueryconnection/v1beta1/bigqueryconnection-api.json
Normal file
717
etc/api/bigqueryconnection/v1beta1/bigqueryconnection-api.json
Normal file
@@ -0,0 +1,717 @@
|
||||
{
|
||||
"auth": {
|
||||
"oauth2": {
|
||||
"scopes": {
|
||||
"https://www.googleapis.com/auth/bigquery": {
|
||||
"description": "View and manage your data in Google BigQuery"
|
||||
},
|
||||
"https://www.googleapis.com/auth/cloud-platform": {
|
||||
"description": "View and manage your data across Google Cloud Platform services"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"basePath": "",
|
||||
"baseUrl": "https://bigqueryconnection.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "BigQuery Connection Service",
|
||||
"description": "Allows users to manage BigQuery connections to external data sources.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/bigquery/",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
||||
},
|
||||
"id": "bigqueryconnection:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://bigqueryconnection.mtls.googleapis.com/",
|
||||
"name": "bigqueryconnection",
|
||||
"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 response.",
|
||||
"enum": [
|
||||
"json",
|
||||
"media",
|
||||
"proto"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"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",
|
||||
"type": "string"
|
||||
},
|
||||
"key": {
|
||||
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"oauth_token": {
|
||||
"description": "OAuth 2.0 token for the current user.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"prettyPrint": {
|
||||
"default": "true",
|
||||
"description": "Returns response with indentations and line breaks.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"quotaUser": {
|
||||
"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"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"protocol": "rest",
|
||||
"resources": {
|
||||
"projects": {
|
||||
"resources": {
|
||||
"locations": {
|
||||
"resources": {
|
||||
"connections": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates a new connection.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connections",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigqueryconnection.projects.locations.connections.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"connectionId": {
|
||||
"description": "Optional. Connection id that should be assigned to the created connection.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. Parent resource name.\nMust be in the format `projects/{project_id}/locations/{location_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/connections",
|
||||
"request": {
|
||||
"$ref": "Connection"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Connection"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes connection and associated credential.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "bigqueryconnection.projects.locations.connections.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. Name of the deleted connection, for example:\n`projects/{project_id}/locations/{location_id}/connections/{connection_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Returns specified connection.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "bigqueryconnection.projects.locations.connections.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. Name of the requested connection, for example:\n`projects/{project_id}/locations/{location_id}/connections/{connection_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Connection"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"getIamPolicy": {
|
||||
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigqueryconnection.projects.locations.connections.getIamPolicy",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+resource}:getIamPolicy",
|
||||
"request": {
|
||||
"$ref": "GetIamPolicyRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Policy"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Returns a list of connections in the given project.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connections",
|
||||
"httpMethod": "GET",
|
||||
"id": "bigqueryconnection.projects.locations.connections.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"maxResults": {
|
||||
"description": "Required. Maximum number of results per page.",
|
||||
"format": "uint32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Page token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. Parent resource name.\nMust be in the form: `projects/{project_id}/locations/{location_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/connections",
|
||||
"response": {
|
||||
"$ref": "ListConnectionsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates the specified connection. For security reasons, also resets\ncredential if connection properties are in the update field mask.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "bigqueryconnection.projects.locations.connections.patch",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. Name of the connection to update, for example:\n`projects/{project_id}/locations/{location_id}/connections/{connection_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Required. Update mask for the connection fields to be updated.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"request": {
|
||||
"$ref": "Connection"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Connection"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigqueryconnection.projects.locations.connections.setIamPolicy",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+resource}:setIamPolicy",
|
||||
"request": {
|
||||
"$ref": "SetIamPolicyRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Policy"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"testIamPermissions": {
|
||||
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigqueryconnection.projects.locations.connections.testIamPermissions",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+resource}:testIamPermissions",
|
||||
"request": {
|
||||
"$ref": "TestIamPermissionsRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "TestIamPermissionsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"updateCredential": {
|
||||
"description": "Sets the credential for the specified connection.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/credential",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "bigqueryconnection.projects.locations.connections.updateCredential",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. Name of the connection, for example:\n`projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/credential$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"request": {
|
||||
"$ref": "ConnectionCredential"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://bigqueryconnection.googleapis.com/",
|
||||
"schemas": {
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
"description": "The configuration for logging of each type of permission.",
|
||||
"items": {
|
||||
"$ref": "AuditLogConfig"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"service": {
|
||||
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"logType": {
|
||||
"description": "The log type that this config enables.",
|
||||
"enum": [
|
||||
"LOG_TYPE_UNSPECIFIED",
|
||||
"ADMIN_READ",
|
||||
"DATA_WRITE",
|
||||
"DATA_READ"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default case. Should never be this.",
|
||||
"Admin reads. Example: CloudIAM getIamPolicy",
|
||||
"Data writes. Example: CloudSQL Users create",
|
||||
"Data reads. Example: CloudSQL Users list"
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Binding": {
|
||||
"description": "Associates `members` with a `role`.",
|
||||
"id": "Binding",
|
||||
"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."
|
||||
},
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"role": {
|
||||
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CloudSqlCredential": {
|
||||
"description": "Credential info for the Cloud SQL.",
|
||||
"id": "CloudSqlCredential",
|
||||
"properties": {
|
||||
"password": {
|
||||
"description": "The password for the credential.",
|
||||
"type": "string"
|
||||
},
|
||||
"username": {
|
||||
"description": "The username for the credential.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CloudSqlProperties": {
|
||||
"description": "Connection properties specific to the Cloud SQL.",
|
||||
"id": "CloudSqlProperties",
|
||||
"properties": {
|
||||
"credential": {
|
||||
"$ref": "CloudSqlCredential",
|
||||
"description": "Input only. Cloud SQL credential."
|
||||
},
|
||||
"database": {
|
||||
"description": "Database name.",
|
||||
"type": "string"
|
||||
},
|
||||
"instanceId": {
|
||||
"description": "Cloud SQL instance ID in the form `project:location:instance`.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "Type of the Cloud SQL database.",
|
||||
"enum": [
|
||||
"DATABASE_TYPE_UNSPECIFIED",
|
||||
"POSTGRES",
|
||||
"MYSQL"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified database type.",
|
||||
"Cloud SQL for PostgreSQL.",
|
||||
"Cloud SQL for MySQL."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Connection": {
|
||||
"description": "Configuration parameters to establish connection with an external data\nsource, except the credential attributes.",
|
||||
"id": "Connection",
|
||||
"properties": {
|
||||
"cloudSql": {
|
||||
"$ref": "CloudSqlProperties",
|
||||
"description": "Cloud SQL properties."
|
||||
},
|
||||
"creationTime": {
|
||||
"description": "Output only. The creation timestamp of the connection.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"description": "User provided description.",
|
||||
"type": "string"
|
||||
},
|
||||
"friendlyName": {
|
||||
"description": "User provided display name for the connection.",
|
||||
"type": "string"
|
||||
},
|
||||
"hasCredential": {
|
||||
"description": "Output only. True, if credential is configured for this connection.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"lastModifiedTime": {
|
||||
"description": "Output only. The last update timestamp of the connection.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "The resource name of the connection in the form of:\n`projects/{project_id}/locations/{location_id}/connections/{connection_id}`",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ConnectionCredential": {
|
||||
"description": "Credential to use with a connection.",
|
||||
"id": "ConnectionCredential",
|
||||
"properties": {
|
||||
"cloudSql": {
|
||||
"$ref": "CloudSqlCredential",
|
||||
"description": "Credential for Cloud SQL database."
|
||||
}
|
||||
},
|
||||
"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"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetIamPolicyRequest": {
|
||||
"description": "Request message for `GetIamPolicy` method.",
|
||||
"id": "GetIamPolicyRequest",
|
||||
"properties": {
|
||||
"options": {
|
||||
"$ref": "GetPolicyOptions",
|
||||
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetPolicyOptions": {
|
||||
"description": "Encapsulates settings provided to GetIamPolicy.",
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListConnectionsResponse": {
|
||||
"description": "The response for ConnectionService.ListConnections.",
|
||||
"id": "ListConnectionsResponse",
|
||||
"properties": {
|
||||
"connections": {
|
||||
"description": "List of connections.",
|
||||
"items": {
|
||||
"$ref": "Connection"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "Next page token.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
"description": "Specifies cloud audit logging configuration for this policy.",
|
||||
"items": {
|
||||
"$ref": "AuditConfig"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SetIamPolicyRequest": {
|
||||
"description": "Request message for `SetIamPolicy` method.",
|
||||
"id": "SetIamPolicyRequest",
|
||||
"properties": {
|
||||
"policy": {
|
||||
"$ref": "Policy",
|
||||
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
|
||||
"format": "google-fieldmask",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TestIamPermissionsRequest": {
|
||||
"description": "Request message for `TestIamPermissions` method.",
|
||||
"id": "TestIamPermissionsRequest",
|
||||
"properties": {
|
||||
"permissions": {
|
||||
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TestIamPermissionsResponse": {
|
||||
"description": "Response message for `TestIamPermissions` method.",
|
||||
"id": "TestIamPermissionsResponse",
|
||||
"properties": {
|
||||
"permissions": {
|
||||
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "BigQuery Connection API",
|
||||
"version": "v1beta1",
|
||||
"version_module": true
|
||||
}
|
||||
@@ -5,6 +5,9 @@
|
||||
"https://www.googleapis.com/auth/bigquery": {
|
||||
"description": "View and manage your data in Google BigQuery"
|
||||
},
|
||||
"https://www.googleapis.com/auth/bigquery.readonly": {
|
||||
"description": "View your data in Google BigQuery"
|
||||
},
|
||||
"https://www.googleapis.com/auth/cloud-platform": {
|
||||
"description": "View and manage your data across Google Cloud Platform services"
|
||||
},
|
||||
@@ -28,6 +31,7 @@
|
||||
},
|
||||
"id": "bigquerydatatransfer:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://bigquerydatatransfer.mtls.googleapis.com/",
|
||||
"name": "bigquerydatatransfer",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -124,7 +128,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
||||
"description": "Required. The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}` or\n`projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/dataSources/[^/]+$",
|
||||
"required": true,
|
||||
@@ -140,6 +144,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -154,7 +159,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
||||
"description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}` or\n`projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/dataSources/[^/]+$",
|
||||
"required": true,
|
||||
@@ -167,6 +172,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -192,7 +198,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
|
||||
"description": "Required. The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}` or\n`projects/{project_id}/locations/{location_id}",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -205,6 +211,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -236,6 +243,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -279,6 +287,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -297,7 +306,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
||||
"description": "Required. The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}` or\n`projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
|
||||
"required": true,
|
||||
@@ -313,6 +322,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -327,7 +337,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
||||
"description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}` or\n`projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
|
||||
"required": true,
|
||||
@@ -340,6 +350,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -365,7 +376,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
|
||||
"description": "Required. The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}` or\n`projects/{project_id}/locations/{location_id}",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -378,6 +389,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -401,12 +413,17 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.",
|
||||
"description": "Required. The BigQuery project id where the transfer configuration should be created.\nMust be in the format projects/{project_id}/locations/{location_id} or\nprojects/{project_id}. If specified location and location of the\ndestination bigquery dataset do not match - the request will fail.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"serviceAccountName": {
|
||||
"description": "Optional service account name. If this field is set, transfer config will\nbe created with this service account credentials. It requires that\nrequesting user calling this API has permissions to act as this service\naccount.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"versionInfo": {
|
||||
"description": "Optional version info. If users want to find a very recent access token,\nthat is, immediately after approving access, users have to set the\nversion_info claim in the token request. To obtain the version_info, users\nmust use the \"none+gsession\" response type. which be return a\nversion_info back in the authorization response which be be put in a JWT\nclaim in the token request.",
|
||||
"location": "query",
|
||||
@@ -434,7 +451,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
|
||||
"description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -460,7 +477,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
|
||||
"description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -473,6 +490,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -504,7 +522,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
|
||||
"description": "Required. The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}` or\n`projects/{project_id}/locations/{location_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -517,6 +535,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -542,8 +561,13 @@
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"serviceAccountName": {
|
||||
"description": "Optional service account name. If this field is set and\n\"service_account_name\" is set in update_mask, transfer config will be\nupdated to use this service account credentials. It requires that\nrequesting user calling this API has permissions to act as this service\naccount.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Required list of fields to be updated in this request.",
|
||||
"description": "Required. Required list of fields to be updated in this request.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -575,7 +599,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
|
||||
"description": "Required. Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -604,7 +628,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
|
||||
"description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -637,7 +661,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
||||
"description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -663,7 +687,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
||||
"description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -676,6 +700,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -701,7 +726,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
|
||||
"description": "Required. Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -737,6 +762,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -778,7 +804,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
|
||||
"description": "Required. Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -791,6 +817,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -820,12 +847,17 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.",
|
||||
"description": "Required. The BigQuery project id where the transfer configuration should be created.\nMust be in the format projects/{project_id}/locations/{location_id} or\nprojects/{project_id}. If specified location and location of the\ndestination bigquery dataset do not match - the request will fail.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"serviceAccountName": {
|
||||
"description": "Optional service account name. If this field is set, transfer config will\nbe created with this service account credentials. It requires that\nrequesting user calling this API has permissions to act as this service\naccount.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"versionInfo": {
|
||||
"description": "Optional version info. If users want to find a very recent access token,\nthat is, immediately after approving access, users have to set the\nversion_info claim in the token request. To obtain the version_info, users\nmust use the \"none+gsession\" response type. which be return a\nversion_info back in the authorization response which be be put in a JWT\nclaim in the token request.",
|
||||
"location": "query",
|
||||
@@ -853,7 +885,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
|
||||
"description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -879,7 +911,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
|
||||
"description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -892,6 +924,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -923,7 +956,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
|
||||
"description": "Required. The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}` or\n`projects/{project_id}/locations/{location_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -936,6 +969,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -961,8 +995,13 @@
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"serviceAccountName": {
|
||||
"description": "Optional service account name. If this field is set and\n\"service_account_name\" is set in update_mask, transfer config will be\nupdated to use this service account credentials. It requires that\nrequesting user calling this API has permissions to act as this service\naccount.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Required list of fields to be updated in this request.",
|
||||
"description": "Required. Required list of fields to be updated in this request.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -994,7 +1033,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
|
||||
"description": "Required. Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1023,7 +1062,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
|
||||
"description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1056,7 +1095,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
||||
"description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1082,7 +1121,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
||||
"description": "Required. The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1095,6 +1134,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -1120,7 +1160,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
|
||||
"description": "Required. Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1156,6 +1196,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -1197,7 +1238,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
|
||||
"description": "Required. Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or\n`projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1210,6 +1251,7 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/bigquery.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/cloud-platform.read-only"
|
||||
]
|
||||
@@ -1223,7 +1265,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190629",
|
||||
"revision": "20200326",
|
||||
"rootUrl": "https://bigquerydatatransfer.googleapis.com/",
|
||||
"schemas": {
|
||||
"CheckValidCredsRequest": {
|
||||
@@ -1252,12 +1294,14 @@
|
||||
"enum": [
|
||||
"AUTHORIZATION_TYPE_UNSPECIFIED",
|
||||
"AUTHORIZATION_CODE",
|
||||
"GOOGLE_PLUS_AUTHORIZATION_CODE"
|
||||
"GOOGLE_PLUS_AUTHORIZATION_CODE",
|
||||
"FIRST_PARTY_OAUTH"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Type unspecified.",
|
||||
"Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
|
||||
"Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
|
||||
"Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend.",
|
||||
"Use First Party OAuth based on Loas Owned Clients. First Party OAuth\ndoesn't require a refresh token to get an offline access token. Instead,\nit uses a client-signed JWT assertion to retrieve an access token."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1458,6 +1502,17 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"EmailPreferences": {
|
||||
"description": "Represents preferences for sending email notifications for transfer run\nevents.",
|
||||
"id": "EmailPreferences",
|
||||
"properties": {
|
||||
"enableFailureEmail": {
|
||||
"description": "If true, email notifications will be sent on transfer run failures.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"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",
|
||||
@@ -1614,12 +1669,12 @@
|
||||
"id": "ScheduleTransferRunsRequest",
|
||||
"properties": {
|
||||
"endTime": {
|
||||
"description": "End time of the range of transfer runs. For example,\n`\"2017-05-30T00:00:00+00:00\"`.",
|
||||
"description": "Required. End time of the range of transfer runs. For example,\n`\"2017-05-30T00:00:00+00:00\"`.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"startTime": {
|
||||
"description": "Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`.",
|
||||
"description": "Required. Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -1743,6 +1798,10 @@
|
||||
"description": "User specified display name for the data transfer.",
|
||||
"type": "string"
|
||||
},
|
||||
"emailPreferences": {
|
||||
"$ref": "EmailPreferences",
|
||||
"description": "Email notifications will be sent according to these preferences\nto the email address of the user who owns this transfer config."
|
||||
},
|
||||
"name": {
|
||||
"description": "The resource name of the transfer config.\nTransfer config names have the form of\n`projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.\nThe name is automatically generated based on the config_id specified in\nCreateTransferConfigRequest along with project_id and region. If config_id\nis not provided, usually a uuid, even though it is not guaranteed or\nrequired, will be generated for config_id.",
|
||||
"type": "string"
|
||||
@@ -1752,6 +1811,10 @@
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"notificationPubsubTopic": {
|
||||
"description": "Pub/Sub topic where notifications will be sent after transfer runs\nassociated with this transfer config finish.",
|
||||
"type": "string"
|
||||
},
|
||||
"params": {
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object.",
|
||||
@@ -1845,6 +1908,10 @@
|
||||
"description": "Output only. The BigQuery target dataset id.",
|
||||
"type": "string"
|
||||
},
|
||||
"emailPreferences": {
|
||||
"$ref": "EmailPreferences",
|
||||
"description": "Output only. Email notifications will be sent according to these\npreferences to the email address of the user who owns the transfer config\nthis run was derived from."
|
||||
},
|
||||
"endTime": {
|
||||
"description": "Output only. Time when transfer run ended.\nParameter ignored by server for input requests.",
|
||||
"format": "google-datetime",
|
||||
@@ -1858,6 +1925,10 @@
|
||||
"description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
|
||||
"type": "string"
|
||||
},
|
||||
"notificationPubsubTopic": {
|
||||
"description": "Output only. Pub/Sub topic where a notification will be sent after this\ntransfer run finishes",
|
||||
"type": "string"
|
||||
},
|
||||
"params": {
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object.",
|
||||
|
||||
1192
etc/api/bigqueryreservation/v1/bigqueryreservation-api.json
Normal file
1192
etc/api/bigqueryreservation/v1/bigqueryreservation-api.json
Normal file
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,900 @@
|
||||
{
|
||||
"auth": {
|
||||
"oauth2": {
|
||||
"scopes": {
|
||||
"https://www.googleapis.com/auth/bigquery": {
|
||||
"description": "View and manage your data in Google BigQuery"
|
||||
},
|
||||
"https://www.googleapis.com/auth/cloud-platform": {
|
||||
"description": "View and manage your data across Google Cloud Platform services"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"basePath": "",
|
||||
"baseUrl": "https://bigqueryreservation.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "BigQuery Reservation",
|
||||
"description": "A service to modify your BigQuery flat-rate reservations.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/bigquery/",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
||||
},
|
||||
"id": "bigqueryreservation:v1alpha2",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://bigqueryreservation.mtls.googleapis.com/",
|
||||
"name": "bigqueryreservation",
|
||||
"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 response.",
|
||||
"enum": [
|
||||
"json",
|
||||
"media",
|
||||
"proto"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"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",
|
||||
"type": "string"
|
||||
},
|
||||
"key": {
|
||||
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"oauth_token": {
|
||||
"description": "OAuth 2.0 token for the current user.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"prettyPrint": {
|
||||
"default": "true",
|
||||
"description": "Returns response with indentations and line breaks.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"quotaUser": {
|
||||
"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"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"protocol": "rest",
|
||||
"resources": {
|
||||
"projects": {
|
||||
"resources": {
|
||||
"locations": {
|
||||
"methods": {
|
||||
"searchReservationGrants": {
|
||||
"description": "Look up grants for a specified resource for a particular region.\nIf the request is about a project:\n 1) Grants created on the project will be returned if they exist.\n 2) Otherwise grants created on the closest ancestor will be returned.\n 3) Grants 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 grants created on the\norganization will be returned (organization doesn't have ancestors).\nComparing to ListReservationGrants, there are two behavior\ndifferences:\n 1) permission on the grantee will be verified in this API.\n 2) Hierarchy lookup (project->folder->organization) happens in this API.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}:SearchReservationGrants",
|
||||
"httpMethod": "GET",
|
||||
"id": "bigqueryreservation.projects.locations.searchReservationGrants",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "The maximum number of items to return.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The next_page_token value returned from a previous List request, if any.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The parent resource name (containing project and location), which owns the\ngrants. e.g.:\n \"projects/myproject/locations/us-central1\".",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"query": {
|
||||
"description": "Please specify resource name as grantee in the query.\ne.g., \"grantee=projects/myproject\"\n \"grantee=folders/123\"\n \"grantee=organizations/456\"",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+parent}:SearchReservationGrants",
|
||||
"response": {
|
||||
"$ref": "SearchReservationGrantsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"operations": {
|
||||
"methods": {
|
||||
"cancel": {
|
||||
"description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigqueryreservation.projects.locations.operations.cancel",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the operation resource to be cancelled.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+name}:cancel",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "bigqueryreservation.projects.locations.operations.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+name}",
|
||||
"response": {
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"reservationGrants": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Returns `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 grant\ndoes not match location of the reservation.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservationGrants",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigqueryreservation.projects.locations.reservationGrants.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The parent resource name of the reservation grant\nE.g.: projects/myproject/location/eu.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+parent}/reservationGrants",
|
||||
"request": {
|
||||
"$ref": "ReservationGrant"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "ReservationGrant"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes a reservation grant. No expansion will happen.\nE.g:\norganizationA contains project1 and project2. Reservation res1 exists.\nCreateReservationGrant was invoked previously and following grants were\ncreated explicitly:\n <organizationA, res1>\n <project1, res1>\nThen deletion of <organizationA, res1> won't affect <project1, res1>. After\ndeletion of <organizationA, res1>, queries from project1 will still use\nres1, while queries from project2 will use on-demand mode.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservationGrants/{reservationGrantsId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "bigqueryreservation.projects.locations.reservationGrants.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Name of the resource, e.g.:\n projects/myproject/locations/eu/reservationGrants/123",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/reservationGrants/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists reservation grants.\nOnly explicitly created grants will be returned. E.g:\norganizationA contains project1 and project2. Reservation res1 exists.\nCreateReservationGrant was invoked previously and following grants were\ncreated explicitly:\n <organizationA, res1>\n <project1, res1>\nThen this API will just return the above two grants for reservation res1,\nand no expansion/merge will happen.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservationGrants",
|
||||
"httpMethod": "GET",
|
||||
"id": "bigqueryreservation.projects.locations.reservationGrants.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "The maximum number of items to return.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The next_page_token value returned from a previous List request, if any.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The parent resource name e.g.: projects/myproject/location/eu.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+parent}/reservationGrants",
|
||||
"response": {
|
||||
"$ref": "ListReservationGrantsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"reservations": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates a new reservation resource. Multiple reservations are created if\nthe ancestor reservations do not exist.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigqueryreservation.projects.locations.reservations.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Project, location, and (optionally) reservation name. E.g.,\n projects/myproject/locations/us-central1/reservations/parent",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"reservationId": {
|
||||
"description": "The reservation ID relative to the parent, e.g., \"dev\". This field must\nonly contain alphanumeric characters.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+parent}/reservations",
|
||||
"request": {
|
||||
"$ref": "Reservation"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Reservation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"createReservation": {
|
||||
"description": "Creates a new reservation resource. Multiple reservations are created if\nthe ancestor reservations do not exist.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigqueryreservation.projects.locations.reservations.createReservation",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Project, location, and (optionally) reservation name. E.g.,\n projects/myproject/locations/us-central1/reservations/parent",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"reservationId": {
|
||||
"description": "The reservation ID relative to the parent, e.g., \"dev\". This field must\nonly contain alphanumeric characters.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+parent}",
|
||||
"request": {
|
||||
"$ref": "Reservation"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Reservation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes a reservation.\nReturns `google.rpc.Code.FAILED_PRECONDITION` in the following cases:\n 1. When reservation has child reservations. This check can be bypassed by\n setting DeleteReservationRequest.force flag to true.\n 2. When top-level reservation with slot pools is being deleted.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "bigqueryreservation.projects.locations.reservations.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"force": {
|
||||
"description": "If true, deletes all the child reservations of the given reservation.\nOtherwise, attempting to delete a reservation that has child\nreservations will fail with error code\n`google.rpc.Code.FAILED_PRECONDITION`.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"name": {
|
||||
"description": "Resource name of the reservation to retrieve. E.g.,\n projects/myproject/locations/us-central1/reservations/my_reservation",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Returns information about the reservation.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "bigqueryreservation.projects.locations.reservations.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Resource name of the reservation to retrieve. E.g.,\n projects/myproject/locations/us-central1/reservations/path/to/reserv",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+name}",
|
||||
"response": {
|
||||
"$ref": "Reservation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists all the reservations for the project in the specified location.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations",
|
||||
"httpMethod": "GET",
|
||||
"id": "bigqueryreservation.projects.locations.reservations.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "Can be used to filter out reservations based on names, capacity, etc, e.g.:\nfilter=\"reservation.slot_capacity > 200\"\nfilter=\"reservation.name = \\\"*dev/*\\\"\"\nAdvanced filtering syntax can be\n[here](https://cloud.google.com/logging/docs/view/advanced-filters).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "The maximum number of items to return.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The next_page_token value returned from a previous List request, if any.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The parent resource name containing project and location, e.g.:\n \"projects/myproject/locations/us-central1\"",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+parent}/reservations",
|
||||
"response": {
|
||||
"$ref": "ListReservationsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates an existing reservation resource. Applicable only for child\nreservations.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/{reservationsId1}",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "bigqueryreservation.projects.locations.reservations.patch",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the reservation, e.g.,\n\"projects/*/locations/*/reservations/dev/team/product\". Reservation names\n(e.g., \"dev/team/product\") exceeding a depth of six will fail with\n`google.rpc.Code.INVALID_ARGUMENT`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Standard field mask for the set of fields to be updated.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+name}",
|
||||
"request": {
|
||||
"$ref": "Reservation"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Reservation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"slotPools": {
|
||||
"methods": {
|
||||
"delete": {
|
||||
"description": "Deletes a slot pool. Attempting to delete slot pool before its\ncommitment_end_time will fail with the error code\n`google.rpc.Code.FAILED_PRECONDITION`.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/slotPools/{slotPoolsId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "bigqueryreservation.projects.locations.reservations.slotPools.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Resource name of the slot pool to delete. E.g.,\n projects/myproject/locations/us-central1/reservations/my_reservation/slotPools/123",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/slotPools/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Returns information about the slot pool.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/slotPools/{slotPoolsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "bigqueryreservation.projects.locations.reservations.slotPools.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Resource name of the slot pool to retrieve. E.g.,\n projects/myproject/locations/us-central1/reservations/my_reservation/slotPools/123",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/slotPools/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+name}",
|
||||
"response": {
|
||||
"$ref": "SlotPool"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists all the slot pools for the reservation.",
|
||||
"flatPath": "v1alpha2/projects/{projectsId}/locations/{locationsId}/reservations/{reservationsId}/slotPools",
|
||||
"httpMethod": "GET",
|
||||
"id": "bigqueryreservation.projects.locations.reservations.slotPools.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "The maximum number of items to return.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The next_page_token value returned from a previous List request, if any.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Resource name of the parent reservation. Only top-level reservations can\nhave slot pools. E.g.,\n projects/myproject/locations/us-central1/reservations/my_reservation",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1alpha2/{+parent}/slotPools",
|
||||
"response": {
|
||||
"$ref": "ListSlotPoolsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigquery",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20200403",
|
||||
"rootUrl": "https://bigqueryreservation.googleapis.com/",
|
||||
"schemas": {
|
||||
"CreateSlotPoolMetadata": {
|
||||
"description": "The metadata for operation returned from\nReservationService.CreateSlotPool.",
|
||||
"id": "CreateSlotPoolMetadata",
|
||||
"properties": {
|
||||
"slotPool": {
|
||||
"description": "Resource name of the slot pool that is being created. E.g.,\nprojects/myproject/locations/us-central1/reservations/foo/slotPools/123",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"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"
|
||||
},
|
||||
"ListReservationGrantsResponse": {
|
||||
"description": "The response for ReservationService.ListReservationGrants.",
|
||||
"id": "ListReservationGrantsResponse",
|
||||
"properties": {
|
||||
"nextPageToken": {
|
||||
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
|
||||
"type": "string"
|
||||
},
|
||||
"reservationGrants": {
|
||||
"description": "List of reservation grants visible to the user.",
|
||||
"items": {
|
||||
"$ref": "ReservationGrant"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListReservationsResponse": {
|
||||
"description": "The response for ReservationService.ListReservations.",
|
||||
"id": "ListReservationsResponse",
|
||||
"properties": {
|
||||
"nextPageToken": {
|
||||
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
|
||||
"type": "string"
|
||||
},
|
||||
"reservations": {
|
||||
"description": "List of reservations visible to the user.",
|
||||
"items": {
|
||||
"$ref": "Reservation"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListSlotPoolsResponse": {
|
||||
"description": "The response for ReservationService.ListSlotPools.",
|
||||
"id": "ListSlotPoolsResponse",
|
||||
"properties": {
|
||||
"nextPageToken": {
|
||||
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
|
||||
"type": "string"
|
||||
},
|
||||
"slotPools": {
|
||||
"description": "List of slot pools visible to the user.",
|
||||
"items": {
|
||||
"$ref": "SlotPool"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Operation": {
|
||||
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
|
||||
"id": "Operation",
|
||||
"properties": {
|
||||
"done": {
|
||||
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"error": {
|
||||
"$ref": "Status",
|
||||
"description": "The error result of the operation in case of failure or cancellation."
|
||||
},
|
||||
"metadata": {
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object. Contains field @type with type URL.",
|
||||
"type": "any"
|
||||
},
|
||||
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
|
||||
"type": "object"
|
||||
},
|
||||
"name": {
|
||||
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.",
|
||||
"type": "string"
|
||||
},
|
||||
"response": {
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object. Contains field @type with type URL.",
|
||||
"type": "any"
|
||||
},
|
||||
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Reservation": {
|
||||
"description": "A reservation is a mechanism used to guarantee slots to users.",
|
||||
"id": "Reservation",
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "The resource name of the reservation, e.g.,\n\"projects/*/locations/*/reservations/dev/team/product\". Reservation names\n(e.g., \"dev/team/product\") exceeding a depth of six will fail with\n`google.rpc.Code.INVALID_ARGUMENT`.",
|
||||
"type": "string"
|
||||
},
|
||||
"slotCapacity": {
|
||||
"description": "Maximum slots available to this reservation and its children. A slot is a\nunit of computational power in BigQuery, and serves as the unit of\nparallelism. In a scan of a multi-partitioned table, a single slot operates\non a single partition of the table.\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"
|
||||
},
|
||||
"useParentReservation": {
|
||||
"description": "If true, any query using this reservation will also be submitted to the\nparent reservation. This allows the query to share the additional slot\ncapacity of the parent with other queries in the parent reservation. If the\nparent also has this field set to true, then this process will continue\nuntil it encounters a reservation for which this is false.\nIf false, a query using this reservation will\nexecute with the maximum slot capacity as specified above.\nIf not specified, default value is true.\nIgnored for top-level reservation.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReservationGrant": {
|
||||
"description": "A ReservationGrant allows a project to submit jobs\nof a certain type using slots from the specified reservation.",
|
||||
"id": "ReservationGrant",
|
||||
"properties": {
|
||||
"grantee": {
|
||||
"description": "The resource which will use the reservation. E.g.\nprojects/myproject, folders/123, organizations/456.",
|
||||
"type": "string"
|
||||
},
|
||||
"jobType": {
|
||||
"description": "Which type of jobs will use the reservation.",
|
||||
"enum": [
|
||||
"JOB_TYPE_UNSPECIFIED",
|
||||
"PIPELINE",
|
||||
"QUERY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Invalid type. Requests with this value will be rejected with\nerror code `google.rpc.Code.INVALID_ARGUMENT`.",
|
||||
"Pipeline (load/export) jobs from the project will use the reservation.",
|
||||
"Query jobs from the project will use the reservation."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output only. Name of the resource. E.g.:\nprojects/myproject/locations/eu/reservationGrants/123.",
|
||||
"type": "string"
|
||||
},
|
||||
"reservation": {
|
||||
"description": "Resource name of the reservation.\nE.g., projects/myproject/locations/eu/reservations/my_reservation.\nThis reservation must be in the same location as the grant.\nThis reservation should belong to the same parent project.",
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
"description": "Output only. State of the ReservationGrant.",
|
||||
"enum": [
|
||||
"STATE_UNSPECIFIED",
|
||||
"PENDING",
|
||||
"ACTIVE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Invalid state value.",
|
||||
"Queries from grantee will be executed as on-demand, if related\nReservationGrant is pending.",
|
||||
"ReservationGrant is ready."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SearchReservationGrantsResponse": {
|
||||
"description": "The response for ReservationService.SearchReservationGrants.",
|
||||
"id": "SearchReservationGrantsResponse",
|
||||
"properties": {
|
||||
"nextPageToken": {
|
||||
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
|
||||
"type": "string"
|
||||
},
|
||||
"reservationGrants": {
|
||||
"description": "List of reservation grants visible to the user.",
|
||||
"items": {
|
||||
"$ref": "ReservationGrant"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SlotPool": {
|
||||
"description": "Slot pool is a way to purchase slots with some minimum committed period of\nusage. Slot pool is immutable and cannot be deleted until the end of the\ncommitment period. After the end of the commitment period, slots are still\navailable but can be freely removed any time. Annual commitments will\nautomatically be downgraded to monthly after the commitment ends.\n\nA slot pool resource exists as a child resource of a top-level reservation.\nSum of all the ACTIVE pools slot_count is always equal to the reservation\nslot_capacity.",
|
||||
"id": "SlotPool",
|
||||
"properties": {
|
||||
"commitmentEndTime": {
|
||||
"description": "Output only. The end of the commitment period. Slot pool cannot be\nremoved before commitment_end_time. It is applicable only for ACTIVE slot\npools and is computed as a combination of the plan and the time when the\nslot pool became ACTIVE.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"failureStatus": {
|
||||
"$ref": "Status",
|
||||
"description": "Output only. For FAILED slot pool, provides the reason of failure."
|
||||
},
|
||||
"name": {
|
||||
"description": "Output only. The resource name of the slot pool, e.g.,\n projects/myproject/locations/us-central1/reservations/myreservation/slotPools/123",
|
||||
"type": "string"
|
||||
},
|
||||
"plan": {
|
||||
"description": "Slot pool commitment plan.",
|
||||
"enum": [
|
||||
"COMMITMENT_PLAN_UNSPECIFIED",
|
||||
"FLEX",
|
||||
"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.",
|
||||
"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."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"slotCount": {
|
||||
"description": "Number of slots in this pool.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
"description": "Output only.",
|
||||
"enum": [
|
||||
"STATE_UNSPECIFIED",
|
||||
"PENDING",
|
||||
"ACTIVE",
|
||||
"FAILED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Invalid state value.",
|
||||
"Slot pool is pending provisioning. Pending slot pool does not\ncontribute to the parent's slot_capacity.",
|
||||
"Once slots are provisioned, slot pool becomes active. slot_count is\nadded to the parent's slot_capacity.",
|
||||
"Slot pool is failed to be activated by the backend."
|
||||
],
|
||||
"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",
|
||||
"properties": {
|
||||
"code": {
|
||||
"description": "The status code, which should be an enum value of google.rpc.Code.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"details": {
|
||||
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
|
||||
"items": {
|
||||
"additionalProperties": {
|
||||
"description": "Properties of the object. Contains field @type with type URL.",
|
||||
"type": "any"
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"message": {
|
||||
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "BigQuery Reservation API",
|
||||
"version": "v1alpha2",
|
||||
"version_module": true
|
||||
}
|
||||
1093
etc/api/bigqueryreservation/v1beta1/bigqueryreservation-api.json
Normal file
1093
etc/api/bigqueryreservation/v1beta1/bigqueryreservation-api.json
Normal file
File diff suppressed because it is too large
Load Diff
@@ -13,6 +13,7 @@
|
||||
},
|
||||
"id": "bigtableadmin:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://bigtableadmin.mtls.googleapis.com/",
|
||||
"name": "bigtableadmin",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -95,7 +96,7 @@
|
||||
},
|
||||
"protocol": "rest",
|
||||
"resources": {},
|
||||
"revision": "20190506",
|
||||
"revision": "20200211",
|
||||
"rootUrl": "https://bigtableadmin.googleapis.com/",
|
||||
"schemas": {
|
||||
"Cluster": {
|
||||
@@ -117,15 +118,15 @@
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "(`CreationOnly`)\nThe location where this cluster's nodes and storage reside. For best\nperformance, clients should be located as close as possible to this\ncluster. Currently only zones are supported, so values should be of the\nform `projects/<project>/locations/<zone>`.",
|
||||
"description": "(`CreationOnly`)\nThe location where this cluster's nodes and storage reside. For best\nperformance, clients should be located as close as possible to this\ncluster. Currently only zones are supported, so values should be of the\nform `projects/{project}/locations/{zone}`.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "(`OutputOnly`)\nThe unique name of the cluster. Values are of the form\n`projects/<project>/instances/<instance>/clusters/a-z*`.",
|
||||
"description": "Required. (`OutputOnly`)\nThe unique name of the cluster. Values are of the form\n`projects/{project}/instances/{instance}/clusters/a-z*`.",
|
||||
"type": "string"
|
||||
},
|
||||
"serveNodes": {
|
||||
"description": "The number of nodes allocated to this cluster. More nodes enable higher\nthroughput and more consistent performance.",
|
||||
"description": "Required. The number of nodes allocated to this cluster. More nodes enable higher\nthroughput and more consistent performance.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
@@ -184,14 +185,14 @@
|
||||
"properties": {
|
||||
"cluster": {
|
||||
"$ref": "Cluster",
|
||||
"description": "The cluster to be created.\nFields marked `OutputOnly` must be left blank."
|
||||
"description": "Required. The cluster to be created.\nFields marked `OutputOnly` must be left blank."
|
||||
},
|
||||
"clusterId": {
|
||||
"description": "The ID to be used when referring to the new cluster within its instance,\ne.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.",
|
||||
"description": "Required. The ID to be used when referring to the new cluster within its instance,\ne.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The unique name of the instance in which to create the new cluster.\nValues are of the form\n`projects/<project>/instances/<instance>`.",
|
||||
"description": "Required. The unique name of the instance in which to create the new cluster.\nValues are of the form\n`projects/{project}/instances/{instance}`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -226,19 +227,19 @@
|
||||
"additionalProperties": {
|
||||
"$ref": "Cluster"
|
||||
},
|
||||
"description": "The clusters to be created within the instance, mapped by desired\ncluster ID, e.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.\nFields marked `OutputOnly` must be left blank.\nCurrently, at most two clusters can be specified.",
|
||||
"description": "Required. The clusters to be created within the instance, mapped by desired\ncluster ID, e.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.\nFields marked `OutputOnly` must be left blank.\nCurrently, at most four clusters can be specified.",
|
||||
"type": "object"
|
||||
},
|
||||
"instance": {
|
||||
"$ref": "Instance",
|
||||
"description": "The instance to create.\nFields marked `OutputOnly` must be left blank."
|
||||
"description": "Required. The instance to create.\nFields marked `OutputOnly` must be left blank."
|
||||
},
|
||||
"instanceId": {
|
||||
"description": "The ID to be used when referring to the new instance within its project,\ne.g., just `myinstance` rather than\n`projects/myproject/instances/myinstance`.",
|
||||
"description": "Required. The ID to be used when referring to the new instance within its project,\ne.g., just `myinstance` rather than\n`projects/myproject/instances/myinstance`.",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The unique name of the project in which to create the new instance.\nValues are of the form `projects/<project>`.",
|
||||
"description": "Required. The unique name of the project in which to create the new instance.\nValues are of the form `projects/{project}`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -249,18 +250,18 @@
|
||||
"id": "Instance",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The descriptive name for this instance as it appears in UIs.\nCan be changed at any time, but should be kept globally unique\nto avoid confusion.",
|
||||
"description": "Required. The descriptive name for this instance as it appears in UIs.\nCan be changed at any time, but should be kept globally unique\nto avoid confusion.",
|
||||
"type": "string"
|
||||
},
|
||||
"labels": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. They can be used to filter resources and aggregate\nmetrics.\n\n* Label keys must be between 1 and 63 characters long and must conform to\n the regular expression: `\\p{Ll}\\p{Lo}{0,62}`.\n* Label values must be between 0 and 63 characters long and must conform to\n the regular expression: `[\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}`.\n* No more than 64 labels can be associated with a given resource.\n* Keys and values must both be under 128 bytes.",
|
||||
"description": "Required. Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. They can be used to filter resources and aggregate\nmetrics.\n\n* Label keys must be between 1 and 63 characters long and must conform to\n the regular expression: `\\p{Ll}\\p{Lo}{0,62}`.\n* Label values must be between 0 and 63 characters long and must conform to\n the regular expression: `[\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}`.\n* No more than 64 labels can be associated with a given resource.\n* Keys and values must both be under 128 bytes.",
|
||||
"type": "object"
|
||||
},
|
||||
"name": {
|
||||
"description": "(`OutputOnly`)\nThe unique name of the instance. Values are of the form\n`projects/<project>/instances/a-z+[a-z0-9]`.",
|
||||
"description": "Required. (`OutputOnly`)\nThe unique name of the instance. Values are of the form\n`projects/{project}/instances/a-z+[a-z0-9]`.",
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
@@ -278,7 +279,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The type of the instance. Defaults to `PRODUCTION`.",
|
||||
"description": "Required. The type of the instance. Defaults to `PRODUCTION`.",
|
||||
"enum": [
|
||||
"TYPE_UNSPECIFIED",
|
||||
"PRODUCTION",
|
||||
@@ -300,10 +301,10 @@
|
||||
"properties": {
|
||||
"instance": {
|
||||
"$ref": "Instance",
|
||||
"description": "The Instance which will (partially) replace the current value."
|
||||
"description": "Required. The Instance which will (partially) replace the current value."
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "The subset of Instance fields which should be replaced.\nMust be explicitly set.",
|
||||
"description": "Required. The subset of Instance fields which should be replaced.\nMust be explicitly set.",
|
||||
"format": "google-fieldmask",
|
||||
"type": "string"
|
||||
}
|
||||
|
||||
@@ -46,6 +46,7 @@
|
||||
},
|
||||
"id": "bigtableadmin:v2",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://bigtableadmin.mtls.googleapis.com/",
|
||||
"name": "bigtableadmin",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -294,7 +295,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The unique name of the project in which to create the new instance.\nValues are of the form `projects/<project>`.",
|
||||
"description": "Required. The unique name of the project in which to create the new instance.\nValues are of the form `projects/{project}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -327,7 +328,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the instance to be deleted.\nValues are of the form `projects/<project>/instances/<instance>`.",
|
||||
"description": "Required. The unique name of the instance to be deleted.\nValues are of the form `projects/{project}/instances/{instance}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+$",
|
||||
"required": true,
|
||||
@@ -357,7 +358,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the requested instance. Values are of the form\n`projects/<project>/instances/<instance>`.",
|
||||
"description": "Required. The unique name of the requested instance. Values are of the form\n`projects/{project}/instances/{instance}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+$",
|
||||
"required": true,
|
||||
@@ -426,7 +427,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The unique name of the project for which a list of instances is requested.\nValues are of the form `projects/<project>`.",
|
||||
"description": "Required. The unique name of the project for which a list of instances is requested.\nValues are of the form `projects/{project}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -457,14 +458,14 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "(`OutputOnly`)\nThe unique name of the instance. Values are of the form\n`projects/<project>/instances/a-z+[a-z0-9]`.",
|
||||
"description": "Required. (`OutputOnly`)\nThe unique name of the instance. Values are of the form\n`projects/{project}/instances/a-z+[a-z0-9]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "The subset of Instance fields which should be replaced.\nMust be explicitly set.",
|
||||
"description": "Required. The subset of Instance fields which should be replaced.\nMust be explicitly set.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -562,7 +563,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "(`OutputOnly`)\nThe unique name of the instance. Values are of the form\n`projects/<project>/instances/a-z+[a-z0-9]`.",
|
||||
"description": "Required. (`OutputOnly`)\nThe unique name of the instance. Values are of the form\n`projects/{project}/instances/a-z+[a-z0-9]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+$",
|
||||
"required": true,
|
||||
@@ -599,7 +600,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"appProfileId": {
|
||||
"description": "The ID to be used when referring to the new app profile within its\ninstance, e.g., just `myprofile` rather than\n`projects/myproject/instances/myinstance/appProfiles/myprofile`.",
|
||||
"description": "Required. The ID to be used when referring to the new app profile within its\ninstance, e.g., just `myprofile` rather than\n`projects/myproject/instances/myinstance/appProfiles/myprofile`.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -609,7 +610,7 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The unique name of the instance in which to create the new app profile.\nValues are of the form\n`projects/<project>/instances/<instance>`.",
|
||||
"description": "Required. The unique name of the instance in which to create the new app profile.\nValues are of the form\n`projects/{project}/instances/{instance}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+$",
|
||||
"required": true,
|
||||
@@ -642,12 +643,12 @@
|
||||
],
|
||||
"parameters": {
|
||||
"ignoreWarnings": {
|
||||
"description": "If true, ignore safety checks when deleting the app profile.",
|
||||
"description": "Required. If true, ignore safety checks when deleting the app profile.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"name": {
|
||||
"description": "The unique name of the app profile to be deleted. Values are of the form\n`projects/<project>/instances/<instance>/appProfiles/<app_profile>`.",
|
||||
"description": "Required. The unique name of the app profile to be deleted. Values are of the form\n`projects/{project}/instances/{instance}/appProfiles/{app_profile}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/appProfiles/[^/]+$",
|
||||
"required": true,
|
||||
@@ -677,7 +678,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the requested app profile. Values are of the form\n`projects/<project>/instances/<instance>/appProfiles/<app_profile>`.",
|
||||
"description": "Required. The unique name of the requested app profile. Values are of the form\n`projects/{project}/instances/{instance}/appProfiles/{app_profile}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/appProfiles/[^/]+$",
|
||||
"required": true,
|
||||
@@ -708,7 +709,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "Maximum number of results per page.\nCURRENTLY UNIMPLEMENTED AND IGNORED.",
|
||||
"description": "Maximum number of results per page.\n\nA page_size of zero lets the server choose the number of items to return.\nA page_size which is strictly positive will return at most that many items.\nA negative page_size will cause an error.\n\nFollowing the first request, subsequent paginated calls are not required\nto pass a page_size. If a page_size is set in subsequent calls, it must\nmatch the page_size given in the first request.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
@@ -719,7 +720,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The unique name of the instance for which a list of app profiles is\nrequested. Values are of the form\n`projects/<project>/instances/<instance>`.\nUse `<instance> = '-'` to list AppProfiles for all Instances in a project,\ne.g., `projects/myproject/instances/-`.",
|
||||
"description": "Required. The unique name of the instance for which a list of app profiles is\nrequested. Values are of the form\n`projects/{project}/instances/{instance}`.\nUse `{instance} = '-'` to list AppProfiles for all Instances in a project,\ne.g., `projects/myproject/instances/-`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+$",
|
||||
"required": true,
|
||||
@@ -761,7 +762,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "The subset of app profile fields which should be replaced.\nIf unset, all fields will be replaced.",
|
||||
"description": "Required. The subset of app profile fields which should be replaced.\nIf unset, all fields will be replaced.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -797,12 +798,12 @@
|
||||
],
|
||||
"parameters": {
|
||||
"clusterId": {
|
||||
"description": "The ID to be used when referring to the new cluster within its instance,\ne.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.",
|
||||
"description": "Required. The ID to be used when referring to the new cluster within its instance,\ne.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The unique name of the instance in which to create the new cluster.\nValues are of the form\n`projects/<project>/instances/<instance>`.",
|
||||
"description": "Required. The unique name of the instance in which to create the new cluster.\nValues are of the form\n`projects/{project}/instances/{instance}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+$",
|
||||
"required": true,
|
||||
@@ -835,7 +836,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the cluster to be deleted. Values are of the form\n`projects/<project>/instances/<instance>/clusters/<cluster>`.",
|
||||
"description": "Required. The unique name of the cluster to be deleted. Values are of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+$",
|
||||
"required": true,
|
||||
@@ -865,7 +866,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the requested cluster. Values are of the form\n`projects/<project>/instances/<instance>/clusters/<cluster>`.",
|
||||
"description": "Required. The unique name of the requested cluster. Values are of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+$",
|
||||
"required": true,
|
||||
@@ -901,7 +902,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The unique name of the instance for which a list of clusters is requested.\nValues are of the form `projects/<project>/instances/<instance>`.\nUse `<instance> = '-'` to list Clusters for all Instances in a project,\ne.g., `projects/myproject/instances/-`.",
|
||||
"description": "Required. The unique name of the instance for which a list of clusters is requested.\nValues are of the form `projects/{project}/instances/{instance}`.\nUse `{instance} = '-'` to list Clusters for all Instances in a project,\ne.g., `projects/myproject/instances/-`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+$",
|
||||
"required": true,
|
||||
@@ -932,7 +933,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "(`OutputOnly`)\nThe unique name of the cluster. Values are of the form\n`projects/<project>/instances/<instance>/clusters/a-z*`.",
|
||||
"description": "Required. (`OutputOnly`)\nThe unique name of the cluster. Values are of the form\n`projects/{project}/instances/{instance}/clusters/a-z*`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+$",
|
||||
"required": true,
|
||||
@@ -955,6 +956,108 @@
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"backups": {
|
||||
"methods": {
|
||||
"getIamPolicy": {
|
||||
"description": "Gets the access control policy for a Table or Backup resource.\nReturns an empty policy if the resource exists but does not have a policy\nset.",
|
||||
"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups/{backupsId}:getIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigtableadmin.projects.instances.clusters.backups.getIamPolicy",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+/backups/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v2/{+resource}:getIamPolicy",
|
||||
"request": {
|
||||
"$ref": "GetIamPolicyRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Policy"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigtable.admin",
|
||||
"https://www.googleapis.com/auth/bigtable.admin.table",
|
||||
"https://www.googleapis.com/auth/cloud-bigtable.admin",
|
||||
"https://www.googleapis.com/auth/cloud-bigtable.admin.table",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on a Table or Backup resource.\nReplaces any existing policy.",
|
||||
"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups/{backupsId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigtableadmin.projects.instances.clusters.backups.setIamPolicy",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+/backups/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v2/{+resource}:setIamPolicy",
|
||||
"request": {
|
||||
"$ref": "SetIamPolicyRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Policy"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigtable.admin",
|
||||
"https://www.googleapis.com/auth/bigtable.admin.table",
|
||||
"https://www.googleapis.com/auth/cloud-bigtable.admin",
|
||||
"https://www.googleapis.com/auth/cloud-bigtable.admin.table",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"testIamPermissions": {
|
||||
"description": "Returns permissions that the caller has on the specified table resource.",
|
||||
"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/clusters/{clustersId}/backups/{backupsId}:testIamPermissions",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigtableadmin.projects.instances.clusters.backups.testIamPermissions",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+/backups/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v2/{+resource}:testIamPermissions",
|
||||
"request": {
|
||||
"$ref": "TestIamPermissionsRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "TestIamPermissionsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/bigtable.admin",
|
||||
"https://www.googleapis.com/auth/bigtable.admin.table",
|
||||
"https://www.googleapis.com/auth/cloud-bigtable.admin",
|
||||
"https://www.googleapis.com/auth/cloud-bigtable.admin.table",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"tables": {
|
||||
@@ -969,7 +1072,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the Table for which to check replication consistency.\nValues are of the form\n`projects/<project>/instances/<instance>/tables/<table>`.",
|
||||
"description": "Required. The unique name of the Table for which to check replication consistency.\nValues are of the form\n`projects/{project}/instances/{instance}/tables/{table}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1001,7 +1104,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The unique name of the instance in which to create the table.\nValues are of the form `projects/<project>/instances/<instance>`.",
|
||||
"description": "Required. The unique name of the instance in which to create the table.\nValues are of the form `projects/{project}/instances/{instance}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1033,7 +1136,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the table to be deleted.\nValues are of the form\n`projects/<project>/instances/<instance>/tables/<table>`.",
|
||||
"description": "Required. The unique name of the table to be deleted.\nValues are of the form\n`projects/{project}/instances/{instance}/tables/{table}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1062,7 +1165,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the table on which to drop a range of rows.\nValues are of the form\n`projects/<project>/instances/<instance>/tables/<table>`.",
|
||||
"description": "Required. The unique name of the table on which to drop a range of rows.\nValues are of the form\n`projects/{project}/instances/{instance}/tables/{table}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1094,7 +1197,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the Table for which to create a consistency token.\nValues are of the form\n`projects/<project>/instances/<instance>/tables/<table>`.",
|
||||
"description": "Required. The unique name of the Table for which to create a consistency token.\nValues are of the form\n`projects/{project}/instances/{instance}/tables/{table}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1126,7 +1229,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the requested table.\nValues are of the form\n`projects/<project>/instances/<instance>/tables/<table>`.",
|
||||
"description": "Required. The unique name of the requested table.\nValues are of the form\n`projects/{project}/instances/{instance}/tables/{table}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1159,7 +1262,7 @@
|
||||
]
|
||||
},
|
||||
"getIamPolicy": {
|
||||
"description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an table exists but does not have a policy set.",
|
||||
"description": "Gets the access control policy for a Table or Backup resource.\nReturns an empty policy if the resource exists but does not have a policy\nset.",
|
||||
"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:getIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigtableadmin.projects.instances.tables.getIamPolicy",
|
||||
@@ -1211,14 +1314,14 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The unique name of the instance for which tables should be listed.\nValues are of the form `projects/<project>/instances/<instance>`.",
|
||||
"description": "Required. The unique name of the instance for which tables should be listed.\nValues are of the form `projects/{project}/instances/{instance}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"view": {
|
||||
"description": "The view to be applied to the returned tables' fields.\nDefaults to `NAME_ONLY` if unspecified; no others are currently supported.",
|
||||
"description": "The view to be applied to the returned tables' fields.\nOnly NAME_ONLY view (default) and REPLICATION_VIEW are supported.",
|
||||
"enum": [
|
||||
"VIEW_UNSPECIFIED",
|
||||
"NAME_ONLY",
|
||||
@@ -1253,7 +1356,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The unique name of the table whose families should be modified.\nValues are of the form\n`projects/<project>/instances/<instance>/tables/<table>`.",
|
||||
"description": "Required. The unique name of the table whose families should be modified.\nValues are of the form\n`projects/{project}/instances/{instance}/tables/{table}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/instances/[^/]+/tables/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1276,7 +1379,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on a table resource. Replaces any existing\npolicy.",
|
||||
"description": "Sets the access control policy on a Table or Backup resource.\nReplaces any existing policy.",
|
||||
"flatPath": "v2/projects/{projectsId}/instances/{instancesId}/tables/{tablesId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "bigtableadmin.projects.instances.tables.setIamPolicy",
|
||||
@@ -1428,7 +1531,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190506",
|
||||
"revision": "20200211",
|
||||
"rootUrl": "https://bigtableadmin.googleapis.com/",
|
||||
"schemas": {
|
||||
"AppProfile": {
|
||||
@@ -1445,7 +1548,7 @@
|
||||
},
|
||||
"multiClusterRoutingUseAny": {
|
||||
"$ref": "MultiClusterRoutingUseAny",
|
||||
"description": "Use a multi-cluster routing policy that may pick any cluster."
|
||||
"description": "Use a multi-cluster routing policy."
|
||||
},
|
||||
"name": {
|
||||
"description": "(`OutputOnly`)\nThe unique name of the app profile. Values are of the form\n`projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.",
|
||||
@@ -1459,7 +1562,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -1477,7 +1580,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -1515,7 +1618,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1533,7 +1636,7 @@
|
||||
"id": "CheckConsistencyRequest",
|
||||
"properties": {
|
||||
"consistencyToken": {
|
||||
"description": "The token created using GenerateConsistencyToken for the Table.",
|
||||
"description": "Required. The token created using GenerateConsistencyToken for the Table.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1569,15 +1672,15 @@
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "(`CreationOnly`)\nThe location where this cluster's nodes and storage reside. For best\nperformance, clients should be located as close as possible to this\ncluster. Currently only zones are supported, so values should be of the\nform `projects/<project>/locations/<zone>`.",
|
||||
"description": "(`CreationOnly`)\nThe location where this cluster's nodes and storage reside. For best\nperformance, clients should be located as close as possible to this\ncluster. Currently only zones are supported, so values should be of the\nform `projects/{project}/locations/{zone}`.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "(`OutputOnly`)\nThe unique name of the cluster. Values are of the form\n`projects/<project>/instances/<instance>/clusters/a-z*`.",
|
||||
"description": "Required. (`OutputOnly`)\nThe unique name of the cluster. Values are of the form\n`projects/{project}/instances/{instance}/clusters/a-z*`.",
|
||||
"type": "string"
|
||||
},
|
||||
"serveNodes": {
|
||||
"description": "The number of nodes allocated to this cluster. More nodes enable higher\nthroughput and more consistent performance.",
|
||||
"description": "Required. The number of nodes allocated to this cluster. More nodes enable higher\nthroughput and more consistent performance.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
@@ -1607,7 +1710,7 @@
|
||||
"id": "ClusterState",
|
||||
"properties": {
|
||||
"replicationState": {
|
||||
"description": "Output only.\nThe state of replication for the table in this cluster.",
|
||||
"description": "Output only. The state of replication for the table in this cluster.",
|
||||
"enum": [
|
||||
"STATE_NOT_KNOWN",
|
||||
"INITIALIZING",
|
||||
@@ -1672,14 +1775,14 @@
|
||||
"properties": {
|
||||
"cluster": {
|
||||
"$ref": "Cluster",
|
||||
"description": "The cluster to be created.\nFields marked `OutputOnly` must be left blank."
|
||||
"description": "Required. The cluster to be created.\nFields marked `OutputOnly` must be left blank."
|
||||
},
|
||||
"clusterId": {
|
||||
"description": "The ID to be used when referring to the new cluster within its instance,\ne.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.",
|
||||
"description": "Required. The ID to be used when referring to the new cluster within its instance,\ne.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The unique name of the instance in which to create the new cluster.\nValues are of the form\n`projects/<project>/instances/<instance>`.",
|
||||
"description": "Required. The unique name of the instance in which to create the new cluster.\nValues are of the form\n`projects/{project}/instances/{instance}`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1714,19 +1817,19 @@
|
||||
"additionalProperties": {
|
||||
"$ref": "Cluster"
|
||||
},
|
||||
"description": "The clusters to be created within the instance, mapped by desired\ncluster ID, e.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.\nFields marked `OutputOnly` must be left blank.\nCurrently, at most two clusters can be specified.",
|
||||
"description": "Required. The clusters to be created within the instance, mapped by desired\ncluster ID, e.g., just `mycluster` rather than\n`projects/myproject/instances/myinstance/clusters/mycluster`.\nFields marked `OutputOnly` must be left blank.\nCurrently, at most four clusters can be specified.",
|
||||
"type": "object"
|
||||
},
|
||||
"instance": {
|
||||
"$ref": "Instance",
|
||||
"description": "The instance to create.\nFields marked `OutputOnly` must be left blank."
|
||||
"description": "Required. The instance to create.\nFields marked `OutputOnly` must be left blank."
|
||||
},
|
||||
"instanceId": {
|
||||
"description": "The ID to be used when referring to the new instance within its project,\ne.g., just `myinstance` rather than\n`projects/myproject/instances/myinstance`.",
|
||||
"description": "Required. The ID to be used when referring to the new instance within its project,\ne.g., just `myinstance` rather than\n`projects/myproject/instances/myinstance`.",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The unique name of the project in which to create the new instance.\nValues are of the form `projects/<project>`.",
|
||||
"description": "Required. The unique name of the project in which to create the new instance.\nValues are of the form `projects/{project}`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1745,10 +1848,10 @@
|
||||
},
|
||||
"table": {
|
||||
"$ref": "Table",
|
||||
"description": "The Table to create."
|
||||
"description": "Required. The Table to create."
|
||||
},
|
||||
"tableId": {
|
||||
"description": "The name by which the new table should be referred to within the parent\ninstance, e.g., `foobar` rather than `<parent>/tables/foobar`.",
|
||||
"description": "Required. The name by which the new table should be referred to within the parent\ninstance, e.g., `foobar` rather than `{parent}/tables/foobar`.\nMaximum 50 characters.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1777,23 +1880,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1844,7 +1947,24 @@
|
||||
"GetIamPolicyRequest": {
|
||||
"description": "Request message for `GetIamPolicy` method.",
|
||||
"id": "GetIamPolicyRequest",
|
||||
"properties": {},
|
||||
"properties": {
|
||||
"options": {
|
||||
"$ref": "GetPolicyOptions",
|
||||
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetPolicyOptions": {
|
||||
"description": "Encapsulates settings provided to GetIamPolicy.",
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Instance": {
|
||||
@@ -1852,18 +1972,18 @@
|
||||
"id": "Instance",
|
||||
"properties": {
|
||||
"displayName": {
|
||||
"description": "The descriptive name for this instance as it appears in UIs.\nCan be changed at any time, but should be kept globally unique\nto avoid confusion.",
|
||||
"description": "Required. The descriptive name for this instance as it appears in UIs.\nCan be changed at any time, but should be kept globally unique\nto avoid confusion.",
|
||||
"type": "string"
|
||||
},
|
||||
"labels": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. They can be used to filter resources and aggregate\nmetrics.\n\n* Label keys must be between 1 and 63 characters long and must conform to\n the regular expression: `\\p{Ll}\\p{Lo}{0,62}`.\n* Label values must be between 0 and 63 characters long and must conform to\n the regular expression: `[\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}`.\n* No more than 64 labels can be associated with a given resource.\n* Keys and values must both be under 128 bytes.",
|
||||
"description": "Required. Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. They can be used to filter resources and aggregate\nmetrics.\n\n* Label keys must be between 1 and 63 characters long and must conform to\n the regular expression: `\\p{Ll}\\p{Lo}{0,62}`.\n* Label values must be between 0 and 63 characters long and must conform to\n the regular expression: `[\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}`.\n* No more than 64 labels can be associated with a given resource.\n* Keys and values must both be under 128 bytes.",
|
||||
"type": "object"
|
||||
},
|
||||
"name": {
|
||||
"description": "(`OutputOnly`)\nThe unique name of the instance. Values are of the form\n`projects/<project>/instances/a-z+[a-z0-9]`.",
|
||||
"description": "Required. (`OutputOnly`)\nThe unique name of the instance. Values are of the form\n`projects/{project}/instances/a-z+[a-z0-9]`.",
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
@@ -1881,7 +2001,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "The type of the instance. Defaults to `PRODUCTION`.",
|
||||
"description": "Required. The type of the instance. Defaults to `PRODUCTION`.",
|
||||
"enum": [
|
||||
"TYPE_UNSPECIFIED",
|
||||
"PRODUCTION",
|
||||
@@ -2102,7 +2222,7 @@
|
||||
"id": "ModifyColumnFamiliesRequest",
|
||||
"properties": {
|
||||
"modifications": {
|
||||
"description": "Modifications to be atomically applied to the specified table's families.\nEntries are applied in order, meaning that earlier modifications can be\nmasked by later ones (in the case of repeated updates to the same family,\nfor example).",
|
||||
"description": "Required. Modifications to be atomically applied to the specified table's families.\nEntries are applied in order, meaning that earlier modifications can be\nmasked by later ones (in the case of repeated updates to the same family,\nfor example).",
|
||||
"items": {
|
||||
"$ref": "Modification"
|
||||
},
|
||||
@@ -2112,7 +2232,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"MultiClusterRoutingUseAny": {
|
||||
"description": "Read/write requests may be routed to any cluster in the instance, and will\nfail over to another cluster in the event of transient errors or delays.\nChoosing this option sacrifices read-your-writes consistency to improve\navailability.",
|
||||
"description": "Read/write requests are routed to the nearest cluster in the instance, and\nwill fail over to the nearest cluster that is available in the event of\ntransient errors or delays. Clusters in a region are considered\nequidistant. Choosing this option sacrifices read-your-writes consistency\nto improve availability.",
|
||||
"id": "MultiClusterRoutingUseAny",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
@@ -2138,7 +2258,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"name": {
|
||||
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
|
||||
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.",
|
||||
"type": "string"
|
||||
},
|
||||
"response": {
|
||||
@@ -2158,10 +2278,10 @@
|
||||
"properties": {
|
||||
"instance": {
|
||||
"$ref": "Instance",
|
||||
"description": "The Instance which will (partially) replace the current value."
|
||||
"description": "Required. The Instance which will (partially) replace the current value."
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "The subset of Instance fields which should be replaced.\nMust be explicitly set.",
|
||||
"description": "Required. The subset of Instance fields which should be replaced.\nMust be explicitly set.",
|
||||
"format": "google-fieldmask",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -2169,7 +2289,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -2180,19 +2300,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -2216,7 +2336,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"SingleClusterRouting": {
|
||||
"description": "Unconditionally routes all read/write requests to a specific cluster.\nThis option preserves read-your-writes consistency, but does not improve\navailability.",
|
||||
"description": "Unconditionally routes all read/write requests to a specific cluster.\nThis option preserves read-your-writes consistency but does not improve\navailability.",
|
||||
"id": "SingleClusterRouting",
|
||||
"properties": {
|
||||
"allowTransactionalWrites": {
|
||||
@@ -2243,7 +2363,7 @@
|
||||
"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). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
|
||||
"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",
|
||||
"properties": {
|
||||
"code": {
|
||||
@@ -2277,7 +2397,7 @@
|
||||
"additionalProperties": {
|
||||
"$ref": "ClusterState"
|
||||
},
|
||||
"description": "Output only.\nMap from cluster ID to per-cluster table state.\nIf it could not be determined whether or not the table has data in a\nparticular cluster (for example, if its zone is unavailable), then\nthere will be an entry for the cluster with UNKNOWN `replication_status`.\nViews: `REPLICATION_VIEW`, `FULL`",
|
||||
"description": "Output only. Map from cluster ID to per-cluster table state.\nIf it could not be determined whether or not the table has data in a\nparticular cluster (for example, if its zone is unavailable), then\nthere will be an entry for the cluster with UNKNOWN `replication_status`.\nViews: `REPLICATION_VIEW`, `FULL`",
|
||||
"type": "object"
|
||||
},
|
||||
"columnFamilies": {
|
||||
@@ -2300,7 +2420,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output only.\nThe unique name of the table. Values are of the form\n`projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.\nViews: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`",
|
||||
"description": "Output only. The unique name of the table. Values are of the form\n`projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.\nViews: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
474
etc/api/billingbudgets/v1beta1/billingbudgets-api.json
Normal file
474
etc/api/billingbudgets/v1beta1/billingbudgets-api.json
Normal file
@@ -0,0 +1,474 @@
|
||||
{
|
||||
"auth": {
|
||||
"oauth2": {
|
||||
"scopes": {
|
||||
"https://www.googleapis.com/auth/cloud-platform": {
|
||||
"description": "View and manage your data across Google Cloud Platform services"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"basePath": "",
|
||||
"baseUrl": "https://billingbudgets.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "CloudBillingBudget",
|
||||
"description": "The Cloud Billing Budget API stores Cloud Billing budgets, which define a budget plan and the rules to execute as spend is tracked against that plan.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/billing/docs/how-to/budget-api-overview",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
||||
},
|
||||
"id": "billingbudgets:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://billingbudgets.mtls.googleapis.com/",
|
||||
"name": "billingbudgets",
|
||||
"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 response.",
|
||||
"enum": [
|
||||
"json",
|
||||
"media",
|
||||
"proto"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"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",
|
||||
"type": "string"
|
||||
},
|
||||
"key": {
|
||||
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"oauth_token": {
|
||||
"description": "OAuth 2.0 token for the current user.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"prettyPrint": {
|
||||
"default": "true",
|
||||
"description": "Returns response with indentations and line breaks.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"quotaUser": {
|
||||
"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"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"protocol": "rest",
|
||||
"resources": {
|
||||
"billingAccounts": {
|
||||
"resources": {
|
||||
"budgets": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates a new budget. See\n<a href=\"https://cloud.google.com/billing/quotas\">Quotas and limits</a>\nfor more information on the limits of the number of budgets you can create.",
|
||||
"flatPath": "v1beta1/billingAccounts/{billingAccountsId}/budgets",
|
||||
"httpMethod": "POST",
|
||||
"id": "billingbudgets.billingAccounts.budgets.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. The name of the billing account to create the budget in. Values\nare of the form `billingAccounts/{billingAccountId}`.",
|
||||
"location": "path",
|
||||
"pattern": "^billingAccounts/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/budgets",
|
||||
"request": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1Budget"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes a budget. Returns successfully if already deleted.",
|
||||
"flatPath": "v1beta1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "billingbudgets.billingAccounts.budgets.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. Name of the budget to delete. Values are of the form\n`billingAccounts/{billingAccountId}/budgets/{budgetId}`.",
|
||||
"location": "path",
|
||||
"pattern": "^billingAccounts/[^/]+/budgets/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "GoogleProtobufEmpty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Returns a budget.\n\nWARNING: There are some fields exposed on the Google Cloud Console that\naren't available on this API. When reading from the API, you will not\nsee these fields in the return value, though they may have been set\nin the Cloud Console.",
|
||||
"flatPath": "v1beta1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "billingbudgets.billingAccounts.budgets.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. Name of budget to get. Values are of the form\n`billingAccounts/{billingAccountId}/budgets/{budgetId}`.",
|
||||
"location": "path",
|
||||
"pattern": "^billingAccounts/[^/]+/budgets/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1Budget"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Returns a list of budgets for a billing account.\n\nWARNING: There are some fields exposed on the Google Cloud Console that\naren't available on this API. When reading from the API, you will not\nsee these fields in the return value, though they may have been set\nin the Cloud Console.",
|
||||
"flatPath": "v1beta1/billingAccounts/{billingAccountsId}/budgets",
|
||||
"httpMethod": "GET",
|
||||
"id": "billingbudgets.billingAccounts.budgets.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "Optional. The maximum number of budgets to return per page.\nThe default and maximum value are 100.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Optional. The value returned by the last `ListBudgetsResponse` which\nindicates that this is a continuation of a prior `ListBudgets` call,\nand that the system should return the next page of data.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. Name of billing account to list budgets under. Values\nare of the form `billingAccounts/{billingAccountId}`.",
|
||||
"location": "path",
|
||||
"pattern": "^billingAccounts/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/budgets",
|
||||
"response": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1ListBudgetsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates a budget and returns the updated budget.\n\nWARNING: There are some fields exposed on the Google Cloud Console that\naren't available on this API. Budget fields that are not exposed in\nthis API will not be changed by this method.",
|
||||
"flatPath": "v1beta1/billingAccounts/{billingAccountsId}/budgets/{budgetsId}",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "billingbudgets.billingAccounts.budgets.patch",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Output only. Resource name of the budget.\nThe resource name implies the scope of a budget. Values are of the form\n`billingAccounts/{billingAccountId}/budgets/{budgetId}`.",
|
||||
"location": "path",
|
||||
"pattern": "^billingAccounts/[^/]+/budgets/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+name}",
|
||||
"request": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1Budget"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://billingbudgets.googleapis.com/",
|
||||
"schemas": {
|
||||
"GoogleCloudBillingBudgetsV1beta1AllUpdatesRule": {
|
||||
"description": "AllUpdatesRule defines notifications that are sent on every update to the\nbilling account's spend, regardless of the thresholds defined using\nthreshold rules.",
|
||||
"id": "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule",
|
||||
"properties": {
|
||||
"pubsubTopic": {
|
||||
"description": "Required. The name of the Cloud Pub/Sub topic where budget related messages will be\npublished, in the form `projects/{project_id}/topics/{topic_id}`. Updates\nare sent at regular intervals to the topic.\nThe topic needs to be created before the budget is created; see\nhttps://cloud.google.com/billing/docs/how-to/budgets#manage-notifications\nfor more details.\nCaller is expected to have\n`pubsub.topics.setIamPolicy` permission on the topic when it's set for a\nbudget, otherwise, the API call will fail with PERMISSION_DENIED. See\nhttps://cloud.google.com/pubsub/docs/access-control for more details on\nPub/Sub roles and permissions.",
|
||||
"type": "string"
|
||||
},
|
||||
"schemaVersion": {
|
||||
"description": "Required. The schema version of the notification.\nOnly \"1.0\" is accepted. It represents the JSON schema as defined in\nhttps://cloud.google.com/billing/docs/how-to/budgets#notification_format",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleCloudBillingBudgetsV1beta1Budget": {
|
||||
"description": "A budget is a plan that describes what you expect to spend on Cloud\nprojects, plus the rules to execute as spend is tracked against that plan,\n(for example, send an alert when 90% of the target spend is met).\nCurrently all plans are monthly budgets so the usage period(s) tracked are\nimplied (calendar months of usage back-to-back).",
|
||||
"id": "GoogleCloudBillingBudgetsV1beta1Budget",
|
||||
"properties": {
|
||||
"allUpdatesRule": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule",
|
||||
"description": "Optional. Rules to apply to all updates to the actual spend, regardless\nof the thresholds set in `threshold_rules`."
|
||||
},
|
||||
"amount": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1BudgetAmount",
|
||||
"description": "Required. Budgeted amount."
|
||||
},
|
||||
"budgetFilter": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1Filter",
|
||||
"description": "Optional. Filters that define which resources are used to compute\nthe actual spend against the budget."
|
||||
},
|
||||
"displayName": {
|
||||
"description": "User data for display name in UI.\nValidation: <= 60 chars.",
|
||||
"type": "string"
|
||||
},
|
||||
"etag": {
|
||||
"description": "Optional. Etag to validate that the object is unchanged for a\nread-modify-write operation.\nAn empty etag will cause an update to overwrite other changes.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output only. Resource name of the budget.\nThe resource name implies the scope of a budget. Values are of the form\n`billingAccounts/{billingAccountId}/budgets/{budgetId}`.",
|
||||
"type": "string"
|
||||
},
|
||||
"thresholdRules": {
|
||||
"description": "Optional. Rules that trigger alerts (notifications of thresholds\nbeing crossed) when spend exceeds the specified percentages of the budget.",
|
||||
"items": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1ThresholdRule"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleCloudBillingBudgetsV1beta1BudgetAmount": {
|
||||
"description": "The budgeted amount for each usage period.",
|
||||
"id": "GoogleCloudBillingBudgetsV1beta1BudgetAmount",
|
||||
"properties": {
|
||||
"lastPeriodAmount": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1LastPeriodAmount",
|
||||
"description": "Use the last period's actual spend as the budget for the present period."
|
||||
},
|
||||
"specifiedAmount": {
|
||||
"$ref": "GoogleTypeMoney",
|
||||
"description": "A specified amount to use as the budget.\n`currency_code` is optional. If specified, it must match the\ncurrency of the billing account. The `currency_code` is provided on\noutput."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest": {
|
||||
"description": "Request for CreateBudget",
|
||||
"id": "GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest",
|
||||
"properties": {
|
||||
"budget": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1Budget",
|
||||
"description": "Required. Budget to create."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleCloudBillingBudgetsV1beta1Filter": {
|
||||
"description": "A filter for a budget, limiting the scope of the cost to calculate.",
|
||||
"id": "GoogleCloudBillingBudgetsV1beta1Filter",
|
||||
"properties": {
|
||||
"creditTypesTreatment": {
|
||||
"description": "Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.",
|
||||
"enum": [
|
||||
"CREDIT_TYPES_TREATMENT_UNSPECIFIED",
|
||||
"INCLUDE_ALL_CREDITS",
|
||||
"EXCLUDE_ALL_CREDITS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"",
|
||||
"All types of credit are subtracted from the gross cost to determine the\nspend for threshold calculations.",
|
||||
"All types of credit are added to the net cost to determine the spend for\nthreshold calculations."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"projects": {
|
||||
"description": "Optional. A set of projects of the form `projects/{project}`,\nspecifying that usage from only this set of projects should be\nincluded in the budget. If omitted, the report will include all usage for\nthe billing account, regardless of which project the usage occurred on.\nOnly zero or one project can be specified currently.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"services": {
|
||||
"description": "Optional. A set of services of the form `services/{service_id}`,\nspecifying that usage from only this set of services should be\nincluded in the budget. If omitted, the report will include usage for\nall the services.\nThe service names are available through the Catalog API:\nhttps://cloud.google.com/billing/v1/how-tos/catalog-api.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleCloudBillingBudgetsV1beta1LastPeriodAmount": {
|
||||
"description": "Describes a budget amount targeted to last period's spend.\nAt this time, the amount is automatically 100% of last period's spend;\nthat is, there are no other options yet.\nFuture configuration will be described here (for example, configuring a\npercentage of last period's spend).",
|
||||
"id": "GoogleCloudBillingBudgetsV1beta1LastPeriodAmount",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleCloudBillingBudgetsV1beta1ListBudgetsResponse": {
|
||||
"description": "Response for ListBudgets",
|
||||
"id": "GoogleCloudBillingBudgetsV1beta1ListBudgetsResponse",
|
||||
"properties": {
|
||||
"budgets": {
|
||||
"description": "List of the budgets owned by the requested billing account.",
|
||||
"items": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1Budget"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "If not empty, indicates that there may be more budgets that match the\nrequest; this value should be passed in a new `ListBudgetsRequest`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleCloudBillingBudgetsV1beta1ThresholdRule": {
|
||||
"description": "ThresholdRule contains a definition of a threshold which triggers\nan alert (a notification of a threshold being crossed) to be sent when\nspend goes above the specified amount.\nAlerts are automatically e-mailed to users with the Billing Account\nAdministrator role or the Billing Account User role.\nThe thresholds here have no effect on notifications sent to anything\nconfigured under `Budget.all_updates_rule`.",
|
||||
"id": "GoogleCloudBillingBudgetsV1beta1ThresholdRule",
|
||||
"properties": {
|
||||
"spendBasis": {
|
||||
"description": "Optional. The type of basis used to determine if spend has passed the\nthreshold. Behavior defaults to CURRENT_SPEND if not set.",
|
||||
"enum": [
|
||||
"BASIS_UNSPECIFIED",
|
||||
"CURRENT_SPEND",
|
||||
"FORECASTED_SPEND"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified threshold basis.",
|
||||
"Use current spend as the basis for comparison against the threshold.",
|
||||
"Use forecasted spend for the period as the basis for comparison against\nthe threshold."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"thresholdPercent": {
|
||||
"description": "Required. Send an alert when this threshold is exceeded.\nThis is a 1.0-based percentage, so 0.5 = 50%.\nValidation: non-negative number.",
|
||||
"format": "double",
|
||||
"type": "number"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest": {
|
||||
"description": "Request for UpdateBudget",
|
||||
"id": "GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest",
|
||||
"properties": {
|
||||
"budget": {
|
||||
"$ref": "GoogleCloudBillingBudgetsV1beta1Budget",
|
||||
"description": "Required. The updated budget object.\nThe budget to update is specified by the budget name in the budget."
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Optional. Indicates which fields in the provided budget to update.\nRead-only fields (such as `name`) cannot be changed. If this is not\nprovided, then only fields with non-default values from the request are\nupdated. See\nhttps://developers.google.com/protocol-buffers/docs/proto3#default for more\ndetails about default values.",
|
||||
"format": "google-fieldmask",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleProtobufEmpty": {
|
||||
"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": "GoogleProtobufEmpty",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleTypeMoney": {
|
||||
"description": "Represents an amount of money with its currency type.",
|
||||
"id": "GoogleTypeMoney",
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "Cloud Billing Budget API",
|
||||
"version": "v1beta1",
|
||||
"version_module": true
|
||||
}
|
||||
856
etc/api/binaryauthorization/v1/binaryauthorization-api.json
Normal file
856
etc/api/binaryauthorization/v1/binaryauthorization-api.json
Normal file
@@ -0,0 +1,856 @@
|
||||
{
|
||||
"auth": {
|
||||
"oauth2": {
|
||||
"scopes": {
|
||||
"https://www.googleapis.com/auth/cloud-platform": {
|
||||
"description": "View and manage your data across Google Cloud Platform services"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"basePath": "",
|
||||
"baseUrl": "https://binaryauthorization.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "Binary Authorization",
|
||||
"description": "The management interface for Binary Authorization, a system providing policy control for images deployed to Kubernetes Engine clusters.\n",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/binary-authorization/",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
||||
},
|
||||
"id": "binaryauthorization:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://binaryauthorization.mtls.googleapis.com/",
|
||||
"name": "binaryauthorization",
|
||||
"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 response.",
|
||||
"enum": [
|
||||
"json",
|
||||
"media",
|
||||
"proto"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"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",
|
||||
"type": "string"
|
||||
},
|
||||
"key": {
|
||||
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"oauth_token": {
|
||||
"description": "OAuth 2.0 token for the current user.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"prettyPrint": {
|
||||
"default": "true",
|
||||
"description": "Returns response with indentations and line breaks.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"quotaUser": {
|
||||
"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"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"protocol": "rest",
|
||||
"resources": {
|
||||
"projects": {
|
||||
"methods": {
|
||||
"getPolicy": {
|
||||
"description": "A policy specifies the attestors that must attest to\na container image, before the project is allowed to deploy that\nimage. There is at most one policy per project. All image admission\nrequests are permitted if a project has no policy.\n\nGets the policy for this project. Returns a default\npolicy if the project does not have one.",
|
||||
"flatPath": "v1/projects/{projectsId}/policy",
|
||||
"httpMethod": "GET",
|
||||
"id": "binaryauthorization.projects.getPolicy",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The resource name of the policy to retrieve,\nin the format `projects/*/policy`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/policy$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Policy"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"updatePolicy": {
|
||||
"description": "Creates or updates a project's policy, and returns a copy of the\nnew policy. A policy is always updated as a whole, to avoid race\nconditions with concurrent policy enforcement (or management!)\nrequests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT\nif the request is malformed.",
|
||||
"flatPath": "v1/projects/{projectsId}/policy",
|
||||
"httpMethod": "PUT",
|
||||
"id": "binaryauthorization.projects.updatePolicy",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Output only. The resource name, in the format `projects/*/policy`. There is\nat most one policy per project.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/policy$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"request": {
|
||||
"$ref": "Policy"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Policy"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"attestors": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates an attestor, and returns a copy of the new\nattestor. Returns NOT_FOUND if the project does not exist,\nINVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the\nattestor already exists.",
|
||||
"flatPath": "v1/projects/{projectsId}/attestors",
|
||||
"httpMethod": "POST",
|
||||
"id": "binaryauthorization.projects.attestors.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"attestorId": {
|
||||
"description": "Required. The attestors ID.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. The parent of this attestor.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/attestors",
|
||||
"request": {
|
||||
"$ref": "Attestor"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Attestor"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes an attestor. Returns NOT_FOUND if the\nattestor does not exist.",
|
||||
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "binaryauthorization.projects.attestors.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The name of the attestors to delete, in the format\n`projects/*/attestors/*`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Gets an attestor.\nReturns NOT_FOUND if the attestor does not exist.",
|
||||
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "binaryauthorization.projects.attestors.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The name of the attestor to retrieve, in the format\n`projects/*/attestors/*`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Attestor"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"getIamPolicy": {
|
||||
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
|
||||
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}:getIamPolicy",
|
||||
"httpMethod": "GET",
|
||||
"id": "binaryauthorization.projects.attestors.getIamPolicy",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+resource}:getIamPolicy",
|
||||
"response": {
|
||||
"$ref": "IamPolicy"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists attestors.\nReturns INVALID_ARGUMENT if the project does not exist.",
|
||||
"flatPath": "v1/projects/{projectsId}/attestors",
|
||||
"httpMethod": "GET",
|
||||
"id": "binaryauthorization.projects.attestors.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "Requested page size. The server may return fewer results than requested. If\nunspecified, the server will pick an appropriate default.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "A token identifying a page of results the server should return. Typically,\nthis is the value of ListAttestorsResponse.next_page_token returned\nfrom the previous call to the `ListAttestors` method.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. The resource name of the project associated with the\nattestors, in the format `projects/*`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/attestors",
|
||||
"response": {
|
||||
"$ref": "ListAttestorsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "binaryauthorization.projects.attestors.setIamPolicy",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+resource}:setIamPolicy",
|
||||
"request": {
|
||||
"$ref": "SetIamPolicyRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "IamPolicy"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"testIamPermissions": {
|
||||
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
|
||||
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}:testIamPermissions",
|
||||
"httpMethod": "POST",
|
||||
"id": "binaryauthorization.projects.attestors.testIamPermissions",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+resource}:testIamPermissions",
|
||||
"request": {
|
||||
"$ref": "TestIamPermissionsRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "TestIamPermissionsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"update": {
|
||||
"description": "Updates an attestor.\nReturns NOT_FOUND if the attestor does not exist.",
|
||||
"flatPath": "v1/projects/{projectsId}/attestors/{attestorsId}",
|
||||
"httpMethod": "PUT",
|
||||
"id": "binaryauthorization.projects.attestors.update",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The resource name, in the format:\n`projects/*/attestors/*`. This field may not be updated.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/attestors/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"request": {
|
||||
"$ref": "Attestor"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Attestor"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"policy": {
|
||||
"methods": {
|
||||
"getIamPolicy": {
|
||||
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
|
||||
"flatPath": "v1/projects/{projectsId}/policy:getIamPolicy",
|
||||
"httpMethod": "GET",
|
||||
"id": "binaryauthorization.projects.policy.getIamPolicy",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/policy$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+resource}:getIamPolicy",
|
||||
"response": {
|
||||
"$ref": "IamPolicy"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1/projects/{projectsId}/policy:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "binaryauthorization.projects.policy.setIamPolicy",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/policy$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+resource}:setIamPolicy",
|
||||
"request": {
|
||||
"$ref": "SetIamPolicyRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "IamPolicy"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"testIamPermissions": {
|
||||
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
|
||||
"flatPath": "v1/projects/{projectsId}/policy:testIamPermissions",
|
||||
"httpMethod": "POST",
|
||||
"id": "binaryauthorization.projects.policy.testIamPermissions",
|
||||
"parameterOrder": [
|
||||
"resource"
|
||||
],
|
||||
"parameters": {
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/policy$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+resource}:testIamPermissions",
|
||||
"request": {
|
||||
"$ref": "TestIamPermissionsRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "TestIamPermissionsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20200327",
|
||||
"rootUrl": "https://binaryauthorization.googleapis.com/",
|
||||
"schemas": {
|
||||
"AdmissionRule": {
|
||||
"description": "An admission rule specifies either that all container images\nused in a pod creation request must be attested to by one or more\nattestors, that all pod creations will be allowed, or that all\npod creations will be denied.\n\nImages matching an admission whitelist pattern\nare exempted from admission rules and will never block a pod creation.",
|
||||
"id": "AdmissionRule",
|
||||
"properties": {
|
||||
"enforcementMode": {
|
||||
"description": "Required. The action when a pod creation is denied by the admission rule.",
|
||||
"enum": [
|
||||
"ENFORCEMENT_MODE_UNSPECIFIED",
|
||||
"ENFORCED_BLOCK_AND_AUDIT_LOG",
|
||||
"DRYRUN_AUDIT_LOG_ONLY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Do not use.",
|
||||
"Enforce the admission rule by blocking the pod creation.",
|
||||
"Dryrun mode: Audit logging only. This will allow the pod creation as if\nthe admission request had specified break-glass."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"evaluationMode": {
|
||||
"description": "Required. How this admission rule will be evaluated.",
|
||||
"enum": [
|
||||
"EVALUATION_MODE_UNSPECIFIED",
|
||||
"ALWAYS_ALLOW",
|
||||
"REQUIRE_ATTESTATION",
|
||||
"ALWAYS_DENY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Do not use.",
|
||||
"This rule allows all all pod creations.",
|
||||
"This rule allows a pod creation if all the attestors listed in\n'require_attestations_by' have valid attestations for all of the\nimages in the pod spec.",
|
||||
"This rule denies all pod creations."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"requireAttestationsBy": {
|
||||
"description": "Optional. The resource names of the attestors that must attest to\na container image, in the format `projects/*/attestors/*`. Each\nattestor must exist before a policy can reference it. To add an attestor\nto a policy the principal issuing the policy change request must be able\nto read the attestor resource.\n\nNote: this field must be non-empty when the evaluation_mode field specifies\nREQUIRE_ATTESTATION, otherwise it must be empty.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AdmissionWhitelistPattern": {
|
||||
"description": "An admission whitelist pattern exempts images\nfrom checks by admission rules.",
|
||||
"id": "AdmissionWhitelistPattern",
|
||||
"properties": {
|
||||
"namePattern": {
|
||||
"description": "An image name pattern to whitelist, in the form `registry/path/to/image`.\nThis supports a trailing `*` as a wildcard, but this is allowed only in\ntext after the `registry/` part.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Attestor": {
|
||||
"description": "An attestor that attests to container image\nartifacts. An existing attestor cannot be modified except where\nindicated.",
|
||||
"id": "Attestor",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "Optional. A descriptive comment. This field may be updated.\nThe field may be displayed in chooser dialogs.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Required. The resource name, in the format:\n`projects/*/attestors/*`. This field may not be updated.",
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only. Time when the attestor was last updated.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"userOwnedGrafeasNote": {
|
||||
"$ref": "UserOwnedGrafeasNote",
|
||||
"description": "This specifies how an attestation will be read, and how it will be used\nduring policy enforcement."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AttestorPublicKey": {
|
||||
"description": "An attestor public key that will be used to verify\nattestations signed by this attestor.",
|
||||
"id": "AttestorPublicKey",
|
||||
"properties": {
|
||||
"asciiArmoredPgpPublicKey": {
|
||||
"description": "ASCII-armored representation of a PGP public key, as the entire output by\nthe command `gpg --export --armor foo@example.com` (either LF or CRLF\nline endings).\nWhen using this field, `id` should be left blank. The BinAuthz API\nhandlers will calculate the ID and fill it in automatically. BinAuthz\ncomputes this ID as the OpenPGP RFC4880 V4 fingerprint, represented as\nupper-case hex. If `id` is provided by the caller, it will be\noverwritten by the API-calculated ID.",
|
||||
"type": "string"
|
||||
},
|
||||
"comment": {
|
||||
"description": "Optional. A descriptive comment. This field may be updated.",
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"description": "The ID of this public key.\nSignatures verified by BinAuthz must include the ID of the public key that\ncan be used to verify them, and that ID must match the contents of this\nfield exactly.\nAdditional restrictions on this field can be imposed based on which public\nkey type is encapsulated. See the documentation on `public_key` cases below\nfor details.",
|
||||
"type": "string"
|
||||
},
|
||||
"pkixPublicKey": {
|
||||
"$ref": "PkixPublicKey",
|
||||
"description": "A raw PKIX SubjectPublicKeyInfo format public key.\n\nNOTE: `id` may be explicitly provided by the caller when using this\ntype of public key, but it MUST be a valid RFC3986 URI. If `id` is left\nblank, a default one will be computed based on the digest of the DER\nencoding of the public key."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Binding": {
|
||||
"description": "Associates `members` with a `role`.",
|
||||
"id": "Binding",
|
||||
"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."
|
||||
},
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"role": {
|
||||
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"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"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"IamPolicy": {
|
||||
"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/).",
|
||||
"id": "IamPolicy",
|
||||
"properties": {
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListAttestorsResponse": {
|
||||
"description": "Response message for BinauthzManagementService.ListAttestors.",
|
||||
"id": "ListAttestorsResponse",
|
||||
"properties": {
|
||||
"attestors": {
|
||||
"description": "The list of attestors.",
|
||||
"items": {
|
||||
"$ref": "Attestor"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "A token to retrieve the next page of results. Pass this value in the\nListAttestorsRequest.page_token field in the subsequent call to the\n`ListAttestors` method to retrieve the next page of results.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PkixPublicKey": {
|
||||
"description": "A public key in the PkixPublicKey format (see\nhttps://tools.ietf.org/html/rfc5280#section-4.1.2.7 for details).\nPublic keys of this type are typically textually encoded using the PEM\nformat.",
|
||||
"id": "PkixPublicKey",
|
||||
"properties": {
|
||||
"publicKeyPem": {
|
||||
"description": "A PEM-encoded public key, as described in\nhttps://tools.ietf.org/html/rfc7468#section-13",
|
||||
"type": "string"
|
||||
},
|
||||
"signatureAlgorithm": {
|
||||
"description": "The signature algorithm used to verify a message against a signature using\nthis key.\nThese signature algorithm must match the structure and any object\nidentifiers encoded in `public_key_pem` (i.e. this algorithm must match\nthat of the public key).",
|
||||
"enum": [
|
||||
"SIGNATURE_ALGORITHM_UNSPECIFIED",
|
||||
"RSA_PSS_2048_SHA256",
|
||||
"RSA_PSS_3072_SHA256",
|
||||
"RSA_PSS_4096_SHA256",
|
||||
"RSA_PSS_4096_SHA512",
|
||||
"RSA_SIGN_PKCS1_2048_SHA256",
|
||||
"RSA_SIGN_PKCS1_3072_SHA256",
|
||||
"RSA_SIGN_PKCS1_4096_SHA256",
|
||||
"RSA_SIGN_PKCS1_4096_SHA512",
|
||||
"ECDSA_P256_SHA256",
|
||||
"ECDSA_P384_SHA384",
|
||||
"ECDSA_P521_SHA512"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not specified.",
|
||||
"RSASSA-PSS 2048 bit key with a SHA256 digest.",
|
||||
"RSASSA-PSS 3072 bit key with a SHA256 digest.",
|
||||
"RSASSA-PSS 4096 bit key with a SHA256 digest.",
|
||||
"RSASSA-PSS 4096 bit key with a SHA512 digest.",
|
||||
"RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest.",
|
||||
"RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest.",
|
||||
"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest.",
|
||||
"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest.",
|
||||
"ECDSA on the NIST P-256 curve with a SHA256 digest.",
|
||||
"ECDSA on the NIST P-384 curve with a SHA384 digest.",
|
||||
"ECDSA on the NIST P-521 curve with a SHA512 digest."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "A policy for container image binary authorization.",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"admissionWhitelistPatterns": {
|
||||
"description": "Optional. Admission policy whitelisting. A matching admission request will\nalways be permitted. This feature is typically used to exclude Google or\nthird-party infrastructure images from Binary Authorization policies.",
|
||||
"items": {
|
||||
"$ref": "AdmissionWhitelistPattern"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"clusterAdmissionRules": {
|
||||
"additionalProperties": {
|
||||
"$ref": "AdmissionRule"
|
||||
},
|
||||
"description": "Optional. Per-cluster admission rules. Cluster spec format:\n`location.clusterId`. There can be at most one admission rule per cluster\nspec.\nA `location` is either a compute zone (e.g. us-central1-a) or a region\n(e.g. us-central1).\nFor `clusterId` syntax restrictions see\nhttps://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters.",
|
||||
"type": "object"
|
||||
},
|
||||
"defaultAdmissionRule": {
|
||||
"$ref": "AdmissionRule",
|
||||
"description": "Required. Default admission rule for a cluster without a per-cluster, per-\nkubernetes-service-account, or per-istio-service-identity admission rule."
|
||||
},
|
||||
"description": {
|
||||
"description": "Optional. A descriptive comment.",
|
||||
"type": "string"
|
||||
},
|
||||
"globalPolicyEvaluationMode": {
|
||||
"description": "Optional. Controls the evaluation of a Google-maintained global admission\npolicy for common system-level images. Images not covered by the global\npolicy will be subject to the project admission policy. This setting\nhas no effect when specified inside a global admission policy.",
|
||||
"enum": [
|
||||
"GLOBAL_POLICY_EVALUATION_MODE_UNSPECIFIED",
|
||||
"ENABLE",
|
||||
"DISABLE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not specified: DISABLE is assumed.",
|
||||
"Enables global policy evaluation.",
|
||||
"Disables global policy evaluation."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output only. The resource name, in the format `projects/*/policy`. There is\nat most one policy per project.",
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only. Time when the policy was last updated.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SetIamPolicyRequest": {
|
||||
"description": "Request message for `SetIamPolicy` method.",
|
||||
"id": "SetIamPolicyRequest",
|
||||
"properties": {
|
||||
"policy": {
|
||||
"$ref": "IamPolicy",
|
||||
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TestIamPermissionsRequest": {
|
||||
"description": "Request message for `TestIamPermissions` method.",
|
||||
"id": "TestIamPermissionsRequest",
|
||||
"properties": {
|
||||
"permissions": {
|
||||
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TestIamPermissionsResponse": {
|
||||
"description": "Response message for `TestIamPermissions` method.",
|
||||
"id": "TestIamPermissionsResponse",
|
||||
"properties": {
|
||||
"permissions": {
|
||||
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"UserOwnedGrafeasNote": {
|
||||
"description": "An user owned Grafeas note references a Grafeas\nAttestation.Authority Note created by the user.",
|
||||
"id": "UserOwnedGrafeasNote",
|
||||
"properties": {
|
||||
"delegationServiceAccountEmail": {
|
||||
"description": "Output only. This field will contain the service account email address\nthat this Attestor will use as the principal when querying Container\nAnalysis. Attestor administrators must grant this service account the\nIAM role needed to read attestations from the note_reference in\nContainer Analysis (`containeranalysis.notes.occurrences.viewer`).\n\nThis email address is fixed for the lifetime of the Attestor, but callers\nshould not make any other assumptions about the service account email;\nfuture versions may use an email based on a different naming pattern.",
|
||||
"type": "string"
|
||||
},
|
||||
"noteReference": {
|
||||
"description": "Required. The Grafeas resource name of a Attestation.Authority Note,\ncreated by the user, in the format: `projects/*/notes/*`. This field may\nnot be updated.\n\nAn attestation by this attestor is stored as a Grafeas\nAttestation.Authority Occurrence that names a container image and that\nlinks to this Note. Grafeas is an external dependency.",
|
||||
"type": "string"
|
||||
},
|
||||
"publicKeys": {
|
||||
"description": "Optional. Public keys that verify attestations signed by this\nattestor. This field may be updated.\n\nIf this field is non-empty, one of the specified public keys must\nverify that an attestation was signed by this attestor for the\nimage specified in the admission request.\n\nIf this field is empty, this attestor always returns that no\nvalid attestations exist.",
|
||||
"items": {
|
||||
"$ref": "AttestorPublicKey"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "Binary Authorization API",
|
||||
"version": "v1",
|
||||
"version_module": true
|
||||
}
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "binaryauthorization:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://binaryauthorization.mtls.googleapis.com/",
|
||||
"name": "binaryauthorization",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -256,7 +257,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"options.requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
@@ -314,7 +315,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/attestors/{attestorsId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "binaryauthorization.projects.attestors.setIamPolicy",
|
||||
@@ -411,7 +412,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"options.requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
@@ -433,7 +434,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/policy:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "binaryauthorization.projects.policy.setIamPolicy",
|
||||
@@ -493,7 +494,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190628",
|
||||
"revision": "20200327",
|
||||
"rootUrl": "https://binaryauthorization.googleapis.com/",
|
||||
"schemas": {
|
||||
"AdmissionRule": {
|
||||
@@ -607,7 +608,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -627,46 +628,46 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"IamPolicy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "IamPolicy",
|
||||
"properties": {
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
"description": "API for access to the data within Blogger.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/blogger/docs/2.0/json/getting_started",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/-Mtk4jzrnfn1WM7fqzAFlj2E6ZM\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/5n8J-SrfC_3u-tnboDRXTbXXKhw\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/blogger-16.png",
|
||||
"x32": "https://www.google.com/images/icons/product/blogger-32.png"
|
||||
@@ -392,7 +392,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20150422",
|
||||
"revision": "20200204",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Blog": {
|
||||
|
||||
Binary file not shown.
@@ -14,7 +14,7 @@
|
||||
"description": "Searches for books and manages your Google Books library.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/books/docs/v1/getting_started",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/h5Orf5DrqrrUcgcY5Qi7H6FmfVA\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/FivGHh5u6W1RctbrVrrDR-2aAQM\"",
|
||||
"icons": {
|
||||
"x16": "https://www.google.com/images/icons/product/ebooks-16.png",
|
||||
"x32": "https://www.google.com/images/icons/product/ebooks-32.png"
|
||||
@@ -2480,7 +2480,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20181212",
|
||||
"revision": "20200310",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Annotation": {
|
||||
@@ -2796,6 +2796,30 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"BooksSubscriptionReleaseInfo": {
|
||||
"id": "BooksSubscriptionReleaseInfo",
|
||||
"properties": {
|
||||
"amountInMicros": {
|
||||
"description": "Amount in micros of the specified currency code.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"currencyCode": {
|
||||
"description": "Currency code of the amount.",
|
||||
"type": "string"
|
||||
},
|
||||
"releaseNumber": {
|
||||
"description": "The release number of this issue/volume/book.",
|
||||
"type": "string"
|
||||
},
|
||||
"releaseTimestampUs": {
|
||||
"description": "The release date.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"BooksVolumesRecommendedRateResponse": {
|
||||
"id": "BooksVolumesRecommendedRateResponse",
|
||||
"properties": {
|
||||
@@ -3830,15 +3854,49 @@
|
||||
"bannerImageUrl": {
|
||||
"type": "string"
|
||||
},
|
||||
"eligibleForSubscription": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"imageUrl": {
|
||||
"type": "string"
|
||||
},
|
||||
"isComplete": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"seriesFormatType": {
|
||||
"type": "string"
|
||||
},
|
||||
"seriesId": {
|
||||
"type": "string"
|
||||
},
|
||||
"seriesSubscriptionReleaseInfo": {
|
||||
"properties": {
|
||||
"cancellationTimestampUs": {
|
||||
"description": "Cancellation date of the series subscription (or when it ends).",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"currentReleaseInfo": {
|
||||
"$ref": "BooksSubscriptionReleaseInfo",
|
||||
"description": "Release information for the last release."
|
||||
},
|
||||
"nextReleaseInfo": {
|
||||
"$ref": "BooksSubscriptionReleaseInfo",
|
||||
"description": "Release information for the next release."
|
||||
},
|
||||
"seriesSubscriptionType": {
|
||||
"description": "series subscription type.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"seriesType": {
|
||||
"type": "string"
|
||||
},
|
||||
"subscriptionId": {
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"type": "string"
|
||||
}
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
"description": "Manipulates events and other calendar data.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/google-apps/calendar/firstapp",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Uw1wZjyl7UpAF8rQe1IdxXCUbFE\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/7Yu8Dg6pIx8hQ9JbwRYcDNjZYUM\"",
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/calendar-16.png",
|
||||
"x32": "http://www.google.com/images/icons/product/calendar-32.png"
|
||||
@@ -837,7 +837,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"alwaysIncludeEmail": {
|
||||
"description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
|
||||
"description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
@@ -994,7 +994,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"alwaysIncludeEmail": {
|
||||
"description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
|
||||
"description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
@@ -1078,7 +1078,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"alwaysIncludeEmail": {
|
||||
"description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
|
||||
"description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
@@ -1267,7 +1267,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"alwaysIncludeEmail": {
|
||||
"description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
|
||||
"description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
@@ -1397,7 +1397,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"alwaysIncludeEmail": {
|
||||
"description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
|
||||
"description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
@@ -1475,7 +1475,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"alwaysIncludeEmail": {
|
||||
"description": "Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.",
|
||||
"description": "Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
@@ -1724,7 +1724,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190702",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"Acl": {
|
||||
@@ -1785,7 +1785,8 @@
|
||||
"scope": {
|
||||
"annotations": {
|
||||
"required": [
|
||||
"calendar.acl.insert"
|
||||
"calendar.acl.insert",
|
||||
"calendar.acl.update"
|
||||
]
|
||||
},
|
||||
"description": "The scope of the rule.",
|
||||
@@ -1793,7 +1794,8 @@
|
||||
"type": {
|
||||
"annotations": {
|
||||
"required": [
|
||||
"calendar.acl.insert"
|
||||
"calendar.acl.insert",
|
||||
"calendar.acl.update"
|
||||
]
|
||||
},
|
||||
"description": "The type of the scope. Possible values are: \n- \"default\" - The public scope. This is the default value. \n- \"user\" - Limits the scope to a single user. \n- \"group\" - Limits the scope to a group. \n- \"domain\" - Limits the scope to a domain. Note: The permissions granted to the \"default\", or public, scope apply to any user, authenticated or not.",
|
||||
@@ -1991,7 +1993,7 @@
|
||||
"id": "CalendarNotification",
|
||||
"properties": {
|
||||
"method": {
|
||||
"description": "The method used to deliver the notification. Possible values are: \n- \"email\" - Notifications are sent via email. \n- \"sms\" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See Google Calendar SMS notifications to be removed for more information.\nNotifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers. \nRequired when adding a notification.",
|
||||
"description": "The method used to deliver the notification. The possible value is: \n- \"email\" - Notifications are sent via email. \nRequired when adding a notification.",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
@@ -2103,7 +2105,7 @@
|
||||
"id": "ConferenceData",
|
||||
"properties": {
|
||||
"conferenceId": {
|
||||
"description": "The ID of the conference.\nCan be used by developers to keep track of conferences, should not be displayed to users.\nValues for solution types: \n- \"eventHangout\": unset.\n- \"eventNamedHangout\": the name of the Hangout.\n- \"hangoutsMeet\": the 10-letter meeting code, for example \"aaa-bbbb-ccc\". Optional.",
|
||||
"description": "The ID of the conference.\nCan be used by developers to keep track of conferences, should not be displayed to users.\nValues for solution types: \n- \"eventHangout\": unset.\n- \"eventNamedHangout\": the name of the Hangout.\n- \"hangoutsMeet\": the 10-letter meeting code, for example \"aaa-bbbb-ccc\".\n- \"addOn\": defined by 3P conference provider. Optional.",
|
||||
"type": "string"
|
||||
},
|
||||
"conferenceSolution": {
|
||||
@@ -2203,7 +2205,7 @@
|
||||
"id": "ConferenceSolutionKey",
|
||||
"properties": {
|
||||
"type": {
|
||||
"description": "The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (http://hangouts.google.com)\n- \"eventNamedHangout\" for classic Hangouts for G Suite users (http://hangouts.google.com)\n- \"hangoutsMeet\" for Hangouts Meet (http://meet.google.com)",
|
||||
"description": "The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (http://hangouts.google.com)\n- \"eventNamedHangout\" for classic Hangouts for G Suite users (http://hangouts.google.com)\n- \"hangoutsMeet\" for Hangouts Meet (http://meet.google.com)\n- \"addOn\" for 3P conference providers",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -2354,7 +2356,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"description": {
|
||||
"description": "Description of the event. Optional.",
|
||||
"description": "Description of the event. Can contain HTML. Optional.",
|
||||
"type": "string"
|
||||
},
|
||||
"end": {
|
||||
@@ -2522,7 +2524,7 @@
|
||||
},
|
||||
"privateCopy": {
|
||||
"default": "false",
|
||||
"description": "Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False.",
|
||||
"description": "If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"recurrence": {
|
||||
@@ -2710,7 +2712,7 @@
|
||||
"id": "EventReminder",
|
||||
"properties": {
|
||||
"method": {
|
||||
"description": "The method used by this reminder. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"sms\" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information.\nReminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored. \n- \"popup\" - Reminders are sent via a UI popup. \nRequired when adding a reminder.",
|
||||
"description": "The method used by this reminder. Possible values are: \n- \"email\" - Reminders are sent via email. \n- \"popup\" - Reminders are sent via a UI popup. \nRequired when adding a reminder.",
|
||||
"type": "string"
|
||||
},
|
||||
"minutes": {
|
||||
|
||||
@@ -13,6 +13,7 @@
|
||||
},
|
||||
"id": "chat:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://chat.mtls.googleapis.com/",
|
||||
"name": "chat",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -297,7 +298,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Required. The field paths to be updated.\n\nCurrently supported field paths: \"text\", \"cards\".",
|
||||
"description": "Required. The field paths to be updated, comma separated if there are\nmultiple.\n\nCurrently supported field paths:\n* text\n* cards",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -316,7 +317,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190622",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://chat.googleapis.com/",
|
||||
"schemas": {
|
||||
"ActionParameter": {
|
||||
@@ -554,7 +555,7 @@
|
||||
"id": "FormAction",
|
||||
"properties": {
|
||||
"actionMethodName": {
|
||||
"description": "Apps Script function to invoke when the containing element is\nclicked/activated.",
|
||||
"description": "The method name is used to identify which part of the form triggered the\nform submission. This information is echoed back to the bot as part of\nthe card click event. The same method name can be used for several\nelements that trigger a common behavior if desired.",
|
||||
"type": "string"
|
||||
},
|
||||
"parameters": {
|
||||
@@ -572,7 +573,7 @@
|
||||
"id": "Image",
|
||||
"properties": {
|
||||
"aspectRatio": {
|
||||
"description": "The aspect ratio of this image (width/height).",
|
||||
"description": "The aspect ratio of this image (width/height). This field allows clients\nto reserve the right height for the image while waiting for it to load.\nIt's not meant to override the native aspect ratio of the image.\nIf unset, the server fills it by prefetching the image.",
|
||||
"format": "double",
|
||||
"type": "number"
|
||||
},
|
||||
@@ -1030,6 +1031,10 @@
|
||||
"description": "The user's display name.",
|
||||
"type": "string"
|
||||
},
|
||||
"domainId": {
|
||||
"description": "Obfuscated domain information.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Resource name, in the format \"users/*\".",
|
||||
"type": "string"
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
"description": "Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/civic-information",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/2HSm5Y_VQu7HMhXJ9JbMEFESbM0\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/1WnlVFZbiNK3xcDMHn8dwHwgifk\"",
|
||||
"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"
|
||||
@@ -322,7 +322,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190402",
|
||||
"revision": "20191030",
|
||||
"rootUrl": "https://www.googleapis.com/",
|
||||
"schemas": {
|
||||
"AdministrationRegion": {
|
||||
@@ -838,88 +838,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"LivegraphBacktraceRecordInfo": {
|
||||
"id": "LivegraphBacktraceRecordInfo",
|
||||
"properties": {
|
||||
"dataSourcePublishMsec": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"expId": {
|
||||
"type": "string"
|
||||
},
|
||||
"expInfo": {
|
||||
"$ref": "LivegraphBacktraceRecordInfoExpInfo"
|
||||
},
|
||||
"isRecon": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"isWlmThrottled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"numberOfTriples": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"priority": {
|
||||
"type": "string"
|
||||
},
|
||||
"process": {
|
||||
"type": "string"
|
||||
},
|
||||
"proxyReceiveMsec": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"proxySentMsec": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"recordId": {
|
||||
"type": "string"
|
||||
},
|
||||
"shouldMonitorLatency": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"subscriberReceiveMsec": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"topicBuildFinishMsec": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"topicBuildStartMsec": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"LivegraphBacktraceRecordInfoExpInfo": {
|
||||
"id": "LivegraphBacktraceRecordInfoExpInfo",
|
||||
"properties": {
|
||||
"deletedIns": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MessageSet": {
|
||||
"id": "MessageSet",
|
||||
"properties": {
|
||||
"recordMessageSetExt": {
|
||||
"$ref": "LivegraphBacktraceRecordInfo"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Office": {
|
||||
"description": "Information about an Office held by one or more Officials.",
|
||||
"id": "Office",
|
||||
@@ -1031,9 +949,6 @@
|
||||
},
|
||||
"metadata": {
|
||||
"$ref": "FieldMetadataProto"
|
||||
},
|
||||
"temporaryData": {
|
||||
"$ref": "MessageSet"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1441,12 +1356,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"startLatE7": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"startLngE7": {
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"state": {
|
||||
"type": "string"
|
||||
|
||||
@@ -71,12 +71,14 @@
|
||||
"description": "Manages classes, rosters, and invitations in Google Classroom.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/classroom/",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
||||
},
|
||||
"id": "classroom:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://classroom.mtls.googleapis.com/",
|
||||
"name": "classroom",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -642,7 +644,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Mask that identifies which fields on the announcement to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Announcement object. If\na field that does not support empty values is included in the update mask\nand not set in the Announcement object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `text`\n* `state`\n* `scheduled_time`",
|
||||
"description": "Mask that identifies which fields on the announcement to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Announcement object. If\na field that does not support empty values is included in the update mask\nand not set in the Announcement object, an `INVALID_ARGUMENT` error is\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `text`\n* `state`\n* `scheduled_time`",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -867,7 +869,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`\n* `topic_id`",
|
||||
"description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error is\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`\n* `topic_id`",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -1652,7 +1654,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Mask that identifies which fields on the topic to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Topic object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the Topic object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified:\n\n* `name`",
|
||||
"description": "Mask that identifies which fields on the topic to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Topic object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the Topic object, an `INVALID_ARGUMENT` error is\nreturned.\n\nThe following fields may be specified:\n\n* `name`",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -1954,7 +1956,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"invitedEmailAddress": {
|
||||
"description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
|
||||
"description": "If specified, only results with the specified `invited_email_address`\nare returned.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1965,12 +1967,12 @@
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
|
||||
"description": "nextPageToken\nvalue returned from a previous\nlist\ncall, indicating that the subsequent page of results should be returned.\n\nThe list\nrequest must be otherwise identical to the one that resulted in this token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"states": {
|
||||
"description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.",
|
||||
"description": "If specified, only results with the specified `state` values are\nreturned. Otherwise, results with a `state` of `PENDING` are returned.",
|
||||
"enum": [
|
||||
"GUARDIAN_INVITATION_STATE_UNSPECIFIED",
|
||||
"PENDING",
|
||||
@@ -2019,7 +2021,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `state`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=<field1>,<field2>,...`",
|
||||
"description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. The following fields are valid:\n\n* `state`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=<field1>,<field2>,...`",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -2151,7 +2153,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190701",
|
||||
"revision": "20200408",
|
||||
"rootUrl": "https://classroom.googleapis.com/",
|
||||
"schemas": {
|
||||
"Announcement": {
|
||||
@@ -2195,7 +2197,7 @@
|
||||
},
|
||||
"individualStudentsOptions": {
|
||||
"$ref": "IndividualStudentsOptions",
|
||||
"description": "Identifiers of students with access to the announcement.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field will be able to see the announcement."
|
||||
"description": "Identifiers of students with access to the announcement.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field can see the announcement."
|
||||
},
|
||||
"materials": {
|
||||
"description": "Additional materials.\n\nAnnouncements must have no more than 20 material items.",
|
||||
@@ -2253,7 +2255,7 @@
|
||||
"id": "AssignmentSubmission",
|
||||
"properties": {
|
||||
"attachments": {
|
||||
"description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (e.g. title) may not be.",
|
||||
"description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (for example, title) may not be.",
|
||||
"items": {
|
||||
"$ref": "Attachment"
|
||||
},
|
||||
@@ -2486,7 +2488,7 @@
|
||||
"description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
|
||||
},
|
||||
"associatedWithDeveloper": {
|
||||
"description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
|
||||
"description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee CreateCourseWork for more\ndetails.\n\nRead-only.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"courseId": {
|
||||
@@ -2520,7 +2522,7 @@
|
||||
},
|
||||
"individualStudentsOptions": {
|
||||
"$ref": "IndividualStudentsOptions",
|
||||
"description": "Identifiers of students with access to the coursework.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field will be assigned the coursework."
|
||||
"description": "Identifiers of students with access to the coursework.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field are assigned the coursework."
|
||||
},
|
||||
"materials": {
|
||||
"description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
|
||||
@@ -3142,7 +3144,7 @@
|
||||
},
|
||||
"link": {
|
||||
"$ref": "Link",
|
||||
"description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response."
|
||||
"description": "Link material. On creation, this is upgraded to a more appropriate type\nif possible, and this is reflected in the response."
|
||||
},
|
||||
"youtubeVideo": {
|
||||
"$ref": "YouTubeVideo",
|
||||
@@ -3156,7 +3158,7 @@
|
||||
"id": "ModifyAnnouncementAssigneesRequest",
|
||||
"properties": {
|
||||
"assigneeMode": {
|
||||
"description": "Mode of the announcement describing whether it will be accessible by all\nstudents or specified individual students.",
|
||||
"description": "Mode of the announcement describing whether it is accessible by all\nstudents or specified individual students.",
|
||||
"enum": [
|
||||
"ASSIGNEE_MODE_UNSPECIFIED",
|
||||
"ALL_STUDENTS",
|
||||
@@ -3220,14 +3222,14 @@
|
||||
"id": "ModifyIndividualStudentsOptions",
|
||||
"properties": {
|
||||
"addStudentIds": {
|
||||
"description": "Ids of students to be added as having access to this\ncoursework/announcement.",
|
||||
"description": "IDs of students to be added as having access to this\ncoursework/announcement.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"removeStudentIds": {
|
||||
"description": "Ids of students to be removed from having access to this\ncoursework/announcement.",
|
||||
"description": "IDs of students to be removed from having access to this\ncoursework/announcement.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -3359,7 +3361,7 @@
|
||||
"id": "StateHistory",
|
||||
"properties": {
|
||||
"actorUserId": {
|
||||
"description": "The teacher or student who made the change",
|
||||
"description": "The teacher or student who made the change.",
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
@@ -3422,16 +3424,16 @@
|
||||
"type": "string"
|
||||
},
|
||||
"assignedGrade": {
|
||||
"description": "Optional grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis may be modified only by course teachers.",
|
||||
"description": "Optional grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (that is, non-integer) values are\nallowed, but are rounded to two decimal places.\n\nThis may be modified only by course teachers.",
|
||||
"format": "double",
|
||||
"type": "number"
|
||||
},
|
||||
"assignmentSubmission": {
|
||||
"$ref": "AssignmentSubmission",
|
||||
"description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\ngoogle.classroom.Work.ModifyAttachments."
|
||||
"description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\nModifyAttachments."
|
||||
},
|
||||
"associatedWithDeveloper": {
|
||||
"description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
|
||||
"description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee CreateCourseWork for more\ndetails.\n\nRead-only.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"courseId": {
|
||||
@@ -3464,7 +3466,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"draftGrade": {
|
||||
"description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.",
|
||||
"description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (that is, non-integer) values are\nallowed, but are rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.",
|
||||
"format": "double",
|
||||
"type": "number"
|
||||
},
|
||||
@@ -3593,7 +3595,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the topic, generated by the user.\nLeading and trailing whitespaces, if any, will be trimmed. Also, multiple\nconsecutive whitespaces will be collapsed into one inside the name. The\nresult must be a non-empty string. Topic names are case sensitive, and must\nbe no longer than 100 characters.",
|
||||
"description": "The name of the topic, generated by the user.\nLeading and trailing whitespaces, if any, are trimmed. Also, multiple\nconsecutive whitespaces are collapsed into one inside the name. The\nresult must be a non-empty string. Topic names are case sensitive, and must\nbe no longer than 100 characters.",
|
||||
"type": "string"
|
||||
},
|
||||
"topicId": {
|
||||
@@ -3642,7 +3644,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"verifiedTeacher": {
|
||||
"description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only",
|
||||
"description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field is always false.\n\nRead-only",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
"canonicalName": "Cloud Asset",
|
||||
"description": "The cloud asset API manages the history and inventory of cloud resources.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/quickstart-cloud-asset-inventory",
|
||||
"documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudasset:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudasset.mtls.googleapis.com/",
|
||||
"name": "cloudasset",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -104,6 +105,141 @@
|
||||
},
|
||||
"protocol": "rest",
|
||||
"resources": {
|
||||
"feeds": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates a feed in a parent project/folder/organization to listen to its\nasset updates.",
|
||||
"flatPath": "v1/{v1Id}/{v1Id1}/feeds",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudasset.feeds.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. The name of the project/folder/organization where this feed\nshould be created in. It can only be an organization number (such as\n\"organizations/123\"), a folder number (such as \"folders/123\"), a project ID\n(such as \"projects/my-project-id\")\", or a project number (such as\n\"projects/12345\").",
|
||||
"location": "path",
|
||||
"pattern": "^[^/]+/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/feeds",
|
||||
"request": {
|
||||
"$ref": "CreateFeedRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Feed"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes an asset feed.",
|
||||
"flatPath": "v1/{v1Id}/{v1Id1}/feeds/{feedsId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "cloudasset.feeds.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The name of the feed and it must be in the format of:\nprojects/project_number/feeds/feed_id\nfolders/folder_number/feeds/feed_id\norganizations/organization_number/feeds/feed_id",
|
||||
"location": "path",
|
||||
"pattern": "^[^/]+/[^/]+/feeds/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Gets details about an asset feed.",
|
||||
"flatPath": "v1/{v1Id}/{v1Id1}/feeds/{feedsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "cloudasset.feeds.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The name of the Feed and it must be in the format of:\nprojects/project_number/feeds/feed_id\nfolders/folder_number/feeds/feed_id\norganizations/organization_number/feeds/feed_id",
|
||||
"location": "path",
|
||||
"pattern": "^[^/]+/[^/]+/feeds/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Feed"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Lists all asset feeds in a parent project/folder/organization.",
|
||||
"flatPath": "v1/{v1Id}/{v1Id1}/feeds",
|
||||
"httpMethod": "GET",
|
||||
"id": "cloudasset.feeds.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. The parent project/folder/organization whose feeds are to be\nlisted. It can only be using project/folder/organization number (such as\n\"folders/12345\")\", or a project ID (such as \"projects/my-project-id\").",
|
||||
"location": "path",
|
||||
"pattern": "^[^/]+/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/feeds",
|
||||
"response": {
|
||||
"$ref": "ListFeedsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates an asset feed configuration.",
|
||||
"flatPath": "v1/{v1Id}/{v1Id1}/feeds/{feedsId}",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "cloudasset.feeds.patch",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The format will be\nprojects/{project_number}/feeds/{client-assigned_feed_identifier} or\nfolders/{folder_number}/feeds/{client-assigned_feed_identifier} or\norganizations/{organization_number}/feeds/{client-assigned_feed_identifier}\n\nThe client-assigned feed identifier must be unique within the parent\nproject/folder/organization.",
|
||||
"location": "path",
|
||||
"pattern": "^[^/]+/[^/]+/feeds/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"request": {
|
||||
"$ref": "UpdateFeedRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "Feed"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"operations": {
|
||||
"methods": {
|
||||
"get": {
|
||||
@@ -118,7 +254,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^[^/]+/[^/]+/operations/[^/]+/.+$",
|
||||
"pattern": "^[^/]+/[^/]+/operations/[^/]+/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -145,17 +281,19 @@
|
||||
],
|
||||
"parameters": {
|
||||
"assetNames": {
|
||||
"description": "A list of the full names of the assets. For example:\n`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.\nSee [Resource\nNames](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nand [Resource Name\nFormat](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/resource-name-format)\nfor more info.\n\nThe request becomes a no-op if the asset name list is empty, and the max\nsize of the asset name list is 100 in one request.",
|
||||
"description": "A list of the full names of the assets. For example:\n`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.\nSee [Resource\nNames](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nand [Resource Name\nFormat](https://cloud.google.com/asset-inventory/docs/resource-name-format)\nfor more info.\n\nThe request becomes a no-op if the asset name list is empty, and the max\nsize of the asset name list is 100 in one request.",
|
||||
"location": "query",
|
||||
"repeated": true,
|
||||
"type": "string"
|
||||
},
|
||||
"contentType": {
|
||||
"description": "Required. The content type.",
|
||||
"description": "Optional. The content type.",
|
||||
"enum": [
|
||||
"CONTENT_TYPE_UNSPECIFIED",
|
||||
"RESOURCE",
|
||||
"IAM_POLICY"
|
||||
"IAM_POLICY",
|
||||
"ORG_POLICY",
|
||||
"ACCESS_POLICY"
|
||||
],
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -168,7 +306,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"readTimeWindow.endTime": {
|
||||
"description": "End time of the time window (inclusive).\nCurrent timestamp if not specified.",
|
||||
"description": "End time of the time window (inclusive). If not specified, the current\ntimestamp is used instead.",
|
||||
"format": "google-datetime",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -219,27 +357,40 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190625",
|
||||
"revision": "20200403",
|
||||
"rootUrl": "https://cloudasset.googleapis.com/",
|
||||
"schemas": {
|
||||
"Asset": {
|
||||
"description": "Cloud asset. This includes all Google Cloud Platform resources,\nCloud IAM policies, and other non-GCP assets.",
|
||||
"description": "An asset in Google Cloud. An asset can be any resource in the Google Cloud\n[resource\nhierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),\na resource outside the Google Cloud resource hierarchy (such as Google\nKubernetes Engine clusters and objects), or a Cloud IAM policy.",
|
||||
"id": "Asset",
|
||||
"properties": {
|
||||
"accessLevel": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1AccessLevel"
|
||||
},
|
||||
"accessPolicy": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1AccessPolicy"
|
||||
},
|
||||
"ancestors": {
|
||||
"description": "The ancestry path of an asset in Google Cloud [resource\nhierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),\nrepresented as a list of relative resource names. An ancestry path starts\nwith the closest ancestor in the hierarchy and ends at root. If the asset\nis a project, folder, or organization, the ancestry path starts from the\nasset itself.\n\nFor example: `[\"projects/123456789\", \"folders/5432\", \"organizations/1234\"]`",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"assetType": {
|
||||
"description": "Type of the asset. Example: \"compute.googleapis.com/Disk\".",
|
||||
"description": "The type of the asset. For example: \"compute.googleapis.com/Disk\"\n\nSee [Supported asset\ntypes](https://cloud.google.com/asset-inventory/docs/supported-asset-types)\nfor more information.",
|
||||
"type": "string"
|
||||
},
|
||||
"iamPolicy": {
|
||||
"$ref": "Policy",
|
||||
"description": "Representation of the actual Cloud IAM policy set on a cloud resource. For\neach resource, there must be at most one Cloud IAM policy set on it."
|
||||
"description": "A representation of the Cloud IAM policy set on a Google Cloud resource.\nThere can be a maximum of one Cloud IAM policy set on any given resource.\nIn addition, Cloud IAM policies inherit their granted access scope from any\npolicies set on parent resources in the resource hierarchy. Therefore, the\neffectively policy is the union of both the policy set on this resource\nand each policy set on all of the resource's ancestry resource levels in\nthe hierarchy. See\n[this topic](https://cloud.google.com/iam/docs/policies#inheritance) for\nmore information."
|
||||
},
|
||||
"name": {
|
||||
"description": "The full name of the asset. For example:\n`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.\nSee [Resource\nNames](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more information.",
|
||||
"description": "The full name of the asset. For example:\n\"//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1\"\n\nSee [Resource\nnames](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more information.",
|
||||
"type": "string"
|
||||
},
|
||||
"orgPolicy": {
|
||||
"description": "Representation of the Cloud Organization Policy set on an asset. For each\nasset, there could be multiple Organization policies with different\nconstraints.",
|
||||
"description": "A representation of an [organization\npolicy](https://cloud.google.com/resource-manager/docs/organization-policy/overview#organization_policy).\nThere can be more than one organization policy with different constraints\nset on a given resource.",
|
||||
"items": {
|
||||
"$ref": "GoogleCloudOrgpolicyV1Policy"
|
||||
},
|
||||
@@ -247,13 +398,16 @@
|
||||
},
|
||||
"resource": {
|
||||
"$ref": "Resource",
|
||||
"description": "Representation of the resource."
|
||||
"description": "A representation of the resource."
|
||||
},
|
||||
"servicePerimeter": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1ServicePerimeter"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -271,7 +425,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -314,6 +468,25 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"BigQueryDestination": {
|
||||
"description": "A BigQuery destination.",
|
||||
"id": "BigQueryDestination",
|
||||
"properties": {
|
||||
"dataset": {
|
||||
"description": "Required. The BigQuery dataset in format\n\"projects/projectId/datasets/datasetId\", to which the snapshot result\nshould be exported. If this dataset does not exist, the export call returns\nan INVALID_ARGUMENT error.",
|
||||
"type": "string"
|
||||
},
|
||||
"force": {
|
||||
"description": "If the destination table already exists and this flag is `TRUE`, the\ntable will be overwritten by the contents of assets snapshot. If the flag\nis `FALSE` or unset and the destination table already exists, the export\ncall returns an INVALID_ARGUMEMT error.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"table": {
|
||||
"description": "Required. The BigQuery table to which the snapshot result should be\nwritten. If this table does not exist, a new table with the given name\nwill be created.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Binding": {
|
||||
"description": "Associates `members` with a `role`.",
|
||||
"id": "Binding",
|
||||
@@ -323,7 +496,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -336,12 +509,33 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CreateFeedRequest": {
|
||||
"description": "Create asset feed request.",
|
||||
"id": "CreateFeedRequest",
|
||||
"properties": {
|
||||
"feed": {
|
||||
"$ref": "Feed",
|
||||
"description": "Required. The feed details. The field `name` must be empty and it will be generated\nin the format of:\nprojects/project_number/feeds/feed_id\nfolders/folder_number/feeds/feed_id\norganizations/organization_number/feeds/feed_id"
|
||||
},
|
||||
"feedId": {
|
||||
"description": "Required. This is the client-assigned asset feed identifier and it needs to\nbe unique under a specific parent project/folder/organization.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"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"
|
||||
},
|
||||
"ExportAssetsRequest": {
|
||||
"description": "Export asset request.",
|
||||
"id": "ExportAssetsRequest",
|
||||
"properties": {
|
||||
"assetTypes": {
|
||||
"description": "A list of asset types of which to take a snapshot for. For example:\n\"compute.googleapis.com/Disk\". If specified, only matching assets will be\nreturned. See [Introduction to Cloud Asset\nInventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)\nfor all supported asset types.",
|
||||
"description": "A list of asset types of which to take a snapshot for. For example:\n\"compute.googleapis.com/Disk\". If specified, only matching assets will be\nreturned. See [Introduction to Cloud Asset\nInventory](https://cloud.google.com/asset-inventory/docs/overview)\nfor all supported asset types.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -352,12 +546,16 @@
|
||||
"enum": [
|
||||
"CONTENT_TYPE_UNSPECIFIED",
|
||||
"RESOURCE",
|
||||
"IAM_POLICY"
|
||||
"IAM_POLICY",
|
||||
"ORG_POLICY",
|
||||
"ACCESS_POLICY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified content type.",
|
||||
"Resource metadata.",
|
||||
"The actual IAM policy set on a resource."
|
||||
"The actual IAM policy set on a resource.",
|
||||
"The Cloud Organization Policy set on an asset.",
|
||||
"The Cloud Access context mananger Policy set on an asset."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -366,7 +564,7 @@
|
||||
"description": "Required. Output configuration indicating where the results will be output\nto. All results will be in newline delimited JSON format."
|
||||
},
|
||||
"readTime": {
|
||||
"description": "Timestamp to take an asset snapshot. This can only be set to a timestamp\nbetween 2018-10-02 UTC (inclusive) and the current time. If not specified,\nthe current time will be used. Due to delays in resource data collection\nand indexing, there is a volatile window during which running the same\nquery may get different results.",
|
||||
"description": "Timestamp to take an asset snapshot. This can only be set to a timestamp\nbetween the current time and the current time minus 35 days (inclusive).\nIf not specified, the current time will be used. Due to delays in resource\ndata collection and indexing, there is a volatile window during which\nrunning the same query may get different results.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -374,28 +572,86 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Feed": {
|
||||
"description": "An asset feed used to export asset updates to a destinations.\nAn asset feed filter controls what updates are exported.\nThe asset feed must be created within a project, organization, or\nfolder. Supported destinations are:\nPub/Sub topics.",
|
||||
"id": "Feed",
|
||||
"properties": {
|
||||
"assetNames": {
|
||||
"description": "A list of the full names of the assets to receive updates. You must specify\neither or both of asset_names and asset_types. Only asset updates matching\nspecified asset_names and asset_types are exported to the feed. For\nexample:\n`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.\nSee [Resource\nNames](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more info.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"assetTypes": {
|
||||
"description": "A list of types of the assets to receive updates. You must specify either\nor both of asset_names and asset_types. Only asset updates matching\nspecified asset_names and asset_types are exported to the feed.\nFor example: `\"compute.googleapis.com/Disk\"`\n\nSee [this\ntopic](https://cloud.google.com/asset-inventory/docs/supported-asset-types)\nfor a list of all supported asset types.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"contentType": {
|
||||
"description": "Asset content type. If not specified, no content but the asset name and\ntype will be returned.",
|
||||
"enum": [
|
||||
"CONTENT_TYPE_UNSPECIFIED",
|
||||
"RESOURCE",
|
||||
"IAM_POLICY",
|
||||
"ORG_POLICY",
|
||||
"ACCESS_POLICY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified content type.",
|
||||
"Resource metadata.",
|
||||
"The actual IAM policy set on a resource.",
|
||||
"The Cloud Organization Policy set on an asset.",
|
||||
"The Cloud Access context mananger Policy set on an asset."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"feedOutputConfig": {
|
||||
"$ref": "FeedOutputConfig",
|
||||
"description": "Required. Feed output configuration defining where the asset updates are\npublished to."
|
||||
},
|
||||
"name": {
|
||||
"description": "Required. The format will be\nprojects/{project_number}/feeds/{client-assigned_feed_identifier} or\nfolders/{folder_number}/feeds/{client-assigned_feed_identifier} or\norganizations/{organization_number}/feeds/{client-assigned_feed_identifier}\n\nThe client-assigned feed identifier must be unique within the parent\nproject/folder/organization.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"FeedOutputConfig": {
|
||||
"description": "Output configuration for asset feed destination.",
|
||||
"id": "FeedOutputConfig",
|
||||
"properties": {
|
||||
"pubsubDestination": {
|
||||
"$ref": "PubsubDestination",
|
||||
"description": "Destination on Pub/Sub."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GcsDestination": {
|
||||
"description": "A Cloud Storage location.",
|
||||
"id": "GcsDestination",
|
||||
@@ -423,7 +679,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleCloudOrgpolicyV1ListPolicy": {
|
||||
"description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\n`ListPolicy` can define specific values and subtrees of Cloud Resource\nManager resource hierarchy (`Organizations`, `Folders`, `Projects`) that\nare allowed or denied by setting the `allowed_values` and `denied_values`\nfields. This is achieved by using the `under:` and optional `is:` prefixes.\nThe `under:` prefix is used to denote resource subtree values.\nThe `is:` prefix is used to denote specific values, and is required only\nif the value contains a \":\". Values prefixed with \"is:\" are treated the\nsame as values with no prefix.\nAncestry subtrees must be in one of the following formats:\n - \u201cprojects/<project-id>\u201d, e.g. \u201cprojects/tokyo-rain-123\u201d\n - \u201cfolders/<folder-id>\u201d, e.g. \u201cfolders/1234\u201d\n - \u201corganizations/<organization-id>\u201d, e.g. \u201corganizations/1234\u201d\nThe `supports_under` field of the associated `Constraint` defines whether\nancestry prefixes can be used. You can set `allowed_values` and\n`denied_values` in the same `Policy` if `all_values` is\n`ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all\nvalues. If `all_values` is set to either `ALLOW` or `DENY`,\n`allowed_values` and `denied_values` must be unset.",
|
||||
"description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\n`ListPolicy` can define specific values and subtrees of Cloud Resource\nManager resource hierarchy (`Organizations`, `Folders`, `Projects`) that\nare allowed or denied by setting the `allowed_values` and `denied_values`\nfields. This is achieved by using the `under:` and optional `is:` prefixes.\nThe `under:` prefix is used to denote resource subtree values.\nThe `is:` prefix is used to denote specific values, and is required only\nif the value contains a \":\". Values prefixed with \"is:\" are treated the\nsame as values with no prefix.\nAncestry subtrees must be in one of the following formats:\n - \"projects/<project-id>\", e.g. \"projects/tokyo-rain-123\"\n - \"folders/<folder-id>\", e.g. \"folders/1234\"\n - \"organizations/<organization-id>\", e.g. \"organizations/1234\"\nThe `supports_under` field of the associated `Constraint` defines whether\nancestry prefixes can be used. You can set `allowed_values` and\n`denied_values` in the same `Policy` if `all_values` is\n`ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all\nvalues. If `all_values` is set to either `ALLOW` or `DENY`,\n`allowed_values` and `denied_values` must be unset.",
|
||||
"id": "GoogleCloudOrgpolicyV1ListPolicy",
|
||||
"properties": {
|
||||
"allValues": {
|
||||
@@ -455,7 +711,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"inheritFromParent": {
|
||||
"description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings for\n`projects/bar` parented by `organizations/foo`:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \u201cE1\u201d allowed_values:\u201dE2\u201d}\n `projects/bar` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \u201cE1\u201d allowed_values:\u201dE2\u201d}\n `projects/bar` has a `Policy` with values:\n {value: \u201cE3\u201d value: \u201dE4\u201d inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \u201cE1\u201d allowed_values:\u201dE2\u201d}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \u201cE1\u201d allowed_values: \u201dE2\u201d}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \u201cE1\u201d allowed_values: \u201dE2\u201d}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.\n\nExample 10 (allowed and denied subtrees of Resource Manager hierarchy):\nGiven the following resource hierarchy\n O1->{F1, F2}; F1->{P1}; F2->{P2, P3},\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"under:organizations/O1\"}\n `projects/bar` has a `Policy` with:\n {allowed_values: \"under:projects/P3\"}\n {denied_values: \"under:folders/F2\"}\nThe accepted values at `organizations/foo` are `organizations/O1`,\n `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`,\n `projects/P3`.\nThe accepted values at `projects/bar` are `organizations/O1`,\n `folders/F1`, `projects/P1`.",
|
||||
"description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings for\n`projects/bar` parented by `organizations/foo`:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values:\"E2\"}\n `projects/bar` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values:\"E2\"}\n `projects/bar` has a `Policy` with values:\n {value: \"E3\" value: \"E4\" inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values:\"E2\"}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.\n\nExample 10 (allowed and denied subtrees of Resource Manager hierarchy):\nGiven the following resource hierarchy\n O1->{F1, F2}; F1->{P1}; F2->{P2, P3},\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"under:organizations/O1\"}\n `projects/bar` has a `Policy` with:\n {allowed_values: \"under:projects/P3\"}\n {denied_values: \"under:folders/F2\"}\nThe accepted values at `organizations/foo` are `organizations/O1`,\n `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`,\n `projects/P3`.\nThe accepted values at `projects/bar` are `organizations/O1`,\n `folders/F1`, `projects/P1`.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"suggestedValue": {
|
||||
@@ -509,6 +765,343 @@
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIdentityAccesscontextmanagerV1AccessLevel": {
|
||||
"description": "An `AccessLevel` is a label that can be applied to requests to Google Cloud\nservices, along with a list of requirements necessary for the label to be\napplied.",
|
||||
"id": "GoogleIdentityAccesscontextmanagerV1AccessLevel",
|
||||
"properties": {
|
||||
"basic": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1BasicLevel",
|
||||
"description": "A `BasicLevel` composed of `Conditions`."
|
||||
},
|
||||
"custom": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1CustomLevel",
|
||||
"description": "A `CustomLevel` written in the Common Expression Language."
|
||||
},
|
||||
"description": {
|
||||
"description": "Description of the `AccessLevel` and its use. Does not affect behavior.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Required. Resource name for the Access Level. The `short_name` component\nmust begin with a letter and only include alphanumeric and '_'. Format:\n`accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length\nof the `short_name` component is 50 characters.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "Human readable title. Must be unique within the Policy.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIdentityAccesscontextmanagerV1AccessPolicy": {
|
||||
"description": "`AccessPolicy` is a container for `AccessLevels` (which define the necessary\nattributes to use Google Cloud services) and `ServicePerimeters` (which\ndefine regions of services able to freely pass data within a perimeter). An\naccess policy is globally visible within an organization, and the\nrestrictions it specifies apply to all projects within an organization.",
|
||||
"id": "GoogleIdentityAccesscontextmanagerV1AccessPolicy",
|
||||
"properties": {
|
||||
"etag": {
|
||||
"description": "Output only. An opaque identifier for the current version of the\n`AccessPolicy`. This will always be a strongly validated etag, meaning that\ntwo Access Polices will be identical if and only if their etags are\nidentical. Clients should not expect this to be in any specific format.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output only. Resource name of the `AccessPolicy`. Format:\n`accessPolicies/{policy_id}`",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. The parent of this `AccessPolicy` in the Cloud Resource\nHierarchy. Currently immutable once created. Format:\n`organizations/{organization_id}`",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "Required. Human readable title. Does not affect behavior.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIdentityAccesscontextmanagerV1BasicLevel": {
|
||||
"description": "`BasicLevel` is an `AccessLevel` using a set of recommended features.",
|
||||
"id": "GoogleIdentityAccesscontextmanagerV1BasicLevel",
|
||||
"properties": {
|
||||
"combiningFunction": {
|
||||
"description": "How the `conditions` list should be combined to determine if a request is\ngranted this `AccessLevel`. If AND is used, each `Condition` in\n`conditions` must be satisfied for the `AccessLevel` to be applied. If OR\nis used, at least one `Condition` in `conditions` must be satisfied for the\n`AccessLevel` to be applied. Default behavior is AND.",
|
||||
"enum": [
|
||||
"AND",
|
||||
"OR"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"All `Conditions` must be true for the `BasicLevel` to be true.",
|
||||
"If at least one `Condition` is true, then the `BasicLevel` is true."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"conditions": {
|
||||
"description": "Required. A list of requirements for the `AccessLevel` to be granted.",
|
||||
"items": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1Condition"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIdentityAccesscontextmanagerV1Condition": {
|
||||
"description": "A condition necessary for an `AccessLevel` to be granted. The Condition is an\nAND over its fields. So a Condition is true if: 1) the request IP is from one\nof the listed subnetworks AND 2) the originating device complies with the\nlisted device policy AND 3) all listed access levels are granted AND 4) the\nrequest was sent at a time allowed by the DateTimeRestriction.",
|
||||
"id": "GoogleIdentityAccesscontextmanagerV1Condition",
|
||||
"properties": {
|
||||
"devicePolicy": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1DevicePolicy",
|
||||
"description": "Device specific restrictions, all restrictions must hold for the\nCondition to be true. If not specified, all devices are allowed."
|
||||
},
|
||||
"ipSubnetworks": {
|
||||
"description": "CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for\na CIDR IP address block, the specified IP address portion must be properly\ntruncated (i.e. all the host bits must be zero) or the input is considered\nmalformed. For example, \"192.0.2.0/24\" is accepted but \"192.0.2.1/24\" is\nnot. Similarly, for IPv6, \"2001:db8::/32\" is accepted whereas\n\"2001:db8::1/32\" is not. The originating IP of a request must be in one of\nthe listed subnets in order for this Condition to be true. If empty, all IP\naddresses are allowed.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"members": {
|
||||
"description": "The request must be made by one of the provided user or service\naccounts. Groups are not supported.\nSyntax:\n`user:{emailid}`\n`serviceAccount:{emailid}`\nIf not specified, a request may come from any user.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"negate": {
|
||||
"description": "Whether to negate the Condition. If true, the Condition becomes a NAND over\nits non-empty fields, each field must be false for the Condition overall to\nbe satisfied. Defaults to false.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"regions": {
|
||||
"description": "The request must originate from one of the provided countries/regions.\nMust be valid ISO 3166-1 alpha-2 codes.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"requiredAccessLevels": {
|
||||
"description": "A list of other access levels defined in the same `Policy`, referenced by\nresource name. Referencing an `AccessLevel` which does not exist is an\nerror. All access levels listed must be granted for the Condition\nto be true. Example:\n\"`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME\"`",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIdentityAccesscontextmanagerV1CustomLevel": {
|
||||
"description": "`CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language\nto represent the necessary conditions for the level to apply to a request.\nSee CEL spec at: https://github.com/google/cel-spec",
|
||||
"id": "GoogleIdentityAccesscontextmanagerV1CustomLevel",
|
||||
"properties": {
|
||||
"expr": {
|
||||
"$ref": "Expr",
|
||||
"description": "Required. A Cloud CEL expression evaluating to a boolean."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIdentityAccesscontextmanagerV1DevicePolicy": {
|
||||
"description": "`DevicePolicy` specifies device specific restrictions necessary to acquire a\ngiven access level. A `DevicePolicy` specifies requirements for requests from\ndevices to be granted access levels, it does not do any enforcement on the\ndevice. `DevicePolicy` acts as an AND over all specified fields, and each\nrepeated field is an OR over its elements. Any unset fields are ignored. For\nexample, if the proto is { os_type : DESKTOP_WINDOWS, os_type :\nDESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be\ntrue for requests originating from encrypted Linux desktops and encrypted\nWindows desktops.",
|
||||
"id": "GoogleIdentityAccesscontextmanagerV1DevicePolicy",
|
||||
"properties": {
|
||||
"allowedDeviceManagementLevels": {
|
||||
"description": "Allowed device management levels, an empty list allows all management\nlevels.",
|
||||
"enumDescriptions": [
|
||||
"The device's management level is not specified or not known.",
|
||||
"The device is not managed.",
|
||||
"Basic management is enabled, which is generally limited to monitoring and\nwiping the corporate account.",
|
||||
"Complete device management. This includes more thorough monitoring and the\nability to directly manage the device (such as remote wiping). This can be\nenabled through the Android Enterprise Platform."
|
||||
],
|
||||
"items": {
|
||||
"enum": [
|
||||
"MANAGEMENT_UNSPECIFIED",
|
||||
"NONE",
|
||||
"BASIC",
|
||||
"COMPLETE"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"allowedEncryptionStatuses": {
|
||||
"description": "Allowed encryptions statuses, an empty list allows all statuses.",
|
||||
"enumDescriptions": [
|
||||
"The encryption status of the device is not specified or not known.",
|
||||
"The device does not support encryption.",
|
||||
"The device supports encryption, but is currently unencrypted.",
|
||||
"The device is encrypted."
|
||||
],
|
||||
"items": {
|
||||
"enum": [
|
||||
"ENCRYPTION_UNSPECIFIED",
|
||||
"ENCRYPTION_UNSUPPORTED",
|
||||
"UNENCRYPTED",
|
||||
"ENCRYPTED"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"osConstraints": {
|
||||
"description": "Allowed OS versions, an empty list allows all types and all versions.",
|
||||
"items": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1OsConstraint"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"requireAdminApproval": {
|
||||
"description": "Whether the device needs to be approved by the customer admin.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"requireCorpOwned": {
|
||||
"description": "Whether the device needs to be corp owned.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"requireScreenlock": {
|
||||
"description": "Whether or not screenlock is required for the DevicePolicy to be true.\nDefaults to `false`.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIdentityAccesscontextmanagerV1OsConstraint": {
|
||||
"description": "A restriction on the OS type and version of devices making requests.",
|
||||
"id": "GoogleIdentityAccesscontextmanagerV1OsConstraint",
|
||||
"properties": {
|
||||
"minimumVersion": {
|
||||
"description": "The minimum allowed OS version. If not set, any version of this OS\nsatisfies the constraint. Format: `\"major.minor.patch\"`.\nExamples: `\"10.5.301\"`, `\"9.2.1\"`.",
|
||||
"type": "string"
|
||||
},
|
||||
"osType": {
|
||||
"description": "Required. The allowed OS type.",
|
||||
"enum": [
|
||||
"OS_UNSPECIFIED",
|
||||
"DESKTOP_MAC",
|
||||
"DESKTOP_WINDOWS",
|
||||
"DESKTOP_LINUX",
|
||||
"DESKTOP_CHROME_OS",
|
||||
"ANDROID",
|
||||
"IOS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The operating system of the device is not specified or not known.",
|
||||
"A desktop Mac operating system.",
|
||||
"A desktop Windows operating system.",
|
||||
"A desktop Linux operating system.",
|
||||
"A desktop ChromeOS operating system.",
|
||||
"An Android operating system.",
|
||||
"An iOS operating system."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"requireVerifiedChromeOs": {
|
||||
"description": "Only allows requests from devices with a verified Chrome OS.\nVerifications includes requirements that the device is enterprise-managed,\nconformant to domain policies, and the caller has permission to call\nthe API targeted by the request.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIdentityAccesscontextmanagerV1ServicePerimeter": {
|
||||
"description": "`ServicePerimeter` describes a set of Google Cloud resources which can freely\nimport and export data amongst themselves, but not export outside of the\n`ServicePerimeter`. If a request with a source within this `ServicePerimeter`\nhas a target outside of the `ServicePerimeter`, the request will be blocked.\nOtherwise the request is allowed. There are two types of Service Perimeter -\nRegular and Bridge. Regular Service Perimeters cannot overlap, a single\nGoogle Cloud project can only belong to a single regular Service Perimeter.\nService Perimeter Bridges can contain only Google Cloud projects as members,\na single Google Cloud project may belong to multiple Service Perimeter\nBridges.",
|
||||
"id": "GoogleIdentityAccesscontextmanagerV1ServicePerimeter",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "Description of the `ServicePerimeter` and its use. Does not affect\nbehavior.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Required. Resource name for the ServicePerimeter. The `short_name`\ncomponent must begin with a letter and only include alphanumeric and '_'.\nFormat: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`",
|
||||
"type": "string"
|
||||
},
|
||||
"perimeterType": {
|
||||
"description": "Perimeter type indicator. A single project is\nallowed to be a member of single regular perimeter, but multiple service\nperimeter bridges. A project cannot be a included in a perimeter bridge\nwithout being included in regular perimeter. For perimeter bridges,\nthe restricted service list as well as access level lists must be\nempty.",
|
||||
"enum": [
|
||||
"PERIMETER_TYPE_REGULAR",
|
||||
"PERIMETER_TYPE_BRIDGE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Regular Perimeter.",
|
||||
"Perimeter Bridge."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"spec": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig",
|
||||
"description": "Proposed (or dry run) ServicePerimeter configuration. This configuration\nallows to specify and test ServicePerimeter configuration without enforcing\nactual access restrictions. Only allowed to be set when the\n\"use_explicit_dry_run_spec\" flag is set."
|
||||
},
|
||||
"status": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig",
|
||||
"description": "Current ServicePerimeter configuration. Specifies sets of resources,\nrestricted services and access levels that determine perimeter\ncontent and boundaries."
|
||||
},
|
||||
"title": {
|
||||
"description": "Human readable title. Must be unique within the Policy.",
|
||||
"type": "string"
|
||||
},
|
||||
"useExplicitDryRunSpec": {
|
||||
"description": "Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly\nexists for all Service Perimeters, and that spec is identical to the\nstatus for those Service Perimeters. When this flag is set, it inhibits the\ngeneration of the implicit spec, thereby allowing the user to explicitly\nprovide a configuration (\"spec\") to use in a dry-run version of the Service\nPerimeter. This allows the user to test changes to the enforced config\n(\"status\") without actually enforcing them. This testing is done through\nanalyzing the differences between currently enforced and suggested\nrestrictions. use_explicit_dry_run_spec must bet set to True if any of the\nfields in the spec are set to non-default values.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig": {
|
||||
"description": "`ServicePerimeterConfig` specifies a set of Google Cloud resources that\ndescribe specific Service Perimeter configuration.",
|
||||
"id": "GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig",
|
||||
"properties": {
|
||||
"accessLevels": {
|
||||
"description": "A list of `AccessLevel` resource names that allow resources within the\n`ServicePerimeter` to be accessed from the internet. `AccessLevels` listed\nmust be in the same policy as this `ServicePerimeter`. Referencing a\nnonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are\nlisted, resources within the perimeter can only be accessed via Google\nCloud calls with request origins within the perimeter. Example:\n`\"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL\"`.\nFor Service Perimeter Bridge, must be empty.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"resources": {
|
||||
"description": "A list of Google Cloud resources that are inside of the service perimeter.\nCurrently only projects are allowed. Format: `projects/{project_number}`",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"restrictedServices": {
|
||||
"description": "Google Cloud services that are subject to the Service Perimeter\nrestrictions. For example, if `storage.googleapis.com` is specified, access\nto the storage buckets inside the perimeter must meet the perimeter's\naccess restrictions.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"vpcAccessibleServices": {
|
||||
"$ref": "GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices",
|
||||
"description": "Configuration for APIs allowed within Perimeter."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices": {
|
||||
"description": "Specifies how APIs are allowed to communicate within the Service\nPerimeter.",
|
||||
"id": "GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices",
|
||||
"properties": {
|
||||
"allowedServices": {
|
||||
"description": "The list of APIs usable within the Service Perimeter. Must be empty\nunless 'enable_restriction' is True.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"enableRestriction": {
|
||||
"description": "Whether to restrict API calls within the Service Perimeter to the list of\nAPIs specified in 'allowed_services'.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListFeedsResponse": {
|
||||
"id": "ListFeedsResponse",
|
||||
"properties": {
|
||||
"feeds": {
|
||||
"description": "A list of feeds.",
|
||||
"items": {
|
||||
"$ref": "Feed"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Operation": {
|
||||
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
|
||||
"id": "Operation",
|
||||
@@ -548,6 +1141,10 @@
|
||||
"description": "Output configuration for export assets destination.",
|
||||
"id": "OutputConfig",
|
||||
"properties": {
|
||||
"bigqueryDestination": {
|
||||
"$ref": "BigQueryDestination",
|
||||
"description": "Destination on BigQuery. The output table stores the fields in asset\nproto as columns in BigQuery. The resource/iam_policy field is converted\nto a record with each field to a column, except metadata to a single JSON\nstring."
|
||||
},
|
||||
"gcsDestination": {
|
||||
"$ref": "GcsDestination",
|
||||
"description": "Destination on Cloud Storage."
|
||||
@@ -556,7 +1153,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -567,27 +1164,38 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PubsubDestination": {
|
||||
"description": "A Pub/Sub destination.",
|
||||
"id": "PubsubDestination",
|
||||
"properties": {
|
||||
"topic": {
|
||||
"description": "The name of the Pub/Sub topic to publish to.\nFor example: `projects/PROJECT_ID/topics/TOPIC_ID`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Resource": {
|
||||
"description": "Representation of a cloud resource.",
|
||||
"description": "A representation of a Google Cloud resource.",
|
||||
"id": "Resource",
|
||||
"properties": {
|
||||
"data": {
|
||||
@@ -595,27 +1203,27 @@
|
||||
"description": "Properties of the object.",
|
||||
"type": "any"
|
||||
},
|
||||
"description": "The content of the resource, in which some sensitive fields are scrubbed\naway and may not be present.",
|
||||
"description": "The content of the resource, in which some sensitive fields are removed\nand may not be present.",
|
||||
"type": "object"
|
||||
},
|
||||
"discoveryDocumentUri": {
|
||||
"description": "The URL of the discovery document containing the resource's JSON schema.\nFor example:\n`\"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest\"`.\nIt will be left unspecified for resources without a discovery-based API,\nsuch as Cloud Bigtable.",
|
||||
"description": "The URL of the discovery document containing the resource's JSON schema.\nFor example:\n\"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest\"\n\nThis value is unspecified for resources that do not have an API based on a\ndiscovery document, such as Cloud Bigtable.",
|
||||
"type": "string"
|
||||
},
|
||||
"discoveryName": {
|
||||
"description": "The JSON schema name listed in the discovery document.\nExample: \"Project\". It will be left unspecified for resources (such as\nCloud Bigtable) without a discovery-based API.",
|
||||
"description": "The JSON schema name listed in the discovery document. For example:\n\"Project\"\n\nThis value is unspecified for resources that do not have an API based on a\ndiscovery document, such as Cloud Bigtable.",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The full name of the immediate parent of this resource. See\n[Resource\nNames](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more information.\n\nFor GCP assets, it is the parent resource defined in the [Cloud IAM policy\nhierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).\nFor example:\n`\"//cloudresourcemanager.googleapis.com/projects/my_project_123\"`.\n\nFor third-party assets, it is up to the users to define.",
|
||||
"description": "The full name of the immediate parent of this resource. See\n[Resource\nNames](https://cloud.google.com/apis/design/resource_names#full_resource_name)\nfor more information.\n\nFor Google Cloud assets, this value is the parent resource defined in the\n[Cloud IAM policy\nhierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).\nFor example:\n\"//cloudresourcemanager.googleapis.com/projects/my_project_123\"\n\nFor third-party assets, this field may be set differently.",
|
||||
"type": "string"
|
||||
},
|
||||
"resourceUrl": {
|
||||
"description": "The REST URL for accessing the resource. An HTTP GET operation using this\nURL returns the resource itself.\nExample:\n`https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`.\nIt will be left unspecified for resources without a REST API.",
|
||||
"description": "The REST URL for accessing the resource. An HTTP `GET` request using this\nURL returns the resource itself. For example:\n\"https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123\"\n\nThis value is unspecified for resources without a REST API.",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "The API version. Example: \"v1\".",
|
||||
"description": "The API version. For example: \"v1\"",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -649,15 +1257,15 @@
|
||||
"type": "object"
|
||||
},
|
||||
"TemporalAsset": {
|
||||
"description": "Temporal asset. In addition to the asset, the temporal asset includes the\nstatus of the asset and valid from and to time of it.",
|
||||
"description": "An asset in Google Cloud and its temporal metadata, including the time window\nwhen it was observed and its status during that window.",
|
||||
"id": "TemporalAsset",
|
||||
"properties": {
|
||||
"asset": {
|
||||
"$ref": "Asset",
|
||||
"description": "Asset."
|
||||
"description": "An asset in Google Cloud."
|
||||
},
|
||||
"deleted": {
|
||||
"description": "If the asset is deleted or not.",
|
||||
"description": "Whether the asset has been deleted or not.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"window": {
|
||||
@@ -668,11 +1276,11 @@
|
||||
"type": "object"
|
||||
},
|
||||
"TimeWindow": {
|
||||
"description": "A time window of (start_time, end_time].",
|
||||
"description": "A time window specified by its \"start_time\" and \"end_time\".",
|
||||
"id": "TimeWindow",
|
||||
"properties": {
|
||||
"endTime": {
|
||||
"description": "End time of the time window (inclusive).\nCurrent timestamp if not specified.",
|
||||
"description": "End time of the time window (inclusive). If not specified, the current\ntimestamp is used instead.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -683,6 +1291,22 @@
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"UpdateFeedRequest": {
|
||||
"description": "Update asset feed request.",
|
||||
"id": "UpdateFeedRequest",
|
||||
"properties": {
|
||||
"feed": {
|
||||
"$ref": "Feed",
|
||||
"description": "Required. The new values of feed details. It must match an existing feed and the\nfield `name` must be in the format of:\nprojects/project_number/feeds/feed_id or\nfolders/folder_number/feeds/feed_id or\norganizations/organization_number/feeds/feed_id."
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Required. Only updates the `feed` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.",
|
||||
"format": "google-fieldmask",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
"canonicalName": "Cloud Asset",
|
||||
"description": "The cloud asset API manages the history and inventory of cloud resources.",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/quickstart-cloud-asset-inventory",
|
||||
"documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudasset:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudasset.mtls.googleapis.com/",
|
||||
"name": "cloudasset",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -150,7 +151,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+/operations/[^/]+/.+$",
|
||||
"pattern": "^folders/[^/]+/operations/[^/]+/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -185,7 +186,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"contentType": {
|
||||
"description": "Required. The content type.",
|
||||
"description": "Optional. The content type.",
|
||||
"enum": [
|
||||
"CONTENT_TYPE_UNSPECIFIED",
|
||||
"RESOURCE",
|
||||
@@ -266,7 +267,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^organizations/[^/]+/operations/[^/]+/.+$",
|
||||
"pattern": "^organizations/[^/]+/operations/[^/]+/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -301,7 +302,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"contentType": {
|
||||
"description": "Required. The content type.",
|
||||
"description": "Optional. The content type.",
|
||||
"enum": [
|
||||
"CONTENT_TYPE_UNSPECIFIED",
|
||||
"RESOURCE",
|
||||
@@ -382,7 +383,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/operations/[^/]+/.+$",
|
||||
"pattern": "^projects/[^/]+/operations/[^/]+/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -400,7 +401,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190625",
|
||||
"revision": "20200403",
|
||||
"rootUrl": "https://cloudasset.googleapis.com/",
|
||||
"schemas": {
|
||||
"Asset": {
|
||||
@@ -427,7 +428,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -445,7 +446,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -497,7 +498,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -548,23 +549,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -632,7 +633,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -643,19 +644,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudbilling:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudbilling.mtls.googleapis.com/",
|
||||
"name": "cloudbilling",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -134,7 +135,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the billing account to retrieve. For example,\n`billingAccounts/012345-567890-ABCDEF`.",
|
||||
"description": "Required. The resource name of the billing account to retrieve. For example,\n`billingAccounts/012345-567890-ABCDEF`.",
|
||||
"location": "path",
|
||||
"pattern": "^billingAccounts/[^/]+$",
|
||||
"required": true,
|
||||
@@ -158,6 +159,12 @@
|
||||
"resource"
|
||||
],
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
@@ -216,7 +223,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the billing account resource to be updated.",
|
||||
"description": "Required. The name of the billing account resource to be updated.",
|
||||
"location": "path",
|
||||
"pattern": "^billingAccounts/[^/]+$",
|
||||
"required": true,
|
||||
@@ -310,7 +317,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the billing account associated with the projects that\nyou want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
|
||||
"description": "Required. The resource name of the billing account associated with the projects that\nyou want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
|
||||
"location": "path",
|
||||
"pattern": "^billingAccounts/[^/]+$",
|
||||
"required": true,
|
||||
@@ -352,7 +359,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the project for which billing information is\nretrieved. For example, `projects/tokyo-rain-123`.",
|
||||
"description": "Required. The resource name of the project for which billing information is\nretrieved. For example, `projects/tokyo-rain-123`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -377,7 +384,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the project associated with the billing information\nthat you want to update. For example, `projects/tokyo-rain-123`.",
|
||||
"description": "Required. The resource name of the project associated with the billing information\nthat you want to update. For example, `projects/tokyo-rain-123`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -462,7 +469,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The name of the service.\nExample: \"services/DA34-426B-A397\"",
|
||||
"description": "Required. The name of the service.\nExample: \"services/DA34-426B-A397\"",
|
||||
"location": "path",
|
||||
"pattern": "^services/[^/]+$",
|
||||
"required": true,
|
||||
@@ -488,7 +495,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190617",
|
||||
"revision": "20200401",
|
||||
"rootUrl": "https://cloudbilling.googleapis.com/",
|
||||
"schemas": {
|
||||
"AggregationInfo": {
|
||||
@@ -530,7 +537,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -548,7 +555,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -594,7 +601,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"open": {
|
||||
"description": "True if the billing account is open, and will therefore be charged for any\nusage on associated projects. False if the billing account is closed, and\ntherefore projects associated with it will be unable to use paid services.",
|
||||
"description": "Output only. True if the billing account is open, and will therefore be charged for any\nusage on associated projects. False if the billing account is closed, and\ntherefore projects associated with it will be unable to use paid services.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
@@ -609,7 +616,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -646,23 +653,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -762,7 +769,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -773,19 +780,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudbuild:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudbuild.mtls.googleapis.com/",
|
||||
"name": "cloudbuild",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -118,7 +119,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource to be cancelled.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -146,7 +147,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -217,13 +218,13 @@
|
||||
],
|
||||
"parameters": {
|
||||
"id": {
|
||||
"description": "ID of the build.",
|
||||
"description": "Required. ID of the build.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "ID of the project.",
|
||||
"description": "Required. ID of the project.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -250,7 +251,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "ID of the project.",
|
||||
"description": "Required. ID of the project.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -278,13 +279,13 @@
|
||||
],
|
||||
"parameters": {
|
||||
"id": {
|
||||
"description": "ID of the build.",
|
||||
"description": "Required. ID of the build.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "ID of the project.",
|
||||
"description": "Required. ID of the project.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -324,7 +325,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "ID of the project.",
|
||||
"description": "Required. ID of the project.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -349,13 +350,13 @@
|
||||
],
|
||||
"parameters": {
|
||||
"id": {
|
||||
"description": "Build ID of the original build.",
|
||||
"description": "Required. Build ID of the original build.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "ID of the project.",
|
||||
"description": "Required. ID of the project.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -386,7 +387,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "ID of the project for which to configure automatic builds.",
|
||||
"description": "Required. ID of the project for which to configure automatic builds.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -414,13 +415,13 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "ID of the project that owns the trigger.",
|
||||
"description": "Required. ID of the project that owns the trigger.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"triggerId": {
|
||||
"description": "ID of the `BuildTrigger` to delete.",
|
||||
"description": "Required. ID of the `BuildTrigger` to delete.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -445,13 +446,13 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "ID of the project that owns the trigger.",
|
||||
"description": "Required. ID of the project that owns the trigger.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"triggerId": {
|
||||
"description": "ID of the `BuildTrigger` to get.",
|
||||
"description": "Required. Identifier (`id` or `name`) of the `BuildTrigger` to get.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -486,7 +487,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "ID of the project for which to list BuildTriggers.",
|
||||
"description": "Required. ID of the project for which to list BuildTriggers.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -511,13 +512,13 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "ID of the project that owns the trigger.",
|
||||
"description": "Required. ID of the project that owns the trigger.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"triggerId": {
|
||||
"description": "ID of the `BuildTrigger` to update.",
|
||||
"description": "Required. ID of the `BuildTrigger` to update.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -545,13 +546,13 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "ID of the project.",
|
||||
"description": "Required. ID of the project.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"triggerId": {
|
||||
"description": "ID of the trigger.",
|
||||
"description": "Required. ID of the trigger.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -573,7 +574,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190702",
|
||||
"revision": "20200323",
|
||||
"rootUrl": "https://cloudbuild.googleapis.com/",
|
||||
"schemas": {
|
||||
"ArtifactObjects": {
|
||||
@@ -683,6 +684,11 @@
|
||||
"description": "Output only. ID of the project.",
|
||||
"type": "string"
|
||||
},
|
||||
"queueTtl": {
|
||||
"description": "TTL in queue for this build. If provided and the build is enqueued longer\nthan this value, the build will expire and the build status will be\n`EXPIRED`.\n\nThe TTL starts ticking from create_time.",
|
||||
"format": "google-duration",
|
||||
"type": "string"
|
||||
},
|
||||
"results": {
|
||||
"$ref": "Results",
|
||||
"description": "Output only. Results of the build."
|
||||
@@ -717,7 +723,8 @@
|
||||
"FAILURE",
|
||||
"INTERNAL_ERROR",
|
||||
"TIMEOUT",
|
||||
"CANCELLED"
|
||||
"CANCELLED",
|
||||
"EXPIRED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Status of the build is unknown.",
|
||||
@@ -727,7 +734,8 @@
|
||||
"Build or step failed to complete successfully.",
|
||||
"Build or step failed due to an internal cause.",
|
||||
"Build or step took longer than was allowed.",
|
||||
"Build or step was canceled by a user."
|
||||
"Build or step was canceled by a user.",
|
||||
"Build was enqueued for longer than the value of `queue_ttl`."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -896,7 +904,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"workerPool": {
|
||||
"description": "Option to specify a `WorkerPool` for the build. User specifies the pool\nwith the format \"[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]\".\nThis is an experimental field.",
|
||||
"description": "Option to specify a `WorkerPool` for the build.\nFormat: projects/{project}/workerPools/{workerPool}\n\nThis field is experimental.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -957,7 +965,8 @@
|
||||
"FAILURE",
|
||||
"INTERNAL_ERROR",
|
||||
"TIMEOUT",
|
||||
"CANCELLED"
|
||||
"CANCELLED",
|
||||
"EXPIRED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Status of the build is unknown.",
|
||||
@@ -967,7 +976,8 @@
|
||||
"Build or step failed to complete successfully.",
|
||||
"Build or step failed due to an internal cause.",
|
||||
"Build or step took longer than was allowed.",
|
||||
"Build or step was canceled by a user."
|
||||
"Build or step was canceled by a user.",
|
||||
"Build was enqueued for longer than the value of `queue_ttl`."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1024,14 +1034,14 @@
|
||||
},
|
||||
"github": {
|
||||
"$ref": "GitHubEventsConfig",
|
||||
"description": "GitHubEventsConfig describes the configuration of a trigger that creates\na build whenever a GitHub event is received."
|
||||
"description": "GitHubEventsConfig describes the configuration of a trigger that creates\na build whenever a GitHub event is received.\n\nMutually exclusive with `trigger_template`."
|
||||
},
|
||||
"id": {
|
||||
"description": "Output only. Unique identifier of the trigger.",
|
||||
"type": "string"
|
||||
},
|
||||
"ignoredFiles": {
|
||||
"description": "ignored_files and included_files are file glob matches using\nhttp://godoc/pkg/path/filepath#Match extended with support for \"**\".\n\nIf ignored_files and changed files are both empty, then they are\nnot used to determine whether or not to trigger a build.\n\nIf ignored_files is not empty, then we ignore any files that match\nany of the ignored_file globs. If the change has no files that are\noutside of the ignored_files globs, then we do not trigger a build.",
|
||||
"description": "ignored_files and included_files are file glob matches using\nhttps://golang.org/pkg/path/filepath/#Match extended with support for \"**\".\n\nIf ignored_files and changed files are both empty, then they are\nnot used to determine whether or not to trigger a build.\n\nIf ignored_files is not empty, then we ignore any files that match\nany of the ignored_file globs. If the change has no files that are\noutside of the ignored_files globs, then we do not trigger a build.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1044,11 +1054,15 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"name": {
|
||||
"description": "User-assigned name of the trigger. Must be unique within the project.\nTrigger names must meet the following requirements:\n\n+ They must contain only alphanumeric characters and dashes.\n+ They can be 1-64 characters long.\n+ They must begin and end with an alphanumeric character.",
|
||||
"type": "string"
|
||||
},
|
||||
"substitutions": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Substitutions data for Build resource.",
|
||||
"description": "Substitutions for Build resource. The keys must match the following\nregular expression: `^_[A-Z0-9_]+$`.The keys cannot conflict with the\nkeys in bindings.",
|
||||
"type": "object"
|
||||
},
|
||||
"tags": {
|
||||
@@ -1060,7 +1074,7 @@
|
||||
},
|
||||
"triggerTemplate": {
|
||||
"$ref": "RepoSource",
|
||||
"description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build."
|
||||
"description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build.\n\nMutually exclusive with `github`."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1268,7 +1282,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"commentControl": {
|
||||
"description": "Whether to block builds on a \"/gcbrun\" comment from a repository owner or\ncollaborator.",
|
||||
"description": "Whether to block builds on a \"/gcbrun\" comment from a repository admin or\ncollaborator.",
|
||||
"enum": [
|
||||
"COMMENTS_DISABLED",
|
||||
"COMMENTS_ENABLED"
|
||||
@@ -1278,6 +1292,10 @@
|
||||
"Enforce that repository owners or collaborators must comment on Pull\nRequests before builds are triggered."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"invertRegex": {
|
||||
"description": "If true, branches that do NOT match the git_ref will trigger a build.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1287,11 +1305,15 @@
|
||||
"id": "PushFilter",
|
||||
"properties": {
|
||||
"branch": {
|
||||
"description": "Regexes of branches to match.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax",
|
||||
"description": "Regexes matching branches to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax",
|
||||
"type": "string"
|
||||
},
|
||||
"invertRegex": {
|
||||
"description": "When true, only trigger a build if the revision regex does NOT match the\ngit_ref regex.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"tag": {
|
||||
"description": "Regexes of tags to match.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax",
|
||||
"description": "Regexes matching tags to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1302,7 +1324,7 @@
|
||||
"id": "RepoSource",
|
||||
"properties": {
|
||||
"branchName": {
|
||||
"description": "Name of the branch to build.",
|
||||
"description": "Regex matching branches to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax",
|
||||
"type": "string"
|
||||
},
|
||||
"commitSha": {
|
||||
@@ -1313,16 +1335,27 @@
|
||||
"description": "Directory, relative to the source root, in which to run the build.\n\nThis must be a relative path. If a step's `dir` is specified and is an\nabsolute path, this value is ignored for that step's execution.",
|
||||
"type": "string"
|
||||
},
|
||||
"invertRegex": {
|
||||
"description": "Only trigger a build if the revision regex does NOT match the revision\nregex.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "ID of the project that owns the Cloud Source Repository. If omitted, the\nproject ID requesting the build is assumed.",
|
||||
"type": "string"
|
||||
},
|
||||
"repoName": {
|
||||
"description": "Name of the Cloud Source Repository. If omitted, the name \"default\" is\nassumed.",
|
||||
"description": "Required. Name of the Cloud Source Repository.",
|
||||
"type": "string"
|
||||
},
|
||||
"substitutions": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Substitutions to use in a triggered build.\nShould only be used with RunBuildTrigger",
|
||||
"type": "object"
|
||||
},
|
||||
"tagName": {
|
||||
"description": "Name of the tag to build.",
|
||||
"description": "Regex matching tags to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudbuild:v1alpha1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudbuild.mtls.googleapis.com/",
|
||||
"name": "cloudbuild",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -109,7 +110,7 @@
|
||||
"workerPools": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates a `WorkerPool` to run the builds, and returns the new worker pool.\n\nThis API is experimental.",
|
||||
"description": "Creates a `WorkerPool` to run the builds, and returns the new worker pool.",
|
||||
"flatPath": "v1alpha1/projects/{projectsId}/workerPools",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudbuild.projects.workerPools.create",
|
||||
@@ -137,7 +138,7 @@
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes a `WorkerPool` by its project ID and WorkerPool name.\n\nThis API is experimental.",
|
||||
"description": "Deletes a `WorkerPool` by its project ID and WorkerPool name.",
|
||||
"flatPath": "v1alpha1/projects/{projectsId}/workerPools/{workerPoolsId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "cloudbuild.projects.workerPools.delete",
|
||||
@@ -162,7 +163,7 @@
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Returns information about a `WorkerPool`.\n\nThis API is experimental.",
|
||||
"description": "Returns information about a `WorkerPool`.",
|
||||
"flatPath": "v1alpha1/projects/{projectsId}/workerPools/{workerPoolsId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "cloudbuild.projects.workerPools.get",
|
||||
@@ -187,7 +188,7 @@
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "List project's `WorkerPool`s.\n\nThis API is experimental.",
|
||||
"description": "List project's `WorkerPool`s.",
|
||||
"flatPath": "v1alpha1/projects/{projectsId}/workerPools",
|
||||
"httpMethod": "GET",
|
||||
"id": "cloudbuild.projects.workerPools.list",
|
||||
@@ -212,7 +213,7 @@
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Update a `WorkerPool`.\n\nThis API is experimental.",
|
||||
"description": "Update a `WorkerPool`.",
|
||||
"flatPath": "v1alpha1/projects/{projectsId}/workerPools/{workerPoolsId}",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "cloudbuild.projects.workerPools.patch",
|
||||
@@ -244,7 +245,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190702",
|
||||
"revision": "20200323",
|
||||
"rootUrl": "https://cloudbuild.googleapis.com/",
|
||||
"schemas": {
|
||||
"ArtifactObjects": {
|
||||
@@ -354,6 +355,11 @@
|
||||
"description": "Output only. ID of the project.",
|
||||
"type": "string"
|
||||
},
|
||||
"queueTtl": {
|
||||
"description": "TTL in queue for this build. If provided and the build is enqueued longer\nthan this value, the build will expire and the build status will be\n`EXPIRED`.\n\nThe TTL starts ticking from create_time.",
|
||||
"format": "google-duration",
|
||||
"type": "string"
|
||||
},
|
||||
"results": {
|
||||
"$ref": "Results",
|
||||
"description": "Output only. Results of the build."
|
||||
@@ -388,7 +394,8 @@
|
||||
"FAILURE",
|
||||
"INTERNAL_ERROR",
|
||||
"TIMEOUT",
|
||||
"CANCELLED"
|
||||
"CANCELLED",
|
||||
"EXPIRED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Status of the build is unknown.",
|
||||
@@ -398,7 +405,8 @@
|
||||
"Build or step failed to complete successfully.",
|
||||
"Build or step failed due to an internal cause.",
|
||||
"Build or step took longer than was allowed.",
|
||||
"Build or step was canceled by a user."
|
||||
"Build or step was canceled by a user.",
|
||||
"Build was enqueued for longer than the value of `queue_ttl`."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -567,7 +575,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"workerPool": {
|
||||
"description": "Option to specify a `WorkerPool` for the build. User specifies the pool\nwith the format \"[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]\".\nThis is an experimental field.",
|
||||
"description": "Option to specify a `WorkerPool` for the build.\nFormat: projects/{project}/workerPools/{workerPool}\n\nThis field is experimental.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -628,7 +636,8 @@
|
||||
"FAILURE",
|
||||
"INTERNAL_ERROR",
|
||||
"TIMEOUT",
|
||||
"CANCELLED"
|
||||
"CANCELLED",
|
||||
"EXPIRED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Status of the build is unknown.",
|
||||
@@ -638,7 +647,8 @@
|
||||
"Build or step failed to complete successfully.",
|
||||
"Build or step failed due to an internal cause.",
|
||||
"Build or step took longer than was allowed.",
|
||||
"Build or step was canceled by a user."
|
||||
"Build or step was canceled by a user.",
|
||||
"Build was enqueued for longer than the value of `queue_ttl`."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -771,7 +781,7 @@
|
||||
"id": "RepoSource",
|
||||
"properties": {
|
||||
"branchName": {
|
||||
"description": "Name of the branch to build.",
|
||||
"description": "Regex matching branches to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax",
|
||||
"type": "string"
|
||||
},
|
||||
"commitSha": {
|
||||
@@ -782,16 +792,27 @@
|
||||
"description": "Directory, relative to the source root, in which to run the build.\n\nThis must be a relative path. If a step's `dir` is specified and is an\nabsolute path, this value is ignored for that step's execution.",
|
||||
"type": "string"
|
||||
},
|
||||
"invertRegex": {
|
||||
"description": "Only trigger a build if the revision regex does NOT match the revision\nregex.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "ID of the project that owns the Cloud Source Repository. If omitted, the\nproject ID requesting the build is assumed.",
|
||||
"type": "string"
|
||||
},
|
||||
"repoName": {
|
||||
"description": "Name of the Cloud Source Repository. If omitted, the name \"default\" is\nassumed.",
|
||||
"description": "Required. Name of the Cloud Source Repository.",
|
||||
"type": "string"
|
||||
},
|
||||
"substitutions": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Substitutions to use in a triggered build.\nShould only be used with RunBuildTrigger",
|
||||
"type": "object"
|
||||
},
|
||||
"tagName": {
|
||||
"description": "Name of the tag to build.",
|
||||
"description": "Regex matching tags to build.\n\nThe syntax of the regular expressions accepted is the syntax accepted by\nRE2 and described at https://github.com/google/re2/wiki/Syntax",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1031,7 +1052,7 @@
|
||||
"Status of the `WorkerPool` is unknown.",
|
||||
"`WorkerPool` is being created.",
|
||||
"`WorkerPool` is running.",
|
||||
"`WorkerPool` is being deleting: cancelling builds and draining workers.",
|
||||
"`WorkerPool` is being deleted: cancelling builds and draining workers.",
|
||||
"`WorkerPool` is deleted."
|
||||
],
|
||||
"type": "string"
|
||||
|
||||
1051
etc/api/cloudbuild/v1alpha2/cloudbuild-api.json
Normal file
1051
etc/api/cloudbuild/v1alpha2/cloudbuild-api.json
Normal file
File diff suppressed because it is too large
Load Diff
@@ -18,12 +18,14 @@
|
||||
"description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/debugger",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
||||
},
|
||||
"id": "clouddebugger:v2",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://clouddebugger.mtls.googleapis.com/",
|
||||
"name": "clouddebugger",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -143,7 +145,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"debuggeeId": {
|
||||
"description": "Identifies the debuggee.",
|
||||
"description": "Required. Identifies the debuggee.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -179,7 +181,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"debuggeeId": {
|
||||
"description": "Identifies the debuggee being debugged.",
|
||||
"description": "Required. Identifies the debuggee being debugged.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -221,7 +223,7 @@
|
||||
"parameterOrder": [],
|
||||
"parameters": {
|
||||
"clientVersion": {
|
||||
"description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
|
||||
"description": "Required. The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -231,7 +233,7 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"project": {
|
||||
"description": "Project number of a Google Cloud project whose debuggees to list.",
|
||||
"description": "Required. Project number of a Google Cloud project whose debuggees to list.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -260,18 +262,18 @@
|
||||
],
|
||||
"parameters": {
|
||||
"breakpointId": {
|
||||
"description": "ID of the breakpoint to delete.",
|
||||
"description": "Required. ID of the breakpoint to delete.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"clientVersion": {
|
||||
"description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
|
||||
"description": "Required. The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"debuggeeId": {
|
||||
"description": "ID of the debuggee whose breakpoint to delete.",
|
||||
"description": "Required. ID of the debuggee whose breakpoint to delete.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -297,18 +299,18 @@
|
||||
],
|
||||
"parameters": {
|
||||
"breakpointId": {
|
||||
"description": "ID of the breakpoint to get.",
|
||||
"description": "Required. ID of the breakpoint to get.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"clientVersion": {
|
||||
"description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
|
||||
"description": "Required. The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"debuggeeId": {
|
||||
"description": "ID of the debuggee whose breakpoint to get.",
|
||||
"description": "Required. ID of the debuggee whose breakpoint to get.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -342,12 +344,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"clientVersion": {
|
||||
"description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
|
||||
"description": "Required. The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"debuggeeId": {
|
||||
"description": "ID of the debuggee whose breakpoints to list.",
|
||||
"description": "Required. ID of the debuggee whose breakpoints to list.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -392,12 +394,12 @@
|
||||
],
|
||||
"parameters": {
|
||||
"clientVersion": {
|
||||
"description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
|
||||
"description": "Required. The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"debuggeeId": {
|
||||
"description": "ID of the debuggee where the breakpoint is to be set.",
|
||||
"description": "Required. ID of the debuggee where the breakpoint is to be set.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -422,7 +424,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190614",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://clouddebugger.googleapis.com/",
|
||||
"schemas": {
|
||||
"AliasContext": {
|
||||
@@ -453,7 +455,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Breakpoint": {
|
||||
"description": "Represents the breakpoint specification, status and results.",
|
||||
"description": "------------------------------------------------------------------------------\n## Breakpoint (the resource)\n\nRepresents the breakpoint specification, status and results.",
|
||||
"id": "Breakpoint",
|
||||
"properties": {
|
||||
"action": {
|
||||
@@ -841,7 +843,7 @@
|
||||
"properties": {
|
||||
"debuggee": {
|
||||
"$ref": "Debuggee",
|
||||
"description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
|
||||
"description": "Required. Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -878,7 +880,7 @@
|
||||
"properties": {
|
||||
"breakpoint": {
|
||||
"$ref": "Breakpoint",
|
||||
"description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)."
|
||||
"description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fields)."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -999,7 +1001,7 @@
|
||||
"properties": {
|
||||
"breakpoint": {
|
||||
"$ref": "Breakpoint",
|
||||
"description": "Updated breakpoint information.\nThe field `id` must be set.\nThe agent must echo all Breakpoint specification fields in the update."
|
||||
"description": "Required. Updated breakpoint information.\nThe field `id` must be set.\nThe agent must echo all Breakpoint specification fields in the update."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1047,7 +1049,7 @@
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "Stackdriver Debugger API",
|
||||
"title": "Cloud Debugger API",
|
||||
"version": "v2",
|
||||
"version_module": true
|
||||
}
|
||||
@@ -21,6 +21,7 @@
|
||||
},
|
||||
"id": "clouderrorreporting:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://clouderrorreporting.mtls.googleapis.com/",
|
||||
"name": "clouderrorreporting",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -115,7 +116,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectName": {
|
||||
"description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
|
||||
"description": "Required. The resource name of the Google Cloud Platform project. Written\nas `projects/{projectID}`, where `{projectID}` is the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\n\nExample: `projects/my-project-123`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -144,40 +145,40 @@
|
||||
],
|
||||
"parameters": {
|
||||
"groupId": {
|
||||
"description": "[Required] The group for which events shall be returned.",
|
||||
"description": "Required. The group for which events shall be returned.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "[Optional] The maximum number of results to return per response.",
|
||||
"description": "Optional. The maximum number of results to return per response.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "[Optional] A `next_page_token` provided by a previous response.",
|
||||
"description": "Optional. A `next_page_token` provided by a previous response.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"projectName": {
|
||||
"description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
|
||||
"description": "Required. The resource name of the Google Cloud Platform project. Written\nas `projects/{projectID}`, where `{projectID}` is the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\n\nExample: `projects/my-project-123`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"serviceFilter.resourceType": {
|
||||
"description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
|
||||
"description": "Optional. The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"serviceFilter.service": {
|
||||
"description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
|
||||
"description": "Optional. The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"serviceFilter.version": {
|
||||
"description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
|
||||
"description": "Optional. The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -204,7 +205,7 @@
|
||||
]
|
||||
},
|
||||
"report": {
|
||||
"description": "Report an individual error event.\n\nThis endpoint accepts **either** an OAuth token,\n**or** an [API key](https://support.google.com/cloud/answer/6158862)\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\n`POST\nhttps://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456`",
|
||||
"description": "Report an individual error event.\n\nThis endpoint accepts **either** an OAuth token,\n**or** an [API key](https://support.google.com/cloud/answer/6158862)\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\n`POST\nhttps://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456`",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/events:report",
|
||||
"httpMethod": "POST",
|
||||
"id": "clouderrorreporting.projects.events.report",
|
||||
@@ -213,7 +214,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectName": {
|
||||
"description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840). Example:\n`projects/my-project-123`.",
|
||||
"description": "Required. The resource name of the Google Cloud Platform project. Written\nas `projects/{projectId}`, where `{projectId}` is the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\n\nExample: // `projects/my-project-123`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -245,7 +246,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"alignment": {
|
||||
"description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
|
||||
"description": "Optional. The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
|
||||
"enum": [
|
||||
"ERROR_COUNT_ALIGNMENT_UNSPECIFIED",
|
||||
"ALIGNMENT_EQUAL_ROUNDED",
|
||||
@@ -255,19 +256,19 @@
|
||||
"type": "string"
|
||||
},
|
||||
"alignmentTime": {
|
||||
"description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.",
|
||||
"description": "Optional. Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.",
|
||||
"format": "google-datetime",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"groupId": {
|
||||
"description": "[Optional] List all <code>ErrorGroupStats</code> with these IDs.",
|
||||
"description": "Optional. List all <code>ErrorGroupStats</code> with these IDs.",
|
||||
"location": "query",
|
||||
"repeated": true,
|
||||
"type": "string"
|
||||
},
|
||||
"order": {
|
||||
"description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
|
||||
"description": "Optional. The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
|
||||
"enum": [
|
||||
"GROUP_ORDER_UNSPECIFIED",
|
||||
"COUNT_DESC",
|
||||
@@ -279,35 +280,35 @@
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
|
||||
"description": "Optional. The maximum number of results to return per response.\nDefault is 20.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
|
||||
"description": "Optional. A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"projectName": {
|
||||
"description": "[Required] The resource name of the Google Cloud Platform project. Written\nas <code>projects/</code> plus the\n<a href=\"https://support.google.com/cloud/answer/6158840\">Google Cloud\nPlatform project ID</a>.\n\nExample: <code>projects/my-project-123</code>.",
|
||||
"description": "Required. The resource name of the Google Cloud Platform project. Written\nas `projects/{projectID}`, where `{projectID}` is the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\n\nExample: `projects/my-project-123`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"serviceFilter.resourceType": {
|
||||
"description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
|
||||
"description": "Optional. The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"serviceFilter.service": {
|
||||
"description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
|
||||
"description": "Optional. The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"serviceFilter.version": {
|
||||
"description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
|
||||
"description": "Optional. The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -325,7 +326,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"timedCountDuration": {
|
||||
"description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
|
||||
"description": "Optional. The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
|
||||
"format": "google-duration",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -353,7 +354,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"groupName": {
|
||||
"description": "[Required] The group resource name. Written as\n<code>projects/<var>projectID</var>/groups/<var>group_name</var></code>.\nCall\n<a href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\">\n<code>groupStats.list</code></a> to return a list of groups belonging to\nthis project.\n\nExample: <code>projects/my-project-123/groups/my-group</code>",
|
||||
"description": "Required. The group resource name. Written as\n<code>projects/<var>projectID</var>/groups/<var>group_name</var></code>.\nCall\n<a href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\">\n<code>groupStats.list</code></a> to return a list of groups belonging to\nthis project.\n\nExample: <code>projects/my-project-123/groups/my-group</code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/groups/[^/]+$",
|
||||
"required": true,
|
||||
@@ -378,7 +379,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The group resource name.\nExample: <code>projects/my-project-123/groups/my-groupid</code>",
|
||||
"description": "The group resource name.\nExample: <code>projects/my-project-123/groups/CNSgkpnppqKCUw</code>",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/groups/[^/]+$",
|
||||
"required": true,
|
||||
@@ -401,7 +402,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190626",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://clouderrorreporting.googleapis.com/",
|
||||
"schemas": {
|
||||
"DeleteEventsResponse": {
|
||||
@@ -469,7 +470,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "The group resource name.\nExample: <code>projects/my-project-123/groups/my-groupid</code>",
|
||||
"description": "The group resource name.\nExample: <code>projects/my-project-123/groups/CNSgkpnppqKCUw</code>",
|
||||
"type": "string"
|
||||
},
|
||||
"trackingIssues": {
|
||||
@@ -626,20 +627,20 @@
|
||||
"properties": {
|
||||
"context": {
|
||||
"$ref": "ErrorContext",
|
||||
"description": "[Optional] A description of the context in which the error occurred."
|
||||
"description": "Optional. A description of the context in which the error occurred."
|
||||
},
|
||||
"eventTime": {
|
||||
"description": "[Optional] Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.",
|
||||
"description": "Optional. Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"message": {
|
||||
"description": "[Required] The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of\n[`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of\n[`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of\n[`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned\nby V8.\n* **Ruby**: Must contain frames returned by\n[`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of\n[`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of\n[`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of\n[`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).",
|
||||
"description": "Required. The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of\n[`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of\n[`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of\n[`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned\nby V8.\n* **Ruby**: Must contain frames returned by\n[`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of\n[`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of\n[`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of\n[`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).",
|
||||
"type": "string"
|
||||
},
|
||||
"serviceContext": {
|
||||
"$ref": "ServiceContext",
|
||||
"description": "[Required] The service context in which this error has occurred."
|
||||
"description": "Required. The service context in which this error has occurred."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -733,7 +734,7 @@
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "Stackdriver Error Reporting API",
|
||||
"title": "Error Reporting API",
|
||||
"version": "v1beta1",
|
||||
"version_module": true
|
||||
}
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudfunctions:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudfunctions.mtls.googleapis.com/",
|
||||
"name": "cloudfunctions",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -139,7 +140,7 @@
|
||||
"parameterOrder": [],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "Required. A filter for matching the requested operations.<br><br> The supported formats of <b>filter</b> are:<br> To query for specific function: <code>project:*,location:*,function:*</code><br> To query for all of the latest operations for a project: <code>project:*,latest:true</code>",
|
||||
"description": "Required. A filter for matching the requested operations.<br><br> The supported formats of <b>filter</b> are:<br> To query for a specific function: <code>project:*,location:*,function:*</code><br> To query for all of the latest operations for a project: <code>project:*,latest:true</code>",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -149,13 +150,13 @@
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "The standard list page size.",
|
||||
"description": "The maximum number of records that should be returned.<br> Requested page size cannot exceed 100. If not set, the default page size is 100.<br><br> Pagination is only supported when querying for a specific function.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The standard list page token.",
|
||||
"description": "Token identifying which result to start with, which is returned by a previous list call.<br><br> Pagination is only supported when querying for a specific function.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -229,7 +230,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the function to be called.",
|
||||
"description": "Required. The name of the function to be called.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -257,7 +258,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"location": {
|
||||
"description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
|
||||
"description": "Required. The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -285,7 +286,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the function which should be deleted.",
|
||||
"description": "Required. The name of the function which should be deleted.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -366,7 +367,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the function which details should be obtained.",
|
||||
"description": "Required. The name of the function which details should be obtained.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -390,6 +391,12 @@
|
||||
"resource"
|
||||
],
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
@@ -427,7 +434,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
|
||||
"description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation. When listing functions in all locations, if one or more\nlocation(s) are unreachable, the response will contain functions from all\nreachable locations along with the names of any unreachable locations.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -539,11 +546,11 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190620",
|
||||
"revision": "20200401",
|
||||
"rootUrl": "https://cloudfunctions.googleapis.com/",
|
||||
"schemas": {
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -561,7 +568,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -599,7 +606,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -617,7 +624,7 @@
|
||||
"id": "CallFunctionRequest",
|
||||
"properties": {
|
||||
"data": {
|
||||
"description": "Input to be passed to the function.",
|
||||
"description": "Required. Input to be passed to the function.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -643,7 +650,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"CloudFunction": {
|
||||
"description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.\nLINT.IfChange",
|
||||
"description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
|
||||
"id": "CloudFunction",
|
||||
"properties": {
|
||||
"availableMemoryMb": {
|
||||
@@ -674,6 +681,20 @@
|
||||
"$ref": "HttpsTrigger",
|
||||
"description": "An HTTPS endpoint type of source that can be triggered via URL."
|
||||
},
|
||||
"ingressSettings": {
|
||||
"description": "The ingress settings for the function, controlling what traffic can reach\nit.",
|
||||
"enum": [
|
||||
"INGRESS_SETTINGS_UNSPECIFIED",
|
||||
"ALLOW_ALL",
|
||||
"ALLOW_INTERNAL_ONLY"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified.",
|
||||
"Allow HTTP traffic from public and private sources.",
|
||||
"Allow HTTP traffic from only private VPC sources."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"labels": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
@@ -691,15 +712,15 @@
|
||||
"type": "string"
|
||||
},
|
||||
"network": {
|
||||
"description": "The VPC Network that this cloud function can connect to. It can be\neither the fully-qualified URI, or the short name of the network resource.\nIf the short network name is used, the network must belong to the same\nproject. Otherwise, it must belong to a project within the same\norganization. The format of this field is either\n`projects/{project}/global/networks/{network}` or `{network}`, where\n{project} is a project id where the network is defined, and {network} is\nthe short name of the network.\n\nThis field is mutually exclusive with `vpc_connector` and will be replaced\nby it.\n\nSee [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for\nmore information on connecting Cloud projects.\n\nThis feature is currently in alpha, available only for whitelisted users.",
|
||||
"description": "The VPC Network that this cloud function can connect to. It can be\neither the fully-qualified URI, or the short name of the network resource.\nIf the short network name is used, the network must belong to the same\nproject. Otherwise, it must belong to a project within the same\norganization. The format of this field is either\n`projects/{project}/global/networks/{network}` or `{network}`, where\n{project} is a project id where the network is defined, and {network} is\nthe short name of the network.\n\nThis field is mutually exclusive with `vpc_connector` and will be replaced\nby it.\n\nSee [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for\nmore information on connecting Cloud projects.",
|
||||
"type": "string"
|
||||
},
|
||||
"runtime": {
|
||||
"description": "Required. The runtime in which the function is going to run. Choices:\n\n* `nodejs6`: Node.js 6\n* `nodejs8`: Node.js 8\n* `nodejs10`: Node.js 10\n* `python37`: Python 3.7\n* `go111`: Go 1.11",
|
||||
"description": "The runtime in which to run the function. Required when deploying a new\nfunction, optional when updating an existing function. For a complete\nlist of possible choices, see the\n[`gcloud` command\nreference](/sdk/gcloud/reference/functions/deploy#--runtime).",
|
||||
"type": "string"
|
||||
},
|
||||
"serviceAccountEmail": {
|
||||
"description": "The email of the function's service account. If empty, defaults to\n{project_id}@appspot.gserviceaccount.com.",
|
||||
"description": "The email of the function's service account. If empty, defaults to\n`{project_id}@appspot.gserviceaccount.com`.",
|
||||
"type": "string"
|
||||
},
|
||||
"sourceArchiveUrl": {
|
||||
@@ -745,12 +766,26 @@
|
||||
"type": "string"
|
||||
},
|
||||
"versionId": {
|
||||
"description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.",
|
||||
"description": "Output only. The version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"vpcConnector": {
|
||||
"description": "The VPC Network Connector that this cloud function can connect to. It can\nbe either the fully-qualified URI, or the short name of the network\nconnector resource. The format of this field is\n`projects/*/locations/*/connectors/*`\n\nThis field is mutually exclusive with `network` field and will eventually\nreplace it.\n\nSee [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for\nmore information on connecting Cloud projects.\n\nThis feature is currently in alpha, available only for whitelisted users.",
|
||||
"description": "The VPC Network Connector that this cloud function can connect to. It can\nbe either the fully-qualified URI, or the short name of the network\nconnector resource. The format of this field is\n`projects/*/locations/*/connectors/*`\n\nThis field is mutually exclusive with `network` field and will eventually\nreplace it.\n\nSee [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for\nmore information on connecting Cloud projects.",
|
||||
"type": "string"
|
||||
},
|
||||
"vpcConnectorEgressSettings": {
|
||||
"description": "The egress settings for the connector, controlling what traffic is diverted\nthrough it.",
|
||||
"enum": [
|
||||
"VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED",
|
||||
"PRIVATE_RANGES_ONLY",
|
||||
"ALL_TRAFFIC"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified.",
|
||||
"Use the VPC Access Connector only for private IP space from RFC1918.",
|
||||
"Force the use of VPC Access Connector for all egress traffic from the\nfunction."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -780,23 +815,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -878,6 +913,13 @@
|
||||
"nextPageToken": {
|
||||
"description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1.ListFunctionsRequest\nto get more functions.",
|
||||
"type": "string"
|
||||
},
|
||||
"unreachable": {
|
||||
"description": "Locations that could not be reached. The response does not include any\nfunctions from these locations.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1078,7 +1120,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -1089,19 +1131,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudfunctions:v1beta2",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudfunctions.mtls.googleapis.com/",
|
||||
"name": "cloudfunctions",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -139,7 +140,7 @@
|
||||
"parameterOrder": [],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "Required. A filter for matching the requested operations.<br><br> The supported formats of <b>filter</b> are:<br> To query for specific function: <code>project:*,location:*,function:*</code><br> To query for all of the latest operations for a project: <code>project:*,latest:true</code>",
|
||||
"description": "Required. A filter for matching the requested operations.<br><br> The supported formats of <b>filter</b> are:<br> To query for a specific function: <code>project:*,location:*,function:*</code><br> To query for all of the latest operations for a project: <code>project:*,latest:true</code>",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -149,13 +150,13 @@
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "The standard list page size.",
|
||||
"description": "The maximum number of records that should be returned.<br> Requested page size cannot exceed 100. If not set, the default page size is 100.<br><br> Pagination is only supported when querying for a specific function.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The standard list page token.",
|
||||
"description": "Token identifying which result to start with, which is returned by a previous list call.<br><br> Pagination is only supported when querying for a specific function.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -229,7 +230,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the function to be called.",
|
||||
"description": "Required. The name of the function to be called.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -257,7 +258,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"location": {
|
||||
"description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
|
||||
"description": "Required. The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -285,7 +286,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the function which should be deleted.",
|
||||
"description": "Required. The name of the function which should be deleted.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -366,7 +367,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the function which details should be obtained.",
|
||||
"description": "Required. The name of the function which details should be obtained.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -391,7 +392,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"location": {
|
||||
"description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
|
||||
"description": "Required. The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation. When listing functions in all locations, if one or more\nlocation(s) are unreachable, the response will contain functions from all\nreachable locations along with the names of any unreachable locations.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -427,7 +428,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the function to be updated.",
|
||||
"description": "Required. The name of the function to be updated.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -452,7 +453,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190620",
|
||||
"revision": "20200401",
|
||||
"rootUrl": "https://cloudfunctions.googleapis.com/",
|
||||
"schemas": {
|
||||
"CallFunctionRequest": {
|
||||
@@ -460,7 +461,7 @@
|
||||
"id": "CallFunctionRequest",
|
||||
"properties": {
|
||||
"data": {
|
||||
"description": "Input to be passed to the function.",
|
||||
"description": "Required. Input to be passed to the function.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -534,15 +535,15 @@
|
||||
"type": "string"
|
||||
},
|
||||
"network": {
|
||||
"description": "The VPC Network that this cloud function can connect to. It can be\neither the fully-qualified URI, or the short name of the network resource.\nIf the short network name is used, the network must belong to the same\nproject. Otherwise, it must belong to a project within the same\norganization. The format of this field is either\n`projects/{project}/global/networks/{network}` or `{network}`, where\n{project} is a project id where the network is defined, and {network} is\nthe short name of the network.\n\nThis field is mutually exclusive with `vpc_connector` and will be replaced\nby it.\n\nSee [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for\nmore information on connecting Cloud projects.\n\nThis feature is currently in alpha, available only for whitelisted users.",
|
||||
"description": "The VPC Network that this cloud function can connect to. It can be\neither the fully-qualified URI, or the short name of the network resource.\nIf the short network name is used, the network must belong to the same\nproject. Otherwise, it must belong to a project within the same\norganization. The format of this field is either\n`projects/{project}/global/networks/{network}` or `{network}`, where\n{project} is a project id where the network is defined, and {network} is\nthe short name of the network.\n\nThis field is mutually exclusive with `vpc_connector` and will be replaced\nby it.\n\nSee [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for\nmore information on connecting Cloud projects.",
|
||||
"type": "string"
|
||||
},
|
||||
"runtime": {
|
||||
"description": "Required. The runtime in which the function is going to run. Choices:\n\n* `nodejs6`: Node.js 6\n* `nodejs8`: Node.js 8\n* `nodejs10`: Node.js 10\n* `python37`: Python 3.7\n* `go111`: Go 1.11",
|
||||
"description": "The runtime in which to run the function. Required when deploying a new\nfunction, optional when updating an existing function. For a complete\nlist of possible choices, see the\n[`gcloud` command\nreference](/sdk/gcloud/reference/functions/deploy#--runtime).",
|
||||
"type": "string"
|
||||
},
|
||||
"serviceAccount": {
|
||||
"description": "The email of the function's service account. If empty, defaults to\n{project_id}@appspot.gserviceaccount.com.",
|
||||
"description": "The email of the function's service account. If empty, defaults to\n`{project_id}@appspot.gserviceaccount.com`.",
|
||||
"type": "string"
|
||||
},
|
||||
"sourceArchiveUrl": {
|
||||
@@ -590,12 +591,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"versionId": {
|
||||
"description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.",
|
||||
"description": "Output only. The version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"vpcConnector": {
|
||||
"description": "The VPC Network Connector that this cloud function can connect to. It can\nbe either the fully-qualified URI, or the short name of the network\nconnector resource. The format of this field is\n`projects/*/locations/*/connectors/*`\n\nThis field is mutually exclusive with `network` field and will eventually\nreplace it.\n\nSee [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for\nmore information on connecting Cloud projects.\n\nThis feature is currently in alpha, available only for whitelisted users.",
|
||||
"description": "The VPC Network Connector that this cloud function can connect to. It can\nbe either the fully-qualified URI, or the short name of the network\nconnector resource. The format of this field is\n`projects/*/locations/*/connectors/*`\n\nThis field is mutually exclusive with `network` field and will eventually\nreplace it.\n\nSee [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for\nmore information on connecting Cloud projects.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -700,6 +701,13 @@
|
||||
"nextPageToken": {
|
||||
"description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions.",
|
||||
"type": "string"
|
||||
},
|
||||
"unreachable": {
|
||||
"description": "Locations that could not be reached. The response does not include any\nfunctions from these locations.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
|
||||
@@ -7,6 +7,9 @@
|
||||
},
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly": {
|
||||
"description": "See any Cloud Identity Groups that you can access, including group members and their emails"
|
||||
},
|
||||
"https://www.googleapis.com/auth/cloud-platform": {
|
||||
"description": "View and manage your data across Google Cloud Platform services"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -25,6 +28,7 @@
|
||||
},
|
||||
"id": "cloudidentity:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudidentity.mtls.googleapis.com/",
|
||||
"name": "cloudidentity",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -124,7 +128,8 @@
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
@@ -137,7 +142,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique ID\nassigned to the Group.",
|
||||
"description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique ID\nassigned to the Group.",
|
||||
"location": "path",
|
||||
"pattern": "^groups/[^/]+$",
|
||||
"required": true,
|
||||
@@ -149,7 +154,8 @@
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
@@ -162,7 +168,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique ID\nassigned to the Group.",
|
||||
"description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where `group_id` is the unique ID\nassigned to the Group.",
|
||||
"location": "path",
|
||||
"pattern": "^groups/[^/]+$",
|
||||
"required": true,
|
||||
@@ -175,11 +181,12 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "List groups within a customer or a domain.",
|
||||
"description": "Lists groups within a customer or a domain.",
|
||||
"flatPath": "v1/groups",
|
||||
"httpMethod": "GET",
|
||||
"id": "cloudidentity.groups.list",
|
||||
@@ -197,7 +204,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "`Required`. May be made Optional in the future.\nCustomer ID to list all groups from.",
|
||||
"description": "Required. Customer ID to list all groups from.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -218,7 +225,8 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"lookup": {
|
||||
@@ -245,7 +253,8 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
@@ -258,14 +267,14 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where group_id is the unique ID\nassigned to the Group.\n\nMust be left blank while creating a Group.",
|
||||
"description": "Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where group_id is the unique ID\nassigned to the Group.\n\nMust be left blank while creating a Group.",
|
||||
"location": "path",
|
||||
"pattern": "^groups/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Editable fields: `display_name`, `description`",
|
||||
"description": "Required. Editable fields: `display_name`, `description`",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -279,7 +288,8 @@
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"search": {
|
||||
@@ -301,7 +311,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"query": {
|
||||
"description": "`Required`. Query string for performing search on groups. Users can search\non parent and label attributes of groups.\nEXACT match ('==') is supported on parent, and CONTAINS match ('in') is\nsupported on labels.",
|
||||
"description": "Required. `Required`. Query string for performing search on groups. Users can search\non parent and label attributes of groups.\nEXACT match ('==') is supported on parent, and CONTAINS match ('in') is\nsupported on labels.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -322,7 +332,8 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
},
|
||||
@@ -339,7 +350,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to create Membership within. Format: `groups/{group_id}`, where\n`group_id` is the unique ID assigned to the Group.",
|
||||
"description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to create Membership within. Format: `groups/{group_id}`, where\n`group_id` is the unique ID assigned to the Group.",
|
||||
"location": "path",
|
||||
"pattern": "^groups/[^/]+$",
|
||||
"required": true,
|
||||
@@ -354,7 +365,8 @@
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
@@ -367,7 +379,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership to be deleted.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique ID assigned to the Group to which Membership belongs to, and\nmember_id is the unique ID assigned to the member.",
|
||||
"description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership to be deleted.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique ID assigned to the Group to which Membership belongs to, and\nmember_id is the unique ID assigned to the member.",
|
||||
"location": "path",
|
||||
"pattern": "^groups/[^/]+/memberships/[^/]+$",
|
||||
"required": true,
|
||||
@@ -379,7 +391,8 @@
|
||||
"$ref": "Operation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
@@ -392,7 +405,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership to be retrieved.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique id assigned to the Group to which Membership belongs to, and\n`member_id` is the unique ID assigned to the member.",
|
||||
"description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership to be retrieved.\n\nFormat: `groups/{group_id}/memberships/{member_id}`, where `group_id` is\nthe unique id assigned to the Group to which Membership belongs to, and\n`member_id` is the unique ID assigned to the member.",
|
||||
"location": "path",
|
||||
"pattern": "^groups/[^/]+/memberships/[^/]+$",
|
||||
"required": true,
|
||||
@@ -405,11 +418,12 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "List Memberships within a Group.",
|
||||
"description": "Lists Memberships within a Group.",
|
||||
"flatPath": "v1/groups/{groupsId}/memberships",
|
||||
"httpMethod": "GET",
|
||||
"id": "cloudidentity.groups.memberships.list",
|
||||
@@ -429,7 +443,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to list Memberships within.\n\nFormat: `groups/{group_id}`, where `group_id` is the unique ID assigned to\nthe Group.",
|
||||
"description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to list Memberships within.\n\nFormat: `groups/{group_id}`, where `group_id` is the unique ID assigned to\nthe Group.",
|
||||
"location": "path",
|
||||
"pattern": "^groups/[^/]+$",
|
||||
"required": true,
|
||||
@@ -452,7 +466,8 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
},
|
||||
"lookup": {
|
||||
@@ -475,7 +490,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to lookup Membership within.\n\nFormat: `groups/{group_id}`, where `group_id` is the unique ID assigned to\nthe Group.",
|
||||
"description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup to lookup Membership within.\n\nFormat: `groups/{group_id}`, where `group_id` is the unique ID assigned to\nthe Group.",
|
||||
"location": "path",
|
||||
"pattern": "^groups/[^/]+$",
|
||||
"required": true,
|
||||
@@ -488,7 +503,8 @@
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups",
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly"
|
||||
"https://www.googleapis.com/auth/cloud-identity.groups.readonly",
|
||||
"https://www.googleapis.com/auth/cloud-platform"
|
||||
]
|
||||
}
|
||||
}
|
||||
@@ -496,7 +512,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190629",
|
||||
"revision": "20200401",
|
||||
"rootUrl": "https://cloudidentity.googleapis.com/",
|
||||
"schemas": {
|
||||
"EntityKey": {
|
||||
@@ -519,7 +535,7 @@
|
||||
"id": "Group",
|
||||
"properties": {
|
||||
"createTime": {
|
||||
"description": "The time when the Group was created.\nOutput only.",
|
||||
"description": "Output only. The time when the Group was created.\nOutput only.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -533,25 +549,25 @@
|
||||
},
|
||||
"groupKey": {
|
||||
"$ref": "EntityKey",
|
||||
"description": "EntityKey of the Group.\n\nMust be set when creating a Group, read-only afterwards."
|
||||
"description": "Required. Immutable. EntityKey of the Group.\n\nMust be set when creating a Group, read-only afterwards."
|
||||
},
|
||||
"labels": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "`Required`. Labels for Group resource.\nFor creating Groups under a namespace, set label key to\n'labels/system/groups/external' and label value as empty.",
|
||||
"description": "Required. `Required`. Labels for Group resource.\nFor creating Groups under a namespace, set label key to\n'labels/system/groups/external' and label value as empty.",
|
||||
"type": "object"
|
||||
},
|
||||
"name": {
|
||||
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where group_id is the unique ID\nassigned to the Group.\n\nMust be left blank while creating a Group.",
|
||||
"description": "Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the\nGroup in the format: `groups/{group_id}`, where group_id is the unique ID\nassigned to the Group.\n\nMust be left blank while creating a Group.",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The entity under which this Group resides in Cloud Identity resource\nhierarchy. Must be set when creating a Group, read-only afterwards.\n\nCurrently allowed types: `identitysources`.",
|
||||
"description": "Required. Immutable. The entity under which this Group resides in Cloud Identity resource\nhierarchy. Must be set when creating a Group, read-only afterwards.\n\nCurrently allowed types: `identitysources`.",
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "The time when the Group was last updated.\nOutput only.",
|
||||
"description": "Output only. The time when the Group was last updated.\nOutput only.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -618,17 +634,17 @@
|
||||
"id": "Membership",
|
||||
"properties": {
|
||||
"createTime": {
|
||||
"description": "Creation timestamp of the Membership. Output only.",
|
||||
"description": "Output only. Creation timestamp of the Membership. Output only.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership in the format: `groups/{group_id}/memberships/{member_id}`,\nwhere group_id is the unique ID assigned to the Group to which Membership\nbelongs to, and member_id is the unique ID assigned to the member\n\nMust be left blank while creating a Membership.",
|
||||
"description": "Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the\nMembership in the format: `groups/{group_id}/memberships/{member_id}`,\nwhere group_id is the unique ID assigned to the Group to which Membership\nbelongs to, and member_id is the unique ID assigned to the member\n\nMust be left blank while creating a Membership.",
|
||||
"type": "string"
|
||||
},
|
||||
"preferredMemberKey": {
|
||||
"$ref": "EntityKey",
|
||||
"description": "EntityKey of the entity to be added as the member. Must be set while\ncreating a Membership, read-only afterwards.\n\nCurrently allowed entity types: `Users`, `Groups`."
|
||||
"description": "Required. Immutable. EntityKey of the entity to be added as the member. Must be set while\ncreating a Membership, read-only afterwards.\n\nCurrently allowed entity types: `Users`, `Groups`."
|
||||
},
|
||||
"roles": {
|
||||
"description": "Roles for a member within the Group.\n\nCurrently supported MembershipRoles: `\"MEMBER\"`.",
|
||||
@@ -638,7 +654,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Last updated timestamp of the Membership. Output only.",
|
||||
"description": "Output only. Last updated timestamp of the Membership. Output only.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -25,6 +25,7 @@
|
||||
},
|
||||
"id": "cloudiot:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudiot.mtls.googleapis.com/",
|
||||
"name": "cloudiot",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -123,7 +124,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The name of the registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
||||
"description": "Required. The name of the registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
||||
"required": true,
|
||||
@@ -152,7 +153,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.",
|
||||
"description": "Required. The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -181,7 +182,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
||||
"description": "Required. The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
||||
"required": true,
|
||||
@@ -207,7 +208,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
||||
"description": "Required. The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
||||
"required": true,
|
||||
@@ -273,7 +274,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.",
|
||||
"description": "Required. The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -306,7 +307,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config`, `http_config`,\n`mqtt_config`, and `state_notification_config`.",
|
||||
"description": "Required. Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config`, `http_config`,\n`mqtt_config`, and `state_notification_config`.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -392,7 +393,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The name of the registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
||||
"description": "Required. The name of the registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
||||
"required": true,
|
||||
@@ -425,7 +426,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
||||
"description": "Required. The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
||||
"required": true,
|
||||
@@ -454,7 +455,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"description": "Required. The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
||||
"required": true,
|
||||
@@ -486,7 +487,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"description": "Required. The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
||||
"required": true,
|
||||
@@ -562,7 +563,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
|
||||
"description": "Required. The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
|
||||
"required": true,
|
||||
@@ -588,7 +589,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"description": "Required. The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
||||
"required": true,
|
||||
@@ -624,7 +625,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `blocked`, and `metadata`",
|
||||
"description": "Required. Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `blocked`, and `metadata`",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -652,7 +653,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"description": "Required. The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
||||
"required": true,
|
||||
@@ -685,7 +686,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"description": "Required. The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
||||
"required": true,
|
||||
@@ -721,7 +722,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"description": "Required. The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$",
|
||||
"required": true,
|
||||
@@ -900,7 +901,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
|
||||
"description": "Required. The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
|
||||
"required": true,
|
||||
@@ -927,7 +928,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190618",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://cloudiot.googleapis.com/",
|
||||
"schemas": {
|
||||
"BindDeviceToGatewayRequest": {
|
||||
@@ -935,11 +936,11 @@
|
||||
"id": "BindDeviceToGatewayRequest",
|
||||
"properties": {
|
||||
"deviceId": {
|
||||
"description": "The device to associate with the specified gateway. The value of\n`device_id` can be either the device numeric ID or the user-defined device\nidentifier.",
|
||||
"description": "Required. The device to associate with the specified gateway. The value of\n`device_id` can be either the device numeric ID or the user-defined device\nidentifier.",
|
||||
"type": "string"
|
||||
},
|
||||
"gatewayId": {
|
||||
"description": "The value of `gateway_id` can be either the device numeric ID or the\nuser-defined device identifier.",
|
||||
"description": "Required. The value of `gateway_id` can be either the device numeric ID or the\nuser-defined device identifier.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -960,7 +961,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1216,23 +1217,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1287,7 +1288,24 @@
|
||||
"GetIamPolicyRequest": {
|
||||
"description": "Request message for `GetIamPolicy` method.",
|
||||
"id": "GetIamPolicyRequest",
|
||||
"properties": {},
|
||||
"properties": {
|
||||
"options": {
|
||||
"$ref": "GetPolicyOptions",
|
||||
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetPolicyOptions": {
|
||||
"description": "Encapsulates settings provided to GetIamPolicy.",
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"HttpConfig": {
|
||||
@@ -1380,7 +1398,7 @@
|
||||
"id": "ModifyCloudToDeviceConfigRequest",
|
||||
"properties": {
|
||||
"binaryData": {
|
||||
"description": "The configuration data for the device.",
|
||||
"description": "Required. The configuration data for the device.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1414,23 +1432,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -1509,7 +1527,7 @@
|
||||
"id": "SendCommandToDeviceRequest",
|
||||
"properties": {
|
||||
"binaryData": {
|
||||
"description": "The command data to send to the device.",
|
||||
"description": "Required. The command data to send to the device.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1608,11 +1626,11 @@
|
||||
"id": "UnbindDeviceFromGatewayRequest",
|
||||
"properties": {
|
||||
"deviceId": {
|
||||
"description": "The device to disassociate from the specified gateway. The value of\n`device_id` can be either the device numeric ID or the user-defined device\nidentifier.",
|
||||
"description": "Required. The device to disassociate from the specified gateway. The value of\n`device_id` can be either the device numeric ID or the user-defined device\nidentifier.",
|
||||
"type": "string"
|
||||
},
|
||||
"gatewayId": {
|
||||
"description": "The value of `gateway_id` can be either the device numeric ID or the\nuser-defined device identifier.",
|
||||
"description": "Required. The value of `gateway_id` can be either the device numeric ID or the\nuser-defined device identifier.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
},
|
||||
"id": "cloudkms:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudkms.mtls.googleapis.com/",
|
||||
"name": "cloudkms",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -227,7 +228,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the KeyRing to get.",
|
||||
"description": "Required. The name of the KeyRing to get.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
|
||||
"required": true,
|
||||
@@ -253,7 +254,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"options.requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
@@ -285,23 +286,23 @@
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "Optional. Only include resources that match the filter in the response\n(https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"description": "Optional. Only include resources that match the filter in the response. For\nmore information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"orderBy": {
|
||||
"description": "Optional. Specify how the results should be sorted. If not specified, the\nresults will be sorted in the default order\n(https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"description": "Optional. Specify how the results should be sorted. If not specified, the\nresults will be sorted in the default order. For more information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
|
||||
"description": "Optional. Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
|
||||
"description": "Optional. Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -323,7 +324,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudkms.projects.locations.keyRings.setIamPolicy",
|
||||
@@ -464,7 +465,7 @@
|
||||
"name": {
|
||||
"description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -491,7 +492,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the CryptoKey to get.",
|
||||
"description": "Required. The name of the CryptoKey to get.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
|
||||
"required": true,
|
||||
@@ -517,7 +518,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"options.requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
@@ -549,23 +550,23 @@
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "Optional. Only include resources that match the filter in the response\n(https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"description": "Optional. Only include resources that match the filter in the response. For\nmore information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"orderBy": {
|
||||
"description": "Optional. Specify how the results should be sorted. If not specified, the\nresults will be sorted in the default order\n(https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"description": "Optional. Specify how the results should be sorted. If not specified, the\nresults will be sorted in the default order. For more information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
|
||||
"description": "Optional. Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
|
||||
"description": "Optional. Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -612,7 +613,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Required list of fields to be updated in this request.",
|
||||
"description": "Required. List of fields to be updated in this request.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -631,7 +632,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
|
||||
@@ -698,7 +699,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the CryptoKey to update.",
|
||||
"description": "Required. The resource name of the CryptoKey to update.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
|
||||
"required": true,
|
||||
@@ -818,7 +819,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the CryptoKeyVersion to destroy.",
|
||||
"description": "Required. The resource name of the CryptoKeyVersion to destroy.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -847,7 +848,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the CryptoKeyVersion to get.",
|
||||
"description": "Required. The name of the CryptoKeyVersion to get.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -873,7 +874,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the CryptoKeyVersion public key to\nget.",
|
||||
"description": "Required. The name of the CryptoKeyVersion public key to\nget.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -928,23 +929,23 @@
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "Optional. Only include resources that match the filter in the response\n(https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"description": "Optional. Only include resources that match the filter in the response. For\nmore information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"orderBy": {
|
||||
"description": "Optional. Specify how the results should be sorted. If not specified, the\nresults will be sorted in the default order\n(https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"description": "Optional. Specify how the results should be sorted. If not specified, the\nresults will be sorted in the default order. For more information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
|
||||
"description": "Optional. Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
|
||||
"description": "Optional. Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -991,7 +992,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Required list of fields to be updated in this request.",
|
||||
"description": "Required. List of fields to be updated in this request.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -1019,7 +1020,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the CryptoKeyVersion to restore.",
|
||||
"description": "Required. The resource name of the CryptoKeyVersion to restore.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1088,7 +1089,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the ImportJob to get.",
|
||||
"description": "Required. The name of the ImportJob to get.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/importJobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -1114,7 +1115,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"options.requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
@@ -1146,23 +1147,23 @@
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "Optional. Only include resources that match the filter in the response\n(https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"description": "Optional. Only include resources that match the filter in the response. For\nmore information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"orderBy": {
|
||||
"description": "Optional. Specify how the results should be sorted. If not specified, the\nresults will be sorted in the default order\n(https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"description": "Optional. Specify how the results should be sorted. If not specified, the\nresults will be sorted in the default order. For more information, see\n[Sorting and filtering list\nresults](https://cloud.google.com/kms/docs/sorting-and-filtering).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "Optional limit on the number of ImportJobs to include in the\nresponse. Further ImportJobs can subsequently be obtained by\nincluding the ListImportJobsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
|
||||
"description": "Optional. Optional limit on the number of ImportJobs to include in the\nresponse. Further ImportJobs can subsequently be obtained by\nincluding the ListImportJobsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Optional pagination token, returned earlier via\nListImportJobsResponse.next_page_token.",
|
||||
"description": "Optional. Optional pagination token, returned earlier via\nListImportJobsResponse.next_page_token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1184,7 +1185,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs/{importJobsId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudkms.projects.locations.keyRings.importJobs.setIamPolicy",
|
||||
@@ -1250,7 +1251,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190626",
|
||||
"revision": "20200313",
|
||||
"rootUrl": "https://cloudkms.googleapis.com/",
|
||||
"schemas": {
|
||||
"AsymmetricDecryptRequest": {
|
||||
@@ -1301,7 +1302,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -1319,7 +1320,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -1357,7 +1358,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1397,10 +1398,10 @@
|
||||
},
|
||||
"primary": {
|
||||
"$ref": "CryptoKeyVersion",
|
||||
"description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion.\n\nAll keys with purpose\nENCRYPT_DECRYPT have a\nprimary. For other keys, this field will be omitted."
|
||||
"description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion.\n\nKeys with purpose\nENCRYPT_DECRYPT may have a\nprimary. For other keys, this field will be omitted."
|
||||
},
|
||||
"purpose": {
|
||||
"description": "The immutable purpose of this CryptoKey.",
|
||||
"description": "Immutable. The immutable purpose of this CryptoKey.",
|
||||
"enum": [
|
||||
"CRYPTO_KEY_PURPOSE_UNSPECIFIED",
|
||||
"ENCRYPT_DECRYPT",
|
||||
@@ -1449,7 +1450,8 @@
|
||||
"RSA_DECRYPT_OAEP_4096_SHA256",
|
||||
"RSA_DECRYPT_OAEP_4096_SHA512",
|
||||
"EC_SIGN_P256_SHA256",
|
||||
"EC_SIGN_P384_SHA384"
|
||||
"EC_SIGN_P384_SHA384",
|
||||
"EXTERNAL_SYMMETRIC_ENCRYPTION"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not specified.",
|
||||
@@ -1467,7 +1469,8 @@
|
||||
"RSAES-OAEP 4096 bit key with a SHA256 digest.",
|
||||
"RSAES-OAEP 4096 bit key with a SHA512 digest.",
|
||||
"ECDSA on the NIST P-256 curve with a SHA256 digest.",
|
||||
"ECDSA on the NIST P-384 curve with a SHA384 digest."
|
||||
"ECDSA on the NIST P-384 curve with a SHA384 digest.",
|
||||
"Algorithm representing symmetric encryption by an external key manager."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1490,6 +1493,10 @@
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"externalProtectionLevelOptions": {
|
||||
"$ref": "ExternalProtectionLevelOptions",
|
||||
"description": "ExternalProtectionLevelOptions stores a group of additional fields for\nconfiguring a CryptoKeyVersion that are specific to the\nEXTERNAL protection level."
|
||||
},
|
||||
"generateTime": {
|
||||
"description": "Output only. The time this CryptoKeyVersion's key material was\ngenerated.",
|
||||
"format": "google-datetime",
|
||||
@@ -1517,12 +1524,14 @@
|
||||
"enum": [
|
||||
"PROTECTION_LEVEL_UNSPECIFIED",
|
||||
"SOFTWARE",
|
||||
"HSM"
|
||||
"HSM",
|
||||
"EXTERNAL"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not specified.",
|
||||
"Crypto operations are performed in software.",
|
||||
"Crypto operations are performed in a Hardware Security Module."
|
||||
"Crypto operations are performed in a Hardware Security Module.",
|
||||
"Crypto operations are performed by an external key manager."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1575,7 +1584,8 @@
|
||||
"RSA_DECRYPT_OAEP_4096_SHA256",
|
||||
"RSA_DECRYPT_OAEP_4096_SHA512",
|
||||
"EC_SIGN_P256_SHA256",
|
||||
"EC_SIGN_P384_SHA384"
|
||||
"EC_SIGN_P384_SHA384",
|
||||
"EXTERNAL_SYMMETRIC_ENCRYPTION"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not specified.",
|
||||
@@ -1593,7 +1603,8 @@
|
||||
"RSAES-OAEP 4096 bit key with a SHA256 digest.",
|
||||
"RSAES-OAEP 4096 bit key with a SHA512 digest.",
|
||||
"ECDSA on the NIST P-256 curve with a SHA256 digest.",
|
||||
"ECDSA on the NIST P-384 curve with a SHA384 digest."
|
||||
"ECDSA on the NIST P-384 curve with a SHA384 digest.",
|
||||
"Algorithm representing symmetric encryption by an external key manager."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1602,12 +1613,14 @@
|
||||
"enum": [
|
||||
"PROTECTION_LEVEL_UNSPECIFIED",
|
||||
"SOFTWARE",
|
||||
"HSM"
|
||||
"HSM",
|
||||
"EXTERNAL"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not specified.",
|
||||
"Crypto operations are performed in software.",
|
||||
"Crypto operations are performed in a Hardware Security Module."
|
||||
"Crypto operations are performed in a Hardware Security Module.",
|
||||
"Crypto operations are performed by an external key manager."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
@@ -1619,7 +1632,7 @@
|
||||
"id": "DecryptRequest",
|
||||
"properties": {
|
||||
"additionalAuthenticatedData": {
|
||||
"description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
|
||||
"description": "Optional. Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1676,7 +1689,7 @@
|
||||
"id": "EncryptRequest",
|
||||
"properties": {
|
||||
"additionalAuthenticatedData": {
|
||||
"description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data.\n\nThe maximum size depends on the key version's\nprotection_level. For\nSOFTWARE keys, the AAD must be no larger than\n64KiB. For HSM keys, the combined length of the\nplaintext and additional_authenticated_data fields must be no larger than\n8KiB.",
|
||||
"description": "Optional. Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data.\n\nThe maximum size depends on the key version's\nprotection_level. For\nSOFTWARE keys, the AAD must be no larger than\n64KiB. For HSM keys, the combined length of the\nplaintext and additional_authenticated_data fields must be no larger than\n8KiB.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1698,30 +1711,41 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "The resource name of the CryptoKeyVersion used in encryption.",
|
||||
"description": "The resource name of the CryptoKeyVersion used in encryption. Check\nthis field to verify that the intended resource was used for encryption.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ExternalProtectionLevelOptions": {
|
||||
"description": "ExternalProtectionLevelOptions stores a group of additional fields for\nconfiguring a CryptoKeyVersion that are specific to the\nEXTERNAL protection level.",
|
||||
"id": "ExternalProtectionLevelOptions",
|
||||
"properties": {
|
||||
"externalKeyUri": {
|
||||
"description": "The URI for an external resource that this CryptoKeyVersion represents.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1749,7 +1773,8 @@
|
||||
"RSA_DECRYPT_OAEP_4096_SHA256",
|
||||
"RSA_DECRYPT_OAEP_4096_SHA512",
|
||||
"EC_SIGN_P256_SHA256",
|
||||
"EC_SIGN_P384_SHA384"
|
||||
"EC_SIGN_P384_SHA384",
|
||||
"EXTERNAL_SYMMETRIC_ENCRYPTION"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not specified.",
|
||||
@@ -1767,7 +1792,8 @@
|
||||
"RSAES-OAEP 4096 bit key with a SHA256 digest.",
|
||||
"RSAES-OAEP 4096 bit key with a SHA512 digest.",
|
||||
"ECDSA on the NIST P-256 curve with a SHA256 digest.",
|
||||
"ECDSA on the NIST P-384 curve with a SHA384 digest."
|
||||
"ECDSA on the NIST P-384 curve with a SHA384 digest.",
|
||||
"Algorithm representing symmetric encryption by an external key manager."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1776,7 +1802,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"rsaAesWrappedKey": {
|
||||
"description": "Wrapped key material produced with\nRSA_OAEP_3072_SHA1_AES_256\nor\nRSA_OAEP_4096_SHA1_AES_256.\n\nThis field contains the concatenation of two wrapped keys:\n<ol>\n <li>An ephemeral AES-256 wrapping key wrapped with the\n public_key using RSAES-OAEP with SHA-1,\n MGF1 with SHA-1, and an empty label.\n </li>\n <li>The key to be imported, wrapped with the ephemeral AES-256 key\n using AES-KWP (RFC 5649).\n </li>\n</ol>\n\nThis format is the same as the format produced by PKCS#11 mechanism\nCKM_RSA_AES_KEY_WRAP.",
|
||||
"description": "Wrapped key material produced with\nRSA_OAEP_3072_SHA1_AES_256\nor\nRSA_OAEP_4096_SHA1_AES_256.\n\nThis field contains the concatenation of two wrapped keys:\n<ol>\n <li>An ephemeral AES-256 wrapping key wrapped with the\n public_key using RSAES-OAEP with SHA-1,\n MGF1 with SHA-1, and an empty label.\n </li>\n <li>The key to be imported, wrapped with the ephemeral AES-256 key\n using AES-KWP (RFC 5649).\n </li>\n</ol>\n\nIf importing symmetric key material, it is expected that the unwrapped\nkey contains plain bytes. If importing asymmetric key material, it is\nexpected that the unwrapped key is in PKCS#8-encoded DER format (the\nPrivateKeyInfo structure from RFC 5208).\n\nThis format is the same as the format produced by PKCS#11 mechanism\nCKM_RSA_AES_KEY_WRAP.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -1812,7 +1838,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"importMethod": {
|
||||
"description": "Required and immutable. The wrapping method to be used for incoming\nkey material.",
|
||||
"description": "Required. Immutable. The wrapping method to be used for incoming key material.",
|
||||
"enum": [
|
||||
"IMPORT_METHOD_UNSPECIFIED",
|
||||
"RSA_OAEP_3072_SHA1_AES_256",
|
||||
@@ -1830,16 +1856,18 @@
|
||||
"type": "string"
|
||||
},
|
||||
"protectionLevel": {
|
||||
"description": "Required and immutable. The protection level of the ImportJob. This\nmust match the\nprotection_level of the\nversion_template on the CryptoKey you\nattempt to import into.",
|
||||
"description": "Required. Immutable. The protection level of the ImportJob. This must match the\nprotection_level of the\nversion_template on the CryptoKey you\nattempt to import into.",
|
||||
"enum": [
|
||||
"PROTECTION_LEVEL_UNSPECIFIED",
|
||||
"SOFTWARE",
|
||||
"HSM"
|
||||
"HSM",
|
||||
"EXTERNAL"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not specified.",
|
||||
"Crypto operations are performed in software.",
|
||||
"Crypto operations are performed in a Hardware Security Module."
|
||||
"Crypto operations are performed in a Hardware Security Module.",
|
||||
"Crypto operations are performed by an external key manager."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -2056,6 +2084,10 @@
|
||||
"description": "Cloud KMS metadata for the given google.cloud.location.Location.",
|
||||
"id": "LocationMetadata",
|
||||
"properties": {
|
||||
"ekmAvailable": {
|
||||
"description": "Indicates whether CryptoKeys with\nprotection_level\nEXTERNAL can be created in this location.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"hsmAvailable": {
|
||||
"description": "Indicates whether CryptoKeys with\nprotection_level\nHSM can be created in this location.",
|
||||
"type": "boolean"
|
||||
@@ -2064,7 +2096,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -2075,19 +2107,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -2116,7 +2148,8 @@
|
||||
"RSA_DECRYPT_OAEP_4096_SHA256",
|
||||
"RSA_DECRYPT_OAEP_4096_SHA512",
|
||||
"EC_SIGN_P256_SHA256",
|
||||
"EC_SIGN_P384_SHA384"
|
||||
"EC_SIGN_P384_SHA384",
|
||||
"EXTERNAL_SYMMETRIC_ENCRYPTION"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not specified.",
|
||||
@@ -2134,7 +2167,8 @@
|
||||
"RSAES-OAEP 4096 bit key with a SHA256 digest.",
|
||||
"RSAES-OAEP 4096 bit key with a SHA512 digest.",
|
||||
"ECDSA on the NIST P-256 curve with a SHA256 digest.",
|
||||
"ECDSA on the NIST P-384 curve with a SHA384 digest."
|
||||
"ECDSA on the NIST P-384 curve with a SHA384 digest.",
|
||||
"Algorithm representing symmetric encryption by an external key manager."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -2200,7 +2234,7 @@
|
||||
"id": "UpdateCryptoKeyPrimaryVersionRequest",
|
||||
"properties": {
|
||||
"cryptoKeyVersionId": {
|
||||
"description": "The id of the child CryptoKeyVersion to use as primary.",
|
||||
"description": "Required. The id of the child CryptoKeyVersion to use as primary.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudprivatecatalog:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudprivatecatalog.mtls.googleapis.com/",
|
||||
"name": "cloudprivatecatalog",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -522,7 +523,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190622",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://cloudprivatecatalog.googleapis.com/",
|
||||
"schemas": {
|
||||
"GoogleCloudPrivatecatalogV1beta1Catalog": {
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudprivatecatalogproducer:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudprivatecatalogproducer.mtls.googleapis.com/",
|
||||
"name": "cloudprivatecatalogproducer",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -188,6 +189,12 @@
|
||||
"resource"
|
||||
],
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
@@ -967,7 +974,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190622",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://cloudprivatecatalogproducer.googleapis.com/",
|
||||
"schemas": {
|
||||
"GoogleCloudPrivatecatalogproducerV1beta1Association": {
|
||||
@@ -1206,7 +1213,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIamV1AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "GoogleIamV1AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -1224,7 +1231,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIamV1AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "GoogleIamV1AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -1262,7 +1269,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1276,7 +1283,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleIamV1Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "GoogleIamV1Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -1287,19 +1294,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "GoogleIamV1Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -1443,23 +1450,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleTypeExpr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "GoogleTypeExpr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -28,6 +28,7 @@
|
||||
},
|
||||
"id": "cloudprofiler:v2",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudprofiler.mtls.googleapis.com/",
|
||||
"name": "cloudprofiler",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -215,7 +216,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190629",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://cloudprofiler.googleapis.com/",
|
||||
"schemas": {
|
||||
"CreateProfileRequest": {
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
},
|
||||
"id": "cloudresourcemanager:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudresourcemanager.mtls.googleapis.com/",
|
||||
"name": "cloudresourcemanager",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -314,9 +315,9 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name/identifier of the Lien to delete.",
|
||||
"description": "Required. The name/identifier of the Lien to delete.",
|
||||
"location": "path",
|
||||
"pattern": "^liens/.+$",
|
||||
"pattern": "^liens/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -340,9 +341,9 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name/identifier of the Lien.",
|
||||
"description": "Required. The name/identifier of the Lien.",
|
||||
"location": "path",
|
||||
"pattern": "^liens/.+$",
|
||||
"pattern": "^liens/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -375,7 +376,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
|
||||
"description": "Required. The name of the resource to list all attached Liens.\nFor example, `projects/1234`.\n\n(google.api.field_policy).resource_type annotation is not set since the\nparent depends on the meta api implementation. This field could be a\nproject or other sub project resources.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -405,7 +406,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -759,7 +760,7 @@
|
||||
]
|
||||
},
|
||||
"create": {
|
||||
"description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject. The parent is identified by a specified ResourceId,\nwhich must include both an ID and a type, such as organization.\n\nThis method does not associate the new project with a billing account.\nYou can set or update the billing account associated with a project using\nthe [`projects.updateBillingInfo`]\n(/billing/reference/rest/v1/projects/updateBillingInfo) method.",
|
||||
"description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. This process usually takes a few\nseconds, but can sometimes take much longer. The tracking Operation is\nautomatically deleted after a few hours, so there is no need to call\nDeleteOperation.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject. The parent is identified by a specified ResourceId,\nwhich must include both an ID and a type, such as organization.\n\nThis method does not associate the new project with a billing account.\nYou can set or update the billing account associated with a project using\nthe [`projects.updateBillingInfo`]\n(/billing/reference/rest/v1/projects/updateBillingInfo) method.",
|
||||
"flatPath": "v1/projects",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudresourcemanager.projects.create",
|
||||
@@ -1031,7 +1032,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ You can only grant ownership of a project to a member by using the\nGCP Console. Inviting a member will deliver an invitation email that\nthey must accept. An invitation email is not generated if you are\ngranting a role other than owner, or if both the member you are inviting\nand the project are part of your organization.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project",
|
||||
"description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted to a `user`, `serviceAccount`, or a group\nthat is part of an organization. For example,\ngroup@myownpersonaldomain.com could be added as an owner to a project in\nthe myownpersonaldomain.com organization, but not the examplepetstore.com\norganization.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ You can only grant ownership of a project to a member by using the\nGCP Console. Inviting a member will deliver an invitation email that\nthey must accept. An invitation email is not generated if you are\ngranting a role other than owner, or if both the member you are inviting\nand the project are part of your organization.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project",
|
||||
"flatPath": "v1/projects/{resource}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudresourcemanager.projects.setIamPolicy",
|
||||
@@ -1170,7 +1171,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190701",
|
||||
"revision": "20200408",
|
||||
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
|
||||
"schemas": {
|
||||
"Ancestor": {
|
||||
@@ -1185,7 +1186,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -1203,7 +1204,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -1241,7 +1242,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1340,23 +1341,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1488,7 +1489,7 @@
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -1632,7 +1633,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"ListPolicy": {
|
||||
"description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\n`ListPolicy` can define specific values and subtrees of Cloud Resource\nManager resource hierarchy (`Organizations`, `Folders`, `Projects`) that\nare allowed or denied by setting the `allowed_values` and `denied_values`\nfields. This is achieved by using the `under:` and optional `is:` prefixes.\nThe `under:` prefix is used to denote resource subtree values.\nThe `is:` prefix is used to denote specific values, and is required only\nif the value contains a \":\". Values prefixed with \"is:\" are treated the\nsame as values with no prefix.\nAncestry subtrees must be in one of the following formats:\n - \u201cprojects/<project-id>\u201d, e.g. \u201cprojects/tokyo-rain-123\u201d\n - \u201cfolders/<folder-id>\u201d, e.g. \u201cfolders/1234\u201d\n - \u201corganizations/<organization-id>\u201d, e.g. \u201corganizations/1234\u201d\nThe `supports_under` field of the associated `Constraint` defines whether\nancestry prefixes can be used. You can set `allowed_values` and\n`denied_values` in the same `Policy` if `all_values` is\n`ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all\nvalues. If `all_values` is set to either `ALLOW` or `DENY`,\n`allowed_values` and `denied_values` must be unset.",
|
||||
"description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\n`ListPolicy` can define specific values and subtrees of Cloud Resource\nManager resource hierarchy (`Organizations`, `Folders`, `Projects`) that\nare allowed or denied by setting the `allowed_values` and `denied_values`\nfields. This is achieved by using the `under:` and optional `is:` prefixes.\nThe `under:` prefix is used to denote resource subtree values.\nThe `is:` prefix is used to denote specific values, and is required only\nif the value contains a \":\". Values prefixed with \"is:\" are treated the\nsame as values with no prefix.\nAncestry subtrees must be in one of the following formats:\n - \"projects/<project-id>\", e.g. \"projects/tokyo-rain-123\"\n - \"folders/<folder-id>\", e.g. \"folders/1234\"\n - \"organizations/<organization-id>\", e.g. \"organizations/1234\"\nThe `supports_under` field of the associated `Constraint` defines whether\nancestry prefixes can be used. You can set `allowed_values` and\n`denied_values` in the same `Policy` if `all_values` is\n`ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all\nvalues. If `all_values` is set to either `ALLOW` or `DENY`,\n`allowed_values` and `denied_values` must be unset.",
|
||||
"id": "ListPolicy",
|
||||
"properties": {
|
||||
"allValues": {
|
||||
@@ -1664,7 +1665,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"inheritFromParent": {
|
||||
"description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings for\n`projects/bar` parented by `organizations/foo`:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \u201cE1\u201d allowed_values:\u201dE2\u201d}\n `projects/bar` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \u201cE1\u201d allowed_values:\u201dE2\u201d}\n `projects/bar` has a `Policy` with values:\n {value: \u201cE3\u201d value: \u201dE4\u201d inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \u201cE1\u201d allowed_values:\u201dE2\u201d}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \u201cE1\u201d allowed_values: \u201dE2\u201d}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \u201cE1\u201d allowed_values: \u201dE2\u201d}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.\n\nExample 10 (allowed and denied subtrees of Resource Manager hierarchy):\nGiven the following resource hierarchy\n O1->{F1, F2}; F1->{P1}; F2->{P2, P3},\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"under:organizations/O1\"}\n `projects/bar` has a `Policy` with:\n {allowed_values: \"under:projects/P3\"}\n {denied_values: \"under:folders/F2\"}\nThe accepted values at `organizations/foo` are `organizations/O1`,\n `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`,\n `projects/P3`.\nThe accepted values at `projects/bar` are `organizations/O1`,\n `folders/F1`, `projects/P1`.",
|
||||
"description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings for\n`projects/bar` parented by `organizations/foo`:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values:\"E2\"}\n `projects/bar` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values:\"E2\"}\n `projects/bar` has a `Policy` with values:\n {value: \"E3\" value: \"E4\" inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values:\"E2\"}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.\n\nExample 10 (allowed and denied subtrees of Resource Manager hierarchy):\nGiven the following resource hierarchy\n O1->{F1, F2}; F1->{P1}; F2->{P2, P3},\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"under:organizations/O1\"}\n `projects/bar` has a `Policy` with:\n {allowed_values: \"under:projects/P3\"}\n {denied_values: \"under:folders/F2\"}\nThe accepted values at `organizations/foo` are `organizations/O1`,\n `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`,\n `projects/P3`.\nThe accepted values at `projects/bar` are `organizations/O1`,\n `folders/F1`, `projects/P1`.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"suggestedValue": {
|
||||
@@ -1770,16 +1771,16 @@
|
||||
"id": "Organization",
|
||||
"properties": {
|
||||
"creationTime": {
|
||||
"description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
|
||||
"description": "Timestamp when the Organization was created. Assigned by the server.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"displayName": {
|
||||
"description": "A human-readable string that refers to the Organization in the\nGCP Console UI. This string is set by the server and cannot be\nchanged. The string will be set to the primary domain (for example,\n\"google.com\") of the G Suite customer that owns the organization.\n@OutputOnly",
|
||||
"description": "A human-readable string that refers to the Organization in the\nGCP Console UI. This string is set by the server and cannot be\nchanged. The string will be set to the primary domain (for example,\n\"google.com\") of the G Suite customer that owns the organization.",
|
||||
"type": "string"
|
||||
},
|
||||
"lifecycleState": {
|
||||
"description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
|
||||
"description": "The organization's current lifecycle state. Assigned by the server.",
|
||||
"enum": [
|
||||
"LIFECYCLE_STATE_UNSPECIFIED",
|
||||
"ACTIVE",
|
||||
@@ -1793,7 +1794,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
|
||||
"description": "Output only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
|
||||
"type": "string"
|
||||
},
|
||||
"owner": {
|
||||
@@ -1815,7 +1816,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -1826,19 +1827,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -1926,7 +1927,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\" and \"folder\".",
|
||||
"description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\", \"folder\", and \"project\".",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
},
|
||||
"id": "cloudresourcemanager:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudresourcemanager.mtls.googleapis.com/",
|
||||
"name": "cloudresourcemanager",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -269,7 +270,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
|
||||
"description": "Output only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
|
||||
"location": "path",
|
||||
"pattern": "^organizations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -299,7 +300,7 @@
|
||||
"parameterOrder": [],
|
||||
"parameters": {
|
||||
"useLegacyStack": {
|
||||
"description": "A safety hatch to opt out of the new reliable project creation process.",
|
||||
"description": "A now unused experiment opt-out option.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
}
|
||||
@@ -454,7 +455,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.",
|
||||
"description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted to a `user`, `serviceAccount`, or a group\nthat is part of an organization. For example,\ngroup@myownpersonaldomain.com could be added as an owner to a project in\nthe myownpersonaldomain.com organization, but not the examplepetstore.com\norganization.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.",
|
||||
"flatPath": "v1beta1/projects/{resource}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudresourcemanager.projects.setIamPolicy",
|
||||
@@ -565,7 +566,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190701",
|
||||
"revision": "20200408",
|
||||
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
|
||||
"schemas": {
|
||||
"Ancestor": {
|
||||
@@ -580,7 +581,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -598,7 +599,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -636,7 +637,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -656,23 +657,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -782,7 +783,7 @@
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -830,16 +831,16 @@
|
||||
"id": "Organization",
|
||||
"properties": {
|
||||
"creationTime": {
|
||||
"description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
|
||||
"description": "Timestamp when the Organization was created. Assigned by the server.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"displayName": {
|
||||
"description": "A human-readable string that refers to the Organization in the\nGCP Console UI. This string is set by the server and cannot be\nchanged. The string will be set to the primary domain (for example,\n\"google.com\") of the G Suite customer that owns the organization.\n@OutputOnly",
|
||||
"description": "A human-readable string that refers to the Organization in the\nGCP Console UI. This string is set by the server and cannot be\nchanged. The string will be set to the primary domain (for example,\n\"google.com\") of the G Suite customer that owns the organization.",
|
||||
"type": "string"
|
||||
},
|
||||
"lifecycleState": {
|
||||
"description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
|
||||
"description": "The organization's current lifecycle state. Assigned by the server.",
|
||||
"enum": [
|
||||
"LIFECYCLE_STATE_UNSPECIFIED",
|
||||
"ACTIVE",
|
||||
@@ -853,7 +854,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
|
||||
"description": "Output only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
|
||||
"type": "string"
|
||||
},
|
||||
"organizationId": {
|
||||
@@ -879,7 +880,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -890,19 +891,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
},
|
||||
"id": "cloudresourcemanager:v2",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudresourcemanager.mtls.googleapis.com/",
|
||||
"name": "cloudresourcemanager",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -117,7 +118,7 @@
|
||||
"parameterOrder": [],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
|
||||
"description": "Required. The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -143,7 +144,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
|
||||
"description": "Required. the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+$",
|
||||
"required": true,
|
||||
@@ -168,7 +169,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
|
||||
"description": "Required. The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+$",
|
||||
"required": true,
|
||||
@@ -221,23 +222,23 @@
|
||||
"parameterOrder": [],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "The maximum number of Folders to return in the response.\nThis field is optional.",
|
||||
"description": "Optional. The maximum number of Folders to return in the response.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
|
||||
"description": "Optional. A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
|
||||
"description": "Required. The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"showDeleted": {
|
||||
"description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false. This field is optional.",
|
||||
"description": "Optional. Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
}
|
||||
@@ -261,7 +262,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
|
||||
"description": "Required. The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+$",
|
||||
"required": true,
|
||||
@@ -296,7 +297,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Fields to be updated.\nOnly the `display_name` can be updated.",
|
||||
"description": "Required. Fields to be updated.\nOnly the `display_name` can be updated.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -398,7 +399,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
|
||||
"description": "Required. The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+$",
|
||||
"required": true,
|
||||
@@ -432,7 +433,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -449,11 +450,11 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190701",
|
||||
"revision": "20200408",
|
||||
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
|
||||
"schemas": {
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -471,7 +472,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -509,7 +510,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -523,23 +524,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -577,7 +578,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The Folder\u2019s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.",
|
||||
"description": "Required. The Folder\u2019s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -667,7 +668,7 @@
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -686,7 +687,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.",
|
||||
"description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -697,7 +698,7 @@
|
||||
"id": "MoveFolderRequest",
|
||||
"properties": {
|
||||
"destinationParent": {
|
||||
"description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
|
||||
"description": "Required. The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -739,7 +740,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -750,19 +751,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -794,12 +795,12 @@
|
||||
"id": "SearchFoldersRequest",
|
||||
"properties": {
|
||||
"pageSize": {
|
||||
"description": "The maximum number of folders to return in the response.\nThis field is optional.",
|
||||
"description": "Optional. The maximum number of folders to return in the response.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.",
|
||||
"description": "Optional. A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.",
|
||||
"type": "string"
|
||||
},
|
||||
"query": {
|
||||
@@ -821,7 +822,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional.",
|
||||
"description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -25,6 +25,7 @@
|
||||
},
|
||||
"id": "cloudresourcemanager:v2beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudresourcemanager.mtls.googleapis.com/",
|
||||
"name": "cloudresourcemanager",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -117,7 +118,7 @@
|
||||
"parameterOrder": [],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
|
||||
"description": "Required. The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -143,7 +144,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
|
||||
"description": "Required. the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+$",
|
||||
"required": true,
|
||||
@@ -168,7 +169,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
|
||||
"description": "Required. The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+$",
|
||||
"required": true,
|
||||
@@ -221,23 +222,23 @@
|
||||
"parameterOrder": [],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "The maximum number of Folders to return in the response.\nThis field is optional.",
|
||||
"description": "Optional. The maximum number of Folders to return in the response.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
|
||||
"description": "Optional. A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
|
||||
"description": "Required. The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"showDeleted": {
|
||||
"description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false. This field is optional.",
|
||||
"description": "Optional. Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned. Defaults to false.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
}
|
||||
@@ -261,7 +262,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
|
||||
"description": "Required. The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+$",
|
||||
"required": true,
|
||||
@@ -296,7 +297,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Fields to be updated.\nOnly the `display_name` can be updated.",
|
||||
"description": "Required. Fields to be updated.\nOnly the `display_name` can be updated.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -398,7 +399,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
|
||||
"description": "Required. The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
|
||||
"location": "path",
|
||||
"pattern": "^folders/[^/]+$",
|
||||
"required": true,
|
||||
@@ -432,7 +433,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -449,11 +450,11 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190701",
|
||||
"revision": "20200408",
|
||||
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
|
||||
"schemas": {
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -471,7 +472,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -509,7 +510,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -523,23 +524,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -577,7 +578,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The Folder\u2019s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.",
|
||||
"description": "Required. The Folder\u2019s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -667,7 +668,7 @@
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"requestedPolicyVersion": {
|
||||
"description": "Optional. The policy format version to be returned.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -686,7 +687,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.",
|
||||
"description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -697,7 +698,7 @@
|
||||
"id": "MoveFolderRequest",
|
||||
"properties": {
|
||||
"destinationParent": {
|
||||
"description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
|
||||
"description": "Required. The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -739,7 +740,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -750,19 +751,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -794,12 +795,12 @@
|
||||
"id": "SearchFoldersRequest",
|
||||
"properties": {
|
||||
"pageSize": {
|
||||
"description": "The maximum number of folders to return in the response.\nThis field is optional.",
|
||||
"description": "Optional. The maximum number of folders to return in the response.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.",
|
||||
"description": "Optional. A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.",
|
||||
"type": "string"
|
||||
},
|
||||
"query": {
|
||||
@@ -821,7 +822,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional.",
|
||||
"description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudscheduler:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudscheduler.mtls.googleapis.com/",
|
||||
"name": "cloudscheduler",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -188,7 +189,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
|
||||
"description": "Required. The location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -216,7 +217,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"description": "Required. The job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -241,7 +242,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"description": "Required. The job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -277,7 +278,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
|
||||
"description": "Required. The location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -336,7 +337,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"description": "Required. The job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -364,7 +365,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"description": "Required. The job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -392,7 +393,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"description": "Required. The job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -417,7 +418,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190617",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://cloudscheduler.googleapis.com/",
|
||||
"schemas": {
|
||||
"AppEngineHttpTarget": {
|
||||
@@ -549,7 +550,7 @@
|
||||
"description": "If specified, an\n[OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)\ntoken will be generated and attached as an `Authorization` header in the\nHTTP request.\n\nThis type of authorization can be used for many scenarios, including\ncalling Cloud Run, or endpoints where you intend to validate the token\nyourself."
|
||||
},
|
||||
"uri": {
|
||||
"description": "Required.\n\nThe full URI path that the request will be sent to. This string\nmust begin with either \"http://\" or \"https://\". Some examples of\nvalid values for uri are:\n`http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will\nencode some characters for safety and compatibility. The maximum allowed\nURL length is 2083 characters after encoding.",
|
||||
"description": "Required. The full URI path that the request will be sent to. This string\nmust begin with either \"http://\" or \"https://\". Some examples of\nvalid values for uri are:\n`http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will\nencode some characters for safety and compatibility. The maximum allowed\nURL length is 2083 characters after encoding.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -750,7 +751,7 @@
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Optional attributes for this message.",
|
||||
"description": "Attributes for this message. If this field is empty, the message must\ncontain non-empty data.",
|
||||
"type": "object"
|
||||
},
|
||||
"data": {
|
||||
@@ -787,7 +788,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"topicName": {
|
||||
"description": "Required.\n\nThe name of the Cloud Pub/Sub topic to which messages will\nbe published when a job is delivered. The topic name must be in the\nsame format as required by PubSub's\n[PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),\nfor example `projects/PROJECT_ID/topics/TOPIC_ID`.\n\nThe topic must be in the same project as the Cloud Scheduler job.",
|
||||
"description": "Required. The name of the Cloud Pub/Sub topic to which messages will\nbe published when a job is delivered. The topic name must be in the\nsame format as required by PubSub's\n[PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),\nfor example `projects/PROJECT_ID/topics/TOPIC_ID`.\n\nThe topic must be in the same project as the Cloud Scheduler job.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudscheduler:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudscheduler.mtls.googleapis.com/",
|
||||
"name": "cloudscheduler",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -188,7 +189,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
|
||||
"description": "Required. The location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -216,7 +217,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"description": "Required. The job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -241,7 +242,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"description": "Required. The job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -277,7 +278,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
|
||||
"description": "Required. The location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -336,7 +337,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"description": "Required. The job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -364,7 +365,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"description": "Required. The job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -392,7 +393,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"description": "Required. The job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -417,7 +418,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190617",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://cloudscheduler.googleapis.com/",
|
||||
"schemas": {
|
||||
"AppEngineHttpTarget": {
|
||||
@@ -549,7 +550,7 @@
|
||||
"description": "If specified, an\n[OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)\ntoken will be generated and attached as an `Authorization` header in the\nHTTP request.\n\nThis type of authorization can be used for many scenarios, including\ncalling Cloud Run, or endpoints where you intend to validate the token\nyourself."
|
||||
},
|
||||
"uri": {
|
||||
"description": "Required.\n\nThe full URI path that the request will be sent to. This string\nmust begin with either \"http://\" or \"https://\". Some examples of\nvalid values for uri are:\n`http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will\nencode some characters for safety and compatibility. The maximum allowed\nURL length is 2083 characters after encoding.",
|
||||
"description": "Required. The full URI path that the request will be sent to. This string\nmust begin with either \"http://\" or \"https://\". Some examples of\nvalid values for uri are:\n`http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will\nencode some characters for safety and compatibility. The maximum allowed\nURL length is 2083 characters after encoding.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -750,7 +751,7 @@
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "Optional attributes for this message.",
|
||||
"description": "Attributes for this message. If this field is empty, the message must\ncontain non-empty data.",
|
||||
"type": "object"
|
||||
},
|
||||
"data": {
|
||||
@@ -787,7 +788,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"topicName": {
|
||||
"description": "Required.\n\nThe name of the Cloud Pub/Sub topic to which messages will\nbe published when a job is delivered. The topic name must be in the\nsame format as required by PubSub's\n[PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),\nfor example `projects/PROJECT_ID/topics/TOPIC_ID`.\n\nThe topic must be in the same project as the Cloud Scheduler job.",
|
||||
"description": "Required. The name of the Cloud Pub/Sub topic to which messages will\nbe published when a job is delivered. The topic name must be in the\nsame format as required by PubSub's\n[PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),\nfor example `projects/PROJECT_ID/topics/TOPIC_ID`.\n\nThe topic must be in the same project as the Cloud Scheduler job.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudshell:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudshell.mtls.googleapis.com/",
|
||||
"name": "cloudshell",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -118,7 +119,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource to be cancelled.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -146,7 +147,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource to be deleted.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -171,7 +172,7 @@
|
||||
"name": {
|
||||
"description": "The name of the operation resource.",
|
||||
"location": "path",
|
||||
"pattern": "^operations/.+$",
|
||||
"pattern": "^operations/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
@@ -228,7 +229,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190701",
|
||||
"revision": "20200409",
|
||||
"rootUrl": "https://cloudshell.googleapis.com/",
|
||||
"schemas": {
|
||||
"CancelOperationRequest": {
|
||||
@@ -252,7 +253,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"description": "Output only. The environment's identifier, which is always \"default\".",
|
||||
"description": "Output only. The environment's identifier, unique among the user's\nenvironments.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
@@ -266,6 +267,20 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"size": {
|
||||
"description": "Indicates the size of the backing VM running the environment. If set to\nsomething other than DEFAULT, it will be reverted to the default VM size\nafter vm_size_expire_time.",
|
||||
"enum": [
|
||||
"VM_SIZE_UNSPECIFIED",
|
||||
"DEFAULT",
|
||||
"BOOSTED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The VM size is unknown.",
|
||||
"The default VM size.",
|
||||
"The boosted VM size."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"sshHost": {
|
||||
"description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
|
||||
"type": "string"
|
||||
@@ -294,6 +309,23 @@
|
||||
"The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"vmSizeExpireTime": {
|
||||
"description": "Output only. The time when the Environment will expire back to the default\nVM size.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"webHost": {
|
||||
"description": "Output only. Host to which clients can connect to initiate HTTPS or WSS\nconnections with the environment.",
|
||||
"type": "string"
|
||||
},
|
||||
"webPorts": {
|
||||
"description": "Output only. Ports to which clients can connect to initiate HTTPS or WSS\nconnections with the environment.",
|
||||
"items": {
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -397,12 +429,16 @@
|
||||
"STATE_UNSPECIFIED",
|
||||
"STARTING",
|
||||
"UNARCHIVING_DISK",
|
||||
"AWAITING_VM",
|
||||
"AWAITING_COMPUTE_RESOURCES",
|
||||
"FINISHED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The environment's start state is unknown.",
|
||||
"The environment is in the process of being started, but no additional\ndetails are available.",
|
||||
"Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.",
|
||||
"Startup is waiting for a VM to be assigned to the environment. This\nshould normally happen very quickly, but an environment might stay in\nthis state for an extended period of time if the system is experiencing\nheavy load.",
|
||||
"Startup is waiting for compute resources to be assigned to the\nenvironment. This should normally happen very quickly, but an environment\nmight stay in this state for an extended period of time if the system is\nexperiencing heavy load.",
|
||||
"Startup is complete and the user should be able to establish an SSH\nconnection to their environment."
|
||||
],
|
||||
"type": "string"
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudshell:v1alpha1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudshell.mtls.googleapis.com/",
|
||||
"name": "cloudshell",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -287,7 +288,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190701",
|
||||
"revision": "20200409",
|
||||
"rootUrl": "https://cloudshell.googleapis.com/",
|
||||
"schemas": {
|
||||
"AuthorizeEnvironmentRequest": {
|
||||
@@ -336,7 +337,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"description": "Output only. The environment's identifier, which is always \"default\".",
|
||||
"description": "Output only. The environment's identifier, unique among the user's\nenvironments.",
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
@@ -350,6 +351,20 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"size": {
|
||||
"description": "Indicates the size of the backing VM running the environment. If set to\nsomething other than DEFAULT, it will be reverted to the default VM size\nafter vm_size_expire_time.",
|
||||
"enum": [
|
||||
"VM_SIZE_UNSPECIFIED",
|
||||
"DEFAULT",
|
||||
"BOOSTED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The VM size is unknown.",
|
||||
"The default VM size.",
|
||||
"The boosted VM size."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"sshHost": {
|
||||
"description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.",
|
||||
"type": "string"
|
||||
@@ -378,6 +393,23 @@
|
||||
"The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"vmSizeExpireTime": {
|
||||
"description": "Output only. The time when the Environment will expire back to the default\nVM size.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"webHost": {
|
||||
"description": "Output only. Host to which clients can connect to initiate HTTPS or WSS\nconnections with the environment.",
|
||||
"type": "string"
|
||||
},
|
||||
"webPorts": {
|
||||
"description": "Output only. Ports to which clients can connect to initiate HTTPS or WSS\nconnections with the environment.",
|
||||
"items": {
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -463,12 +495,16 @@
|
||||
"STATE_UNSPECIFIED",
|
||||
"STARTING",
|
||||
"UNARCHIVING_DISK",
|
||||
"AWAITING_VM",
|
||||
"AWAITING_COMPUTE_RESOURCES",
|
||||
"FINISHED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The environment's start state is unknown.",
|
||||
"The environment is in the process of being started, but no additional\ndetails are available.",
|
||||
"Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.",
|
||||
"Startup is waiting for a VM to be assigned to the environment. This\nshould normally happen very quickly, but an environment might stay in\nthis state for an extended period of time if the system is experiencing\nheavy load.",
|
||||
"Startup is waiting for compute resources to be assigned to the\nenvironment. This should normally happen very quickly, but an environment\nmight stay in this state for an extended period of time if the system is\nexperiencing heavy load.",
|
||||
"Startup is complete and the user should be able to establish an SSH\nconnection to their environment."
|
||||
],
|
||||
"type": "string"
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudtasks:v2",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudtasks.mtls.googleapis.com/",
|
||||
"name": "cloudtasks",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -188,7 +189,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\nListLocations.",
|
||||
"description": "Required. The location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\nListLocations.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -216,7 +217,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -241,7 +242,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -310,7 +311,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
|
||||
"description": "Required. The location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -369,7 +370,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -397,7 +398,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -425,7 +426,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -513,7 +514,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -541,7 +542,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -566,7 +567,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -612,7 +613,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -647,7 +648,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -674,16 +675,16 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190618",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://cloudtasks.googleapis.com/",
|
||||
"schemas": {
|
||||
"AppEngineHttpRequest": {
|
||||
"description": "App Engine HTTP request.\n\nThe message defines the HTTP request that is sent to an App Engine app when\nthe task is dispatched.\n\nUsing AppEngineHttpRequest requires\n[`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`\n\nThe task will be delivered to the App Engine app which belongs to the same\nproject as the queue. For more information, see\n[How Requests are\nRouted](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)\nand how routing is affected by\n[dispatch\nfiles](https://cloud.google.com/appengine/docs/python/config/dispatchref).\nTraffic is encrypted during transport and never leaves Google datacenters.\nBecause this traffic is carried over a communication mechanism internal to\nGoogle, you cannot explicitly set the protocol (for example, HTTP or HTTPS).\nThe request to the handler, however, will appear to have used the HTTP\nprotocol.\n\nThe AppEngineRouting used to construct the URL that the task is\ndelivered to can be set at the queue-level or task-level:\n\n* If set,\n app_engine_routing_override\n is used for all tasks in the queue, no matter what the setting\n is for the\n task-level app_engine_routing.\n\n\nThe `url` that the task will be sent to is:\n\n* `url =` host `+`\n relative_uri\n\nTasks can be dispatched to secure app handlers, unsecure app handlers, and\nURIs restricted with\n[`login:\nadmin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).\nBecause tasks are not run as any user, they cannot be dispatched to URIs\nrestricted with\n[`login:\nrequired`](https://cloud.google.com/appengine/docs/standard/python/config/appref)\nTask dispatches also do not follow redirects.\n\nThe task attempt has succeeded if the app's request handler returns an HTTP\nresponse code in the range [`200` - `299`]. The task attempt has failed if\nthe app's handler returns a non-2xx response code or Cloud Tasks does\nnot receive response before the deadline. Failed\ntasks will be retried according to the\nretry configuration. `503` (Service Unavailable) is\nconsidered an App Engine system error instead of an application error and\nwill cause Cloud Tasks' traffic congestion control to temporarily throttle\nthe queue's dispatches. Unlike other types of task targets, a `429` (Too Many\nRequests) response from an app handler does not cause traffic congestion\ncontrol to throttle the queue.",
|
||||
"description": "App Engine HTTP request.\n\nThe message defines the HTTP request that is sent to an App Engine app when\nthe task is dispatched.\n\nUsing AppEngineHttpRequest requires\n[`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`\n\nThe task will be delivered to the App Engine app which belongs to the same\nproject as the queue. For more information, see\n[How Requests are\nRouted](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)\nand how routing is affected by\n[dispatch\nfiles](https://cloud.google.com/appengine/docs/python/config/dispatchref).\nTraffic is encrypted during transport and never leaves Google datacenters.\nBecause this traffic is carried over a communication mechanism internal to\nGoogle, you cannot explicitly set the protocol (for example, HTTP or HTTPS).\nThe request to the handler, however, will appear to have used the HTTP\nprotocol.\n\nThe AppEngineRouting used to construct the URL that the task is\ndelivered to can be set at the queue-level or task-level:\n\n* If app_engine_routing_override is set on the\n queue, this value is used for all\n tasks in the queue, no matter what the setting is for the task-level\n app_engine_routing.\n\n\nThe `url` that the task will be sent to is:\n\n* `url =` host `+`\n relative_uri\n\nTasks can be dispatched to secure app handlers, unsecure app handlers, and\nURIs restricted with\n[`login:\nadmin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).\nBecause tasks are not run as any user, they cannot be dispatched to URIs\nrestricted with\n[`login:\nrequired`](https://cloud.google.com/appengine/docs/standard/python/config/appref)\nTask dispatches also do not follow redirects.\n\nThe task attempt has succeeded if the app's request handler returns an HTTP\nresponse code in the range [`200` - `299`]. The task attempt has failed if\nthe app's handler returns a non-2xx response code or Cloud Tasks does\nnot receive response before the deadline. Failed\ntasks will be retried according to the\nretry configuration. `503` (Service Unavailable) is\nconsidered an App Engine system error instead of an application error and\nwill cause Cloud Tasks' traffic congestion control to temporarily throttle\nthe queue's dispatches. Unlike other types of task targets, a `429` (Too Many\nRequests) response from an app handler does not cause traffic congestion\ncontrol to throttle the queue.",
|
||||
"id": "AppEngineHttpRequest",
|
||||
"properties": {
|
||||
"appEngineRouting": {
|
||||
"$ref": "AppEngineRouting",
|
||||
"description": "Task-level setting for App Engine routing.\n\nIf set,\napp_engine_routing_override\nis used for all tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing."
|
||||
"description": "Task-level setting for App Engine routing.\n\n* If app_engine_routing_override is set on the\n queue, this value is used for all\n tasks in the queue, no matter what the setting is for the task-level\n app_engine_routing."
|
||||
},
|
||||
"body": {
|
||||
"description": "HTTP request body.\n\nA request body is allowed only if the HTTP method is POST or PUT. It is\nan error to set a body on a task with an incompatible HttpMethod.",
|
||||
@@ -694,7 +695,7 @@
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\ntask is created.\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has a body, Cloud\nTasks sets the following headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explicitly\n setting `Content-Type` to a particular media type when the\n task is created.\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, Cloud Tasks sets some headers when the task is dispatched,\nsuch as headers containing information about the task; see\n[request\nheaders](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).\nThese headers are set only when the task is dispatched, so they are not\nvisible when the task is returned in a Cloud Tasks response.\n\nAlthough there is no specific limit for the maximum number of headers or\nthe size, there is a limit on the maximum size of the Task. For more\ninformation, see the CreateTask documentation.",
|
||||
"description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\ntask is created.\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has a body, Cloud\nTasks sets the following headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explicitly\n setting `Content-Type` to a particular media type when the\n task is created.\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, Cloud Tasks sets some headers when the task is dispatched,\nsuch as headers containing information about the task; see\n[request\nheaders](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers).\nThese headers are set only when the task is dispatched, so they are not\nvisible when the task is returned in a Cloud Tasks response.\n\nAlthough there is no specific limit for the maximum number of headers or\nthe size, there is a limit on the maximum size of the Task. For more\ninformation, see the CreateTask documentation.",
|
||||
"type": "object"
|
||||
},
|
||||
"httpMethod": {
|
||||
@@ -729,7 +730,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AppEngineRouting": {
|
||||
"description": "App Engine Routing.\n\nDefines routing characteristics specific to App Engine - service, version,\nand instance.\n\nFor more information about services, versions, and instances see\n[An Overview of App\nEngine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),\n[Microservices Architecture on Google App\nEngine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),\n[App Engine Standard request\nrouting](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),\nand [App Engine Flex request\nrouting](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).",
|
||||
"description": "App Engine Routing.\n\nDefines routing characteristics specific to App Engine - service, version,\nand instance.\n\nFor more information about services, versions, and instances see\n[An Overview of App\nEngine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),\n[Microservices Architecture on Google App\nEngine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),\n[App Engine Standard request\nrouting](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),\nand [App Engine Flex request\nrouting](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).\n\nUsing AppEngineRouting requires\n[`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`",
|
||||
"id": "AppEngineRouting",
|
||||
"properties": {
|
||||
"host": {
|
||||
@@ -786,7 +787,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -819,7 +820,7 @@
|
||||
},
|
||||
"task": {
|
||||
"$ref": "Task",
|
||||
"description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a task name. If a\nname is not specified then the system will generate a random\nunique task id, which will be set in the task returned in the\nresponse.\n\nIf schedule_time is not set or is in the\npast then Cloud Tasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or executed recently then the call will fail\nwith ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or executed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or executed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently."
|
||||
"description": "Required. The task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a task name. If a\nname is not specified then the system will generate a random\nunique task id, which will be set in the task returned in the\nresponse.\n\nIf schedule_time is not set or is in the\npast then Cloud Tasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or executed recently then the call will fail\nwith ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or executed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or executed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -831,23 +832,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -856,7 +857,79 @@
|
||||
"GetIamPolicyRequest": {
|
||||
"description": "Request message for `GetIamPolicy` method.",
|
||||
"id": "GetIamPolicyRequest",
|
||||
"properties": {},
|
||||
"properties": {
|
||||
"options": {
|
||||
"$ref": "GetPolicyOptions",
|
||||
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetPolicyOptions": {
|
||||
"description": "Encapsulates settings provided to GetIamPolicy.",
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"HttpRequest": {
|
||||
"description": "HTTP request.\n\nThe task will be pushed to the worker as an HTTP request. If the worker\nor the redirected worker acknowledges the task by returning a successful HTTP\nresponse code ([`200` - `299`]), the task will be removed from the queue. If\nany other HTTP response code is returned or no response is received, the\ntask will be retried according to the following:\n\n* User-specified throttling: retry configuration,\n rate limits, and the queue's state.\n\n* System throttling: To prevent the worker from overloading, Cloud Tasks may\n temporarily reduce the queue's effective rate. User-specified settings\n will not be changed.\n\n System throttling happens because:\n\n * Cloud Tasks backs off on all errors. Normally the backoff specified in\n rate limits will be used. But if the worker returns\n `429` (Too Many Requests), `503` (Service Unavailable), or the rate of\n errors is high, Cloud Tasks will use a higher backoff rate. The retry\n specified in the `Retry-After` HTTP response header is considered.\n\n * To prevent traffic spikes and to smooth sudden increases in traffic,\n dispatches ramp up slowly when the queue is newly created or idle and\n if large numbers of tasks suddenly become available to dispatch (due to\n spikes in create task rates, the queue being unpaused, or many tasks\n that are scheduled at the same time).",
|
||||
"id": "HttpRequest",
|
||||
"properties": {
|
||||
"body": {
|
||||
"description": "HTTP request body.\n\nA request body is allowed only if the\nHTTP method is POST, PUT, or PATCH. It is an\nerror to set body on a task with an incompatible HttpMethod.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"headers": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\ntask is created.\n\nThese headers represent a subset of the headers that will accompany the\ntask's HTTP request. Some HTTP request headers will be ignored or replaced.\n\nA partial list of headers that will be ignored or replaced is:\n\n* Host: This will be computed by Cloud Tasks and derived from\n HttpRequest.url.\n* Content-Length: This will be computed by Cloud Tasks.\n* User-Agent: This will be set to `\"Google-Cloud-Tasks\"`.\n* X-Google-*: Google use only.\n* X-AppEngine-*: Google use only.\n\n`Content-Type` won't be set by Cloud Tasks. You can explicitly set\n`Content-Type` to a media type when the\n task is created.\n For example, `Content-Type` can be set to `\"application/octet-stream\"` or\n `\"application/json\"`.\n\nHeaders which can have multiple values (according to RFC2616) can be\nspecified using comma-separated values.\n\nThe size of the headers must be less than 80KB.",
|
||||
"type": "object"
|
||||
},
|
||||
"httpMethod": {
|
||||
"description": "The HTTP method to use for the request. The default is POST.",
|
||||
"enum": [
|
||||
"HTTP_METHOD_UNSPECIFIED",
|
||||
"POST",
|
||||
"GET",
|
||||
"HEAD",
|
||||
"PUT",
|
||||
"DELETE",
|
||||
"PATCH",
|
||||
"OPTIONS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"HTTP method unspecified",
|
||||
"HTTP POST",
|
||||
"HTTP GET",
|
||||
"HTTP HEAD",
|
||||
"HTTP PUT",
|
||||
"HTTP DELETE",
|
||||
"HTTP PATCH",
|
||||
"HTTP OPTIONS"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"oauthToken": {
|
||||
"$ref": "OAuthToken",
|
||||
"description": "If specified, an\n[OAuth token](https://developers.google.com/identity/protocols/OAuth2)\nwill be generated and attached as an `Authorization` header in the HTTP\nrequest.\n\nThis type of authorization should generally only be used when calling\nGoogle APIs hosted on *.googleapis.com."
|
||||
},
|
||||
"oidcToken": {
|
||||
"$ref": "OidcToken",
|
||||
"description": "If specified, an\n[OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)\ntoken will be generated and attached as an `Authorization` header in the\nHTTP request.\n\nThis type of authorization can be used for many scenarios, including\ncalling Cloud Run, or endpoints where you intend to validate the token\nyourself."
|
||||
},
|
||||
"url": {
|
||||
"description": "Required. The full url path that the request will be sent to.\n\nThis string must begin with either \"http://\" or \"https://\". Some examples\nare: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will\nencode some characters for safety and compatibility. The maximum allowed\nURL length is 2083 characters after encoding.\n\nThe `Location` header response from a redirect response [`300` - `399`]\nmay be followed. The redirect is not counted as a separate attempt.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ListLocationsResponse": {
|
||||
@@ -947,6 +1020,36 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"OAuthToken": {
|
||||
"description": "Contains information needed for generating an\n[OAuth token](https://developers.google.com/identity/protocols/OAuth2).\nThis type of authorization should generally only be used when calling Google\nAPIs hosted on *.googleapis.com.",
|
||||
"id": "OAuthToken",
|
||||
"properties": {
|
||||
"scope": {
|
||||
"description": "OAuth scope to be used for generating OAuth access token.\nIf not specified, \"https://www.googleapis.com/auth/cloud-platform\"\nwill be used.",
|
||||
"type": "string"
|
||||
},
|
||||
"serviceAccountEmail": {
|
||||
"description": "[Service account email](https://cloud.google.com/iam/docs/service-accounts)\nto be used for generating OAuth token.\nThe service account must be within the same project as the queue. The\ncaller must have iam.serviceAccounts.actAs permission for the service\naccount.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"OidcToken": {
|
||||
"description": "Contains information needed for generating an\n[OpenID Connect\ntoken](https://developers.google.com/identity/protocols/OpenIDConnect).\nThis type of authorization can be used for many scenarios, including\ncalling Cloud Run, or endpoints where you intend to validate the token\nyourself.",
|
||||
"id": "OidcToken",
|
||||
"properties": {
|
||||
"audience": {
|
||||
"description": "Audience to be used when generating OIDC token. If not specified, the URI\nspecified in target will be used.",
|
||||
"type": "string"
|
||||
},
|
||||
"serviceAccountEmail": {
|
||||
"description": "[Service account email](https://cloud.google.com/iam/docs/service-accounts)\nto be used for generating OIDC token.\nThe service account must be within the same project as the queue. The\ncaller must have iam.serviceAccounts.actAs permission for the service\naccount.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PauseQueueRequest": {
|
||||
"description": "Request message for PauseQueue.",
|
||||
"id": "PauseQueueRequest",
|
||||
@@ -954,23 +1057,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -989,7 +1092,7 @@
|
||||
"properties": {
|
||||
"appEngineRoutingOverride": {
|
||||
"$ref": "AppEngineRouting",
|
||||
"description": "Overrides for\ntask-level app_engine_routing.\nThese settings apply only to\nApp Engine tasks in this queue.\n\nIf set, `app_engine_routing_override` is used for all\nApp Engine tasks in the queue, no matter what the\nsetting is for the\ntask-level app_engine_routing."
|
||||
"description": "Overrides for\ntask-level app_engine_routing.\nThese settings apply only to\nApp Engine tasks in this queue.\nHttp tasks are not affected.\n\nIf set, `app_engine_routing_override` is used for all\nApp Engine tasks in the queue, no matter what the\nsetting is for the\ntask-level app_engine_routing."
|
||||
},
|
||||
"name": {
|
||||
"description": "Caller-specified and required in CreateQueue,\nafter which it becomes output only.\n\nThe queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying\n projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.",
|
||||
@@ -1008,6 +1111,10 @@
|
||||
"$ref": "RetryConfig",
|
||||
"description": "Settings that determine the retry behavior.\n\n* For tasks created using Cloud Tasks: the queue-level retry settings\n apply to all tasks in the queue that were created using Cloud Tasks.\n Retry settings cannot be set on individual tasks.\n* For tasks created using the App Engine SDK: the queue-level retry\n settings apply to all tasks in the queue which do not have retry settings\n explicitly set on the task and were created by the App Engine SDK. See\n [App Engine\n documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks)."
|
||||
},
|
||||
"stackdriverLoggingConfig": {
|
||||
"$ref": "StackdriverLoggingConfig",
|
||||
"description": "Configuration options for writing logs to\n[Stackdriver Logging](https://cloud.google.com/logging/docs/). If this\nfield is unset, then no logs are written."
|
||||
},
|
||||
"state": {
|
||||
"description": "Output only. The state of the queue.\n\n`state` can only be changed by called\nPauseQueue,\nResumeQueue, or uploading\n[queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).\nUpdateQueue cannot be used to change `state`.",
|
||||
"enum": [
|
||||
@@ -1032,7 +1139,7 @@
|
||||
"id": "RateLimits",
|
||||
"properties": {
|
||||
"maxBurstSize": {
|
||||
"description": "Output only. The max burst size.\n\nMax burst size limits how fast tasks in queue are processed when\nmany tasks are in the queue and the rate is high. This field\nallows the queue to have a high rate so processing starts shortly\nafter a task is enqueued, but still limits resource usage when\nmany tasks are enqueued in a short period of time.\n\nThe [token bucket](https://wikipedia.org/wiki/Token_Bucket)\nalgorithm is used to control the rate of task dispatches. Each\nqueue has a token bucket that holds tokens, up to the maximum\nspecified by `max_burst_size`. Each time a task is dispatched, a\ntoken is removed from the bucket. Tasks will be dispatched until\nthe queue's bucket runs out of tokens. The bucket will be\ncontinuously refilled with new tokens based on\nmax_dispatches_per_second.\n\nCloud Tasks will pick the value of `max_burst_size` based on the\nvalue of\nmax_dispatches_per_second.\n\nFor App Engine queues that were created or updated using\n`queue.yaml/xml`, `max_burst_size` is equal to\n[bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).\nSince `max_burst_size` is output only, if\nUpdateQueue is called on a queue\ncreated by `queue.yaml/xml`, `max_burst_size` will be reset based\non the value of\nmax_dispatches_per_second,\nregardless of whether\nmax_dispatches_per_second\nis updated.\n",
|
||||
"description": "Output only. The max burst size.\n\nMax burst size limits how fast tasks in queue are processed when\nmany tasks are in the queue and the rate is high. This field\nallows the queue to have a high rate so processing starts shortly\nafter a task is enqueued, but still limits resource usage when\nmany tasks are enqueued in a short period of time.\n\nThe [token bucket](https://wikipedia.org/wiki/Token_Bucket)\nalgorithm is used to control the rate of task dispatches. Each\nqueue has a token bucket that holds tokens, up to the maximum\nspecified by `max_burst_size`. Each time a task is dispatched, a\ntoken is removed from the bucket. Tasks will be dispatched until\nthe queue's bucket runs out of tokens. The bucket will be\ncontinuously refilled with new tokens based on\nmax_dispatches_per_second.\n\nCloud Tasks will pick the value of `max_burst_size` based on the\nvalue of\nmax_dispatches_per_second.\n\nFor queues that were created or updated using\n`queue.yaml/xml`, `max_burst_size` is equal to\n[bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).\nSince `max_burst_size` is output only, if\nUpdateQueue is called on a queue\ncreated by `queue.yaml/xml`, `max_burst_size` will be reset based\non the value of\nmax_dispatches_per_second,\nregardless of whether\nmax_dispatches_per_second\nis updated.\n",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
@@ -1042,7 +1149,7 @@
|
||||
"type": "integer"
|
||||
},
|
||||
"maxDispatchesPerSecond": {
|
||||
"description": "The maximum rate at which tasks are dispatched from this queue.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n* For App Engine queues, the maximum allowed value\n is 500.\n\n\nThis field has the same meaning as\n[rate in\nqueue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).",
|
||||
"description": "The maximum rate at which tasks are dispatched from this queue.\n\nIf unspecified when the queue is created, Cloud Tasks will pick the\ndefault.\n\n* The maximum allowed value is 500.\n\n\nThis field has the same meaning as\n[rate in\nqueue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).",
|
||||
"format": "double",
|
||||
"type": "number"
|
||||
}
|
||||
@@ -1119,6 +1226,18 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"StackdriverLoggingConfig": {
|
||||
"description": "Configuration options for writing logs to\n[Stackdriver Logging](https://cloud.google.com/logging/docs/).",
|
||||
"id": "StackdriverLoggingConfig",
|
||||
"properties": {
|
||||
"samplingRatio": {
|
||||
"description": "Specifies the fraction of operations to write to\n[Stackdriver Logging](https://cloud.google.com/logging/docs/).\nThis field may contain any value between 0.0 and 1.0, inclusive.\n0.0 is the default and means that no operations are logged.",
|
||||
"format": "double",
|
||||
"type": "number"
|
||||
}
|
||||
},
|
||||
"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",
|
||||
@@ -1165,7 +1284,7 @@
|
||||
"type": "integer"
|
||||
},
|
||||
"dispatchDeadline": {
|
||||
"description": "The deadline for requests sent to the worker. If the worker does not\nrespond by this deadline then the request is cancelled and the attempt\nis marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the\ntask according to the RetryConfig.\n\nNote that when the request is cancelled, Cloud Tasks will stop listing for\nthe response, but whether the worker stops processing depends on the\nworker. For example, if the worker is stuck, it may not react to cancelled\nrequests.\n\nThe default and maximum values depend on the type of request:\n\n\n* For App Engine tasks, 0 indicates that the\n request has the default deadline. The default deadline depends on the\n [scaling\n type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)\n of the service: 10 minutes for standard apps with automatic scaling, 24\n hours for standard apps with manual and basic scaling, and 60 minutes for\n flex apps. If the request deadline is set, it must be in the interval [15\n seconds, 24 hours 15 seconds]. Regardless of the task's\n `dispatch_deadline`, the app handler will not run for longer than than\n the service's timeout. We recommend setting the `dispatch_deadline` to\n at most a few seconds more than the app handler's timeout. For more\n information see\n [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).\n\n`dispatch_deadline` will be truncated to the nearest millisecond. The\ndeadline is an approximate deadline.",
|
||||
"description": "The deadline for requests sent to the worker. If the worker does not\nrespond by this deadline then the request is cancelled and the attempt\nis marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the\ntask according to the RetryConfig.\n\nNote that when the request is cancelled, Cloud Tasks will stop listing for\nthe response, but whether the worker stops processing depends on the\nworker. For example, if the worker is stuck, it may not react to cancelled\nrequests.\n\nThe default and maximum values depend on the type of request:\n\n* For HTTP tasks, the default is 10 minutes. The deadline\n must be in the interval [15 seconds, 30 minutes].\n\n* For App Engine tasks, 0 indicates that the\n request has the default deadline. The default deadline depends on the\n [scaling\n type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling)\n of the service: 10 minutes for standard apps with automatic scaling, 24\n hours for standard apps with manual and basic scaling, and 60 minutes for\n flex apps. If the request deadline is set, it must be in the interval [15\n seconds, 24 hours 15 seconds]. Regardless of the task's\n `dispatch_deadline`, the app handler will not run for longer than than\n the service's timeout. We recommend setting the `dispatch_deadline` to\n at most a few seconds more than the app handler's timeout. For more\n information see\n [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).\n\n`dispatch_deadline` will be truncated to the nearest millisecond. The\ndeadline is an approximate deadline.",
|
||||
"format": "google-duration",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1173,6 +1292,10 @@
|
||||
"$ref": "Attempt",
|
||||
"description": "Output only. The status of the task's first attempt.\n\nOnly dispatch_time will be set.\nThe other Attempt information is not retained by Cloud Tasks."
|
||||
},
|
||||
"httpRequest": {
|
||||
"$ref": "HttpRequest",
|
||||
"description": "HTTP request that is sent to the worker.\n\nAn HTTP task is a task that has HttpRequest set."
|
||||
},
|
||||
"lastAttempt": {
|
||||
"$ref": "Attempt",
|
||||
"description": "Output only. The status of the task's last attempt."
|
||||
@@ -1187,7 +1310,7 @@
|
||||
"type": "integer"
|
||||
},
|
||||
"scheduleTime": {
|
||||
"description": "The time when the task is scheduled to be attempted.\n\nFor App Engine queues, this is when the task will be attempted or retried.\n\n`schedule_time` will be truncated to the nearest microsecond.",
|
||||
"description": "The time when the task is scheduled to be attempted or retried.\n\n`schedule_time` will be truncated to the nearest microsecond.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudtasks:v2beta2",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudtasks.mtls.googleapis.com/",
|
||||
"name": "cloudtasks",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -188,7 +189,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\nListLocations.",
|
||||
"description": "Required. The location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\nListLocations.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -216,7 +217,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -241,11 +242,17 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"readMask": {
|
||||
"description": "Optional. Read mask is used for a more granular control over what the API returns. By\nit includes all fields in Queue except for stats.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v2beta2/{+name}",
|
||||
@@ -310,7 +317,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
|
||||
"description": "Required. The location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -369,7 +376,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -397,7 +404,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -425,7 +432,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -513,7 +520,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -541,7 +548,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -569,7 +576,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -597,7 +604,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -622,7 +629,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -657,7 +664,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -696,7 +703,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -731,7 +738,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -759,7 +766,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -786,7 +793,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190618",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://cloudtasks.googleapis.com/",
|
||||
"schemas": {
|
||||
"AcknowledgeTaskRequest": {
|
||||
@@ -794,7 +801,7 @@
|
||||
"id": "AcknowledgeTaskRequest",
|
||||
"properties": {
|
||||
"scheduleTime": {
|
||||
"description": "Required.\n\nThe task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
|
||||
"description": "Required. The task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -917,7 +924,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -949,7 +956,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"scheduleTime": {
|
||||
"description": "Required.\n\nThe task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
|
||||
"description": "Required. The task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -976,7 +983,7 @@
|
||||
},
|
||||
"task": {
|
||||
"$ref": "Task",
|
||||
"description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a task name. If a\nname is not specified then the system will generate a random\nunique task id, which will be set in the task returned in the\nresponse.\n\nIf schedule_time is not set or is in the\npast then Cloud Tasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or completed recently then the call will fail\nwith ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or completed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or completed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently."
|
||||
"description": "Required. The task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a task name. If a\nname is not specified then the system will generate a random\nunique task id, which will be set in the task returned in the\nresponse.\n\nIf schedule_time is not set or is in the\npast then Cloud Tasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or completed recently then the call will fail\nwith ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or completed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or completed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -988,23 +995,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1013,7 +1020,24 @@
|
||||
"GetIamPolicyRequest": {
|
||||
"description": "Request message for `GetIamPolicy` method.",
|
||||
"id": "GetIamPolicyRequest",
|
||||
"properties": {},
|
||||
"properties": {
|
||||
"options": {
|
||||
"$ref": "GetPolicyOptions",
|
||||
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetPolicyOptions": {
|
||||
"description": "Encapsulates settings provided to GetIamPolicy.",
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"LeaseTasksRequest": {
|
||||
@@ -1025,7 +1049,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"leaseDuration": {
|
||||
"description": "Required.\n\nThe duration of the lease.\n\nEach task returned in the response will\nhave its schedule_time set to the current\ntime plus the `lease_duration`. The task is leased until its\nschedule_time; thus, the task will not be\nreturned to another LeaseTasks call\nbefore its schedule_time.\n\n\nAfter the worker has successfully finished the work associated\nwith the task, the worker must call via\nAcknowledgeTask before the\nschedule_time. Otherwise the task will be\nreturned to a later LeaseTasks call so\nthat another worker can retry it.\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
|
||||
"description": "Required. The duration of the lease.\n\nEach task returned in the response will\nhave its schedule_time set to the current\ntime plus the `lease_duration`. The task is leased until its\nschedule_time; thus, the task will not be\nreturned to another LeaseTasks call\nbefore its schedule_time.\n\n\nAfter the worker has successfully finished the work associated\nwith the task, the worker must call via\nAcknowledgeTask before the\nschedule_time. Otherwise the task will be\nreturned to a later LeaseTasks call so\nthat another worker can retry it.\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
|
||||
"format": "google-duration",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1160,23 +1184,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -1286,7 +1310,7 @@
|
||||
"id": "RenewLeaseRequest",
|
||||
"properties": {
|
||||
"leaseDuration": {
|
||||
"description": "Required.\n\nThe desired new lease duration, starting from now.\n\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
|
||||
"description": "Required. The desired new lease duration, starting from now.\n\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.",
|
||||
"format": "google-duration",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1305,7 +1329,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"scheduleTime": {
|
||||
"description": "Required.\n\nThe task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
|
||||
"description": "Required. The task's current schedule time, available in the\nschedule_time returned by\nLeaseTasks response or\nRenewLease response. This restriction is\nto ensure that your worker currently holds the lease.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "cloudtasks:v2beta3",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudtasks.mtls.googleapis.com/",
|
||||
"name": "cloudtasks",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -188,7 +189,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\nListLocations.",
|
||||
"description": "Required. The location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\nListLocations.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -216,7 +217,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -241,7 +242,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -310,7 +311,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
|
||||
"description": "Required. The location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+$",
|
||||
"required": true,
|
||||
@@ -369,7 +370,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -397,7 +398,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -425,7 +426,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -513,7 +514,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -541,7 +542,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -566,7 +567,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -612,7 +613,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
|
||||
"required": true,
|
||||
@@ -647,7 +648,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"description": "Required. The task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
|
||||
"required": true,
|
||||
@@ -674,7 +675,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190618",
|
||||
"revision": "20200331",
|
||||
"rootUrl": "https://cloudtasks.googleapis.com/",
|
||||
"schemas": {
|
||||
"AppEngineHttpQueue": {
|
||||
@@ -705,7 +706,7 @@
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\ntask is created.\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has a body, Cloud\nTasks sets the following headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explicitly\n setting `Content-Type` to a particular media type when the\n task is created.\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, Cloud Tasks sets some headers when the task is dispatched,\nsuch as headers containing information about the task; see\n[request\nheaders](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).\nThese headers are set only when the task is dispatched, so they are not\nvisible when the task is returned in a Cloud Tasks response.\n\nAlthough there is no specific limit for the maximum number of headers or\nthe size, there is a limit on the maximum size of the Task. For more\ninformation, see the CreateTask documentation.",
|
||||
"description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\ntask is created.\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has a body, Cloud\nTasks sets the following headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explicitly\n setting `Content-Type` to a particular media type when the\n task is created.\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, Cloud Tasks sets some headers when the task is dispatched,\nsuch as headers containing information about the task; see\n[request\nheaders](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers).\nThese headers are set only when the task is dispatched, so they are not\nvisible when the task is returned in a Cloud Tasks response.\n\nAlthough there is no specific limit for the maximum number of headers or\nthe size, there is a limit on the maximum size of the Task. For more\ninformation, see the CreateTask documentation.",
|
||||
"type": "object"
|
||||
},
|
||||
"httpMethod": {
|
||||
@@ -797,7 +798,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -830,7 +831,7 @@
|
||||
},
|
||||
"task": {
|
||||
"$ref": "Task",
|
||||
"description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a task name. If a\nname is not specified then the system will generate a random\nunique task id, which will be set in the task returned in the\nresponse.\n\nIf schedule_time is not set or is in the\npast then Cloud Tasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or executed recently then the call will fail\nwith ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or executed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or executed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently."
|
||||
"description": "Required. The task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a task name. If a\nname is not specified then the system will generate a random\nunique task id, which will be set in the task returned in the\nresponse.\n\nIf schedule_time is not set or is in the\npast then Cloud Tasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or executed recently then the call will fail\nwith ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or executed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or executed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -842,23 +843,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -867,11 +868,28 @@
|
||||
"GetIamPolicyRequest": {
|
||||
"description": "Request message for `GetIamPolicy` method.",
|
||||
"id": "GetIamPolicyRequest",
|
||||
"properties": {},
|
||||
"properties": {
|
||||
"options": {
|
||||
"$ref": "GetPolicyOptions",
|
||||
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetPolicyOptions": {
|
||||
"description": "Encapsulates settings provided to GetIamPolicy.",
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"HttpRequest": {
|
||||
"description": "HTTP request.\n\nThe task will be pushed to the worker as an HTTP request. If the worker\nor the redirected worker acknowledges the task by returning a successful HTTP\nresponse code ([`200` - `299`]), the task will removed from the queue. If\nany other HTTP response code is returned or no response is received, the\ntask will be retried according to the following:\n\n* User-specified throttling: retry configuration,\n rate limits, and the queue's state.\n\n* System throttling: To prevent the worker from overloading, Cloud Tasks may\n temporarily reduce the queue's effective rate. User-specified settings\n will not be changed.\n\n System throttling happens because:\n\n * Cloud Tasks backoffs on all errors. Normally the backoff specified in\n rate limits will be used. But if the worker returns\n `429` (Too Many Requests), `503` (Service Unavailable), or the rate of\n errors is high, Cloud Tasks will use a higher backoff rate. The retry\n specified in the `Retry-After` HTTP response header is considered.\n\n * To prevent traffic spikes and to smooth sudden large traffic spikes,\n dispatches ramp up slowly when the queue is newly created or idle and\n if large numbers of tasks suddenly become available to dispatch (due to\n spikes in create task rates, the queue being unpaused, or many tasks\n that are scheduled at the same time).",
|
||||
"description": "HTTP request.\n\nThe task will be pushed to the worker as an HTTP request. If the worker\nor the redirected worker acknowledges the task by returning a successful HTTP\nresponse code ([`200` - `299`]), the task will be removed from the queue. If\nany other HTTP response code is returned or no response is received, the\ntask will be retried according to the following:\n\n* User-specified throttling: retry configuration,\n rate limits, and the queue's state.\n\n* System throttling: To prevent the worker from overloading, Cloud Tasks may\n temporarily reduce the queue's effective rate. User-specified settings\n will not be changed.\n\n System throttling happens because:\n\n * Cloud Tasks backs off on all errors. Normally the backoff specified in\n rate limits will be used. But if the worker returns\n `429` (Too Many Requests), `503` (Service Unavailable), or the rate of\n errors is high, Cloud Tasks will use a higher backoff rate. The retry\n specified in the `Retry-After` HTTP response header is considered.\n\n * To prevent traffic spikes and to smooth sudden increases in traffic,\n dispatches ramp up slowly when the queue is newly created or idle and\n if large numbers of tasks suddenly become available to dispatch (due to\n spikes in create task rates, the queue being unpaused, or many tasks\n that are scheduled at the same time).",
|
||||
"id": "HttpRequest",
|
||||
"properties": {
|
||||
"body": {
|
||||
@@ -1050,23 +1068,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
"baseUrl": "https://cloudtrace.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "Cloud Trace",
|
||||
"description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.\n",
|
||||
"description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenCensus.\n",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/trace",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
@@ -28,6 +28,7 @@
|
||||
},
|
||||
"id": "cloudtrace:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudtrace.mtls.googleapis.com/",
|
||||
"name": "cloudtrace",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -113,7 +114,7 @@
|
||||
"projects": {
|
||||
"methods": {
|
||||
"patchTraces": {
|
||||
"description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created.",
|
||||
"description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created.\nIn this case, writing traces is not considered an active developer\nmethod since traces are machine generated.",
|
||||
"flatPath": "v1/projects/{projectId}/traces",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "cloudtrace.projects.patchTraces",
|
||||
@@ -122,7 +123,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "ID of the Cloud project where the trace data is stored.",
|
||||
"description": "Required. ID of the Cloud project where the trace data is stored.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -145,7 +146,7 @@
|
||||
"traces": {
|
||||
"methods": {
|
||||
"get": {
|
||||
"description": "Gets a single trace by its ID.",
|
||||
"description": "Gets a single trace by its ID.\nIn this case, getting for traces is considered an active developer method,\neven though it is technically a read-only method.",
|
||||
"flatPath": "v1/projects/{projectId}/traces/{traceId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "cloudtrace.projects.traces.get",
|
||||
@@ -155,13 +156,13 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "ID of the Cloud project where the trace data is stored.",
|
||||
"description": "Required. ID of the Cloud project where the trace data is stored.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"traceId": {
|
||||
"description": "ID of the trace to return.",
|
||||
"description": "Required. ID of the trace to return.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -177,7 +178,7 @@
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "Returns of a list of traces that match the specified filter conditions.",
|
||||
"description": "Returns of a list of traces that match the specified filter conditions.\nIn this case, listing for traces is considered an active developer method,\neven though it is technically a read-only method.",
|
||||
"flatPath": "v1/projects/{projectId}/traces",
|
||||
"httpMethod": "GET",
|
||||
"id": "cloudtrace.projects.traces.list",
|
||||
@@ -192,28 +193,28 @@
|
||||
"type": "string"
|
||||
},
|
||||
"filter": {
|
||||
"description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
|
||||
"description": "Optional. A filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"orderBy": {
|
||||
"description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted.",
|
||||
"description": "Optional. Field used to sort the returned traces.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "Maximum number of traces to return. If not specified or <= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size. Optional.",
|
||||
"description": "Optional. Maximum number of traces to return. If not specified or <= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
|
||||
"description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "ID of the Cloud project where the trace data is stored.",
|
||||
"description": "Required. ID of the Cloud project where the trace data is stored.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -225,7 +226,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"view": {
|
||||
"description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
|
||||
"description": "Optional. Type of data returned for traces in the list. Default is\n`MINIMAL`.",
|
||||
"enum": [
|
||||
"VIEW_TYPE_UNSPECIFIED",
|
||||
"MINIMAL",
|
||||
@@ -250,7 +251,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190622",
|
||||
"revision": "20200330",
|
||||
"rootUrl": "https://cloudtrace.googleapis.com/",
|
||||
"schemas": {
|
||||
"Empty": {
|
||||
@@ -334,7 +335,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parentSpanId": {
|
||||
"description": "ID of the parent span, if any. Optional.",
|
||||
"description": "Optional. ID of the parent span, if any.",
|
||||
"format": "uint64",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -367,7 +368,7 @@
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "Stackdriver Trace API",
|
||||
"title": "Cloud Trace API",
|
||||
"version": "v1",
|
||||
"version_module": true
|
||||
}
|
||||
@@ -15,7 +15,7 @@
|
||||
"baseUrl": "https://cloudtrace.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "Cloud Trace",
|
||||
"description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.\n",
|
||||
"description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenCensus.\n",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/trace",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
@@ -25,6 +25,7 @@
|
||||
},
|
||||
"id": "cloudtrace:v2",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudtrace.mtls.googleapis.com/",
|
||||
"name": "cloudtrace",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -112,7 +113,7 @@
|
||||
"traces": {
|
||||
"methods": {
|
||||
"batchWrite": {
|
||||
"description": "Sends new spans to new or existing traces. You cannot update\nexisting spans.",
|
||||
"description": "Sends new spans to new or existing traces. You cannot update\nexisting spans.\nIn this case, writing traces is not considered an active developer\nmethod since traces are machine generated.",
|
||||
"flatPath": "v2/projects/{projectsId}/traces:batchWrite",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudtrace.projects.traces.batchWrite",
|
||||
@@ -145,7 +146,7 @@
|
||||
"spans": {
|
||||
"methods": {
|
||||
"createSpan": {
|
||||
"description": "Creates a new span.",
|
||||
"description": "Creates a new span.\nIn this case, writing traces is not considered an active developer\nmethod since traces are machine generated.",
|
||||
"flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudtrace.projects.traces.spans.createSpan",
|
||||
@@ -180,7 +181,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190622",
|
||||
"revision": "20200330",
|
||||
"rootUrl": "https://cloudtrace.googleapis.com/",
|
||||
"schemas": {
|
||||
"Annotation": {
|
||||
@@ -242,7 +243,7 @@
|
||||
"id": "BatchWriteSpansRequest",
|
||||
"properties": {
|
||||
"spans": {
|
||||
"description": "A list of new spans. The span names must not match existing\nspans, or the results are undefined.",
|
||||
"description": "Required. A list of new spans. The span names must not match existing\nspans, or the results are undefined.",
|
||||
"items": {
|
||||
"$ref": "Span"
|
||||
},
|
||||
@@ -369,16 +370,16 @@
|
||||
"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.",
|
||||
"description": "Optional. The 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."
|
||||
"description": "Required. 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.",
|
||||
"description": "Required. 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"
|
||||
},
|
||||
@@ -395,11 +396,31 @@
|
||||
"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.",
|
||||
"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.",
|
||||
"description": "Required. 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 recieving 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"
|
||||
},
|
||||
"stackTrace": {
|
||||
@@ -407,13 +428,13 @@
|
||||
"description": "Stack trace captured at the start of the span."
|
||||
},
|
||||
"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.",
|
||||
"description": "Required. 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."
|
||||
"description": "Optional. The final status for this span."
|
||||
},
|
||||
"timeEvents": {
|
||||
"$ref": "TimeEvents",
|
||||
@@ -583,7 +604,7 @@
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "Stackdriver Trace API",
|
||||
"title": "Cloud Trace API",
|
||||
"version": "v2",
|
||||
"version_module": true
|
||||
}
|
||||
338
etc/api/cloudtrace/v2beta1/cloudtrace-api.json
Normal file
338
etc/api/cloudtrace/v2beta1/cloudtrace-api.json
Normal file
@@ -0,0 +1,338 @@
|
||||
{
|
||||
"auth": {
|
||||
"oauth2": {
|
||||
"scopes": {
|
||||
"https://www.googleapis.com/auth/cloud-platform": {
|
||||
"description": "View and manage your data across Google Cloud Platform services"
|
||||
},
|
||||
"https://www.googleapis.com/auth/trace.append": {
|
||||
"description": "Write Trace data for a project or application"
|
||||
},
|
||||
"https://www.googleapis.com/auth/trace.readonly": {
|
||||
"description": "Read Trace data for a project or application"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"basePath": "",
|
||||
"baseUrl": "https://cloudtrace.googleapis.com/",
|
||||
"batchPath": "batch",
|
||||
"canonicalName": "Cloud Trace",
|
||||
"description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenCensus.\n",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://cloud.google.com/trace",
|
||||
"fullyEncodeReservedExpansion": true,
|
||||
"icons": {
|
||||
"x16": "http://www.google.com/images/icons/product/search-16.gif",
|
||||
"x32": "http://www.google.com/images/icons/product/search-32.gif"
|
||||
},
|
||||
"id": "cloudtrace:v2beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://cloudtrace.mtls.googleapis.com/",
|
||||
"name": "cloudtrace",
|
||||
"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 response.",
|
||||
"enum": [
|
||||
"json",
|
||||
"media",
|
||||
"proto"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"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",
|
||||
"type": "string"
|
||||
},
|
||||
"key": {
|
||||
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"oauth_token": {
|
||||
"description": "OAuth 2.0 token for the current user.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"prettyPrint": {
|
||||
"default": "true",
|
||||
"description": "Returns response with indentations and line breaks.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"quotaUser": {
|
||||
"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"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"protocol": "rest",
|
||||
"resources": {
|
||||
"projects": {
|
||||
"resources": {
|
||||
"traceSinks": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates a sink that exports trace spans to a destination. The\nexport of newly-ingested traces begins immediately, unless the sink's\n`writer_identity` is not permitted to write to the destination. A sink can\nexport traces only from the resource owning the sink (the 'parent').",
|
||||
"flatPath": "v2beta1/projects/{projectsId}/traceSinks",
|
||||
"httpMethod": "POST",
|
||||
"id": "cloudtrace.projects.traceSinks.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. The resource in which to create the sink (currently only project\nsinks are supported):\n\n \"projects/[PROJECT_ID]\"\n\nExamples: `\"projects/my-trace-project\"`, `\"projects/123456789\"`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v2beta1/{+parent}/traceSinks",
|
||||
"request": {
|
||||
"$ref": "TraceSink"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "TraceSink"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/trace.append"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes a sink.",
|
||||
"flatPath": "v2beta1/projects/{projectsId}/traceSinks/{traceSinksId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "cloudtrace.projects.traceSinks.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The full resource name of the sink to delete, including the\nparent resource and the sink identifier:\n\n \"projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]\"\n\nExample: `\"projects/12345/traceSinks/my-sink-id\"`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/traceSinks/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v2beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "Empty"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/trace.append"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Get a trace sink by name under the parent resource (GCP project).",
|
||||
"flatPath": "v2beta1/projects/{projectsId}/traceSinks/{traceSinksId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "cloudtrace.projects.traceSinks.get",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The resource name of the sink:\n\n \"projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]\"\n\nExample: `\"projects/12345/traceSinks/my-sink-id\"`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/traceSinks/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v2beta1/{+name}",
|
||||
"response": {
|
||||
"$ref": "TraceSink"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/trace.readonly"
|
||||
]
|
||||
},
|
||||
"list": {
|
||||
"description": "List all sinks for the parent resource (GCP project).",
|
||||
"flatPath": "v2beta1/projects/{projectsId}/traceSinks",
|
||||
"httpMethod": "GET",
|
||||
"id": "cloudtrace.projects.traceSinks.list",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"pageSize": {
|
||||
"description": "Optional. The maximum number of results to return from this request.\nNon-positive values are ignored. The presence of `nextPageToken` in the\nresponse indicates that more results might be available.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Optional. If present, then retrieve the next batch of results from the\npreceding call to this method. `pageToken` must be the value of\n`nextPageToken` from the previous response. The values of other method\nparameters should be identical to those in the previous call.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. The parent resource whose sinks are to be listed (currently only\nproject parent resources are supported):\n\n \"projects/[PROJECT_ID]\"",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v2beta1/{+parent}/traceSinks",
|
||||
"response": {
|
||||
"$ref": "ListTraceSinksResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/trace.readonly"
|
||||
]
|
||||
},
|
||||
"patch": {
|
||||
"description": "Updates a sink. This method updates fields in the existing sink according\nto the provided update mask. The sink's name cannot be changed nor any\noutput-only fields (e.g. the writer_identity).",
|
||||
"flatPath": "v2beta1/projects/{projectsId}/traceSinks/{traceSinksId}",
|
||||
"httpMethod": "PATCH",
|
||||
"id": "cloudtrace.projects.traceSinks.patch",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "Required. The full resource name of the sink to update, including the\nparent resource and the sink identifier:\n\n \"projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]\"\n\nExample: `\"projects/12345/traceSinks/my-sink-id\"`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/traceSinks/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "Required. Field mask that specifies the fields in `trace_sink` that are to\nbe updated. A sink field is overwritten if, and only if, it is\nin the update mask. `name` and `writer_identity` fields cannot be updated.\n\nAn empty updateMask is considered an error.\n\nFor a detailed `FieldMask` definition, see\nhttps://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask\n\nExample: `updateMask=output_config`.",
|
||||
"format": "google-fieldmask",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v2beta1/{+name}",
|
||||
"request": {
|
||||
"$ref": "TraceSink"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "TraceSink"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/trace.append"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20200330",
|
||||
"rootUrl": "https://cloudtrace.googleapis.com/",
|
||||
"schemas": {
|
||||
"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"
|
||||
},
|
||||
"ListTraceSinksResponse": {
|
||||
"description": "Result returned from `ListTraceSinks`.",
|
||||
"id": "ListTraceSinksResponse",
|
||||
"properties": {
|
||||
"nextPageToken": {
|
||||
"description": "If there might be more results than appear in this response, then\n`nextPageToken` is included. To get the next set of results, call the same\nmethod again using the value of `nextPageToken` as `pageToken`.",
|
||||
"type": "string"
|
||||
},
|
||||
"sinks": {
|
||||
"description": "A list of sinks.",
|
||||
"items": {
|
||||
"$ref": "TraceSink"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"OutputConfig": {
|
||||
"description": "OutputConfig contains a destination for writing trace data.",
|
||||
"id": "OutputConfig",
|
||||
"properties": {
|
||||
"destination": {
|
||||
"description": "The destination for writing trace data. Currently only BigQuery is\nsupported. E.g.:\n\n \"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TraceSink": {
|
||||
"description": "Describes a sink used to export traces to a BigQuery dataset. The sink must\nbe created within a project.",
|
||||
"id": "TraceSink",
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "Required. The canonical sink resource name, unique within the project. Must be of the\nform:\n\n project/[PROJECT_NUMBER]/traceSinks/[SINK_ID].\n\nE.g.:\n\n `\"projects/12345/traceSinks/my-project-trace-sink\"`.\n\nSink identifiers are limited to 256 characters and can include only the\nfollowing characters: upper and lower-case alphanumeric characters,\nunderscores, hyphens, and periods.",
|
||||
"type": "string"
|
||||
},
|
||||
"outputConfig": {
|
||||
"$ref": "OutputConfig",
|
||||
"description": "Required. The export destination."
|
||||
},
|
||||
"writerIdentity": {
|
||||
"description": "Output only. A service account name for exporting the data. This field is\nset by sinks.create and sinks.update. The service account will need to be\ngranted write access to the destination specified in the output\nconfiguration, see [Granting access for a\nresource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource).\nTo create tables and write data this account will need the dataEditor role.\nRead more about roles in the [BigQuery\ndocumentation](https://cloud.google.com/bigquery/docs/access-control).\nE.g.:\n\n \"service-00000001@00000002.iam.gserviceaccount.com\"",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
"title": "Cloud Trace API",
|
||||
"version": "v2beta1",
|
||||
"version_module": true
|
||||
}
|
||||
@@ -21,6 +21,7 @@
|
||||
},
|
||||
"id": "commentanalyzer:v1alpha1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://commentanalyzer.mtls.googleapis.com/",
|
||||
"name": "commentanalyzer",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -144,11 +145,11 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190616",
|
||||
"revision": "20200405",
|
||||
"rootUrl": "https://commentanalyzer.googleapis.com/",
|
||||
"schemas": {
|
||||
"AnalyzeCommentRequest": {
|
||||
"description": "The comment analysis request message.",
|
||||
"description": "The comment analysis request message.\nLINT.IfChange",
|
||||
"id": "AnalyzeCommentRequest",
|
||||
"properties": {
|
||||
"clientToken": {
|
||||
@@ -172,7 +173,7 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"languages": {
|
||||
"description": "The language(s) of the comment and context (if none are specified, the\nlanguage is automatically detected). If multiple languages are specified,\nthe text is checked in all of them that are supported. Both ISO and BCP-47\nlanguage codes are accepted.\nCurrent Language Restrictions:\n * Only English text (\"en\") is supported.\nIf none of the languages specified by the caller are supported, an\n`UNIMPLEMENTED` error is returned.",
|
||||
"description": "The language(s) of the comment and context. If none are specified, we\nattempt to automatically detect the language. Specifying multiple languages\nmeans the text contains multiple lanugages. Both ISO and BCP-47 language\ncodes are accepted.\n\nThe server returns an error if no language was specified and language\ndetection fails. The server also returns an error if the languages (either\nspecified by the caller, or auto-detected) are not *all* supported by the\nservice.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -182,7 +183,7 @@
|
||||
"additionalProperties": {
|
||||
"$ref": "AttributeParameters"
|
||||
},
|
||||
"description": "Specification of requested attributes. The AttributeParameters serve as\nconfiguration for each associated attribute. The map keys are attribute\nnames. The following attributes are available:\n\"ATTACK_ON_AUTHOR\" - Attack on author of original article or post.\n\"ATTACK_ON_COMMENTER\" - Attack on fellow commenter.\n\"ATTACK_ON_PUBLISHER\" - Attack on publisher of article/post.\n\"INCOHERENT\" - Difficult to understand, nonsensical.\n\"INFLAMMATORY\" - Intending to provoke or inflame.\n\"OBSCENE\" - Obscene, such as cursing.\n\"OFF_TOPIC\" - Not related to the original topic.\n\"SPAM\" - Commercial/advertising spam content.\n\"UNSUBSTANTIAL\" - Trivial.",
|
||||
"description": "Specification of requested attributes. The AttributeParameters serve as\nconfiguration for each associated attribute. The map keys are attribute\nnames. The available attributes may be different on each RFE installation,\nand can be seen by calling ListAttributes (see above).\nFor the prod installation, known as Perspective API, at\nblade:commentanalyzer-esf and commentanalyzer.googleapis.com, see\ngo/checker-models (internal) and\nhttps://github.com/conversationai/perspectiveapi/blob/master/2-api/models.md#all-attribute-types.",
|
||||
"type": "object"
|
||||
},
|
||||
"sessionId": {
|
||||
@@ -219,7 +220,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"languages": {
|
||||
"description": "The language(s) used by CommentAnalyzer service to choose which Model to\nuse when analyzing the comment. Might better be called\n\"effective_languages\". The logic used to make the choice is as follows:\n if Request.languages.empty()\n effective_languages = detected_languages\n else\n effective_languages = Request.languages",
|
||||
"description": "The language(s) used by CommentAnalyzer service to choose which Model to\nuse when analyzing the comment. Might better be called\n\"effective_languages\". The logic used to make the choice is as follows:\n if !Request.languages.empty()\n effective_languages = Request.languages\n else\n effective_languages = detected_languages[0]",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -387,7 +388,7 @@
|
||||
"description": "The context of the comment."
|
||||
},
|
||||
"languages": {
|
||||
"description": "The language(s) of the comment and context (if none are specified, the\nlanguage is automatically detected). If multiple languages are specified,\nthe text is checked in all of them that are supported. Both ISO and BCP-47\nlanguage codes are accepted.\nCurrent Language Restrictions:\n * Only English text (\"en\") is supported.\nIf none of the languages specified by the caller are supported, an\n`UNIMPLEMENTED` error is returned.",
|
||||
"description": "The language(s) of the comment and context. If none are specified, we\nattempt to automatically detect the language. Both ISO and BCP-47 language\ncodes are accepted.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "composer:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://composer.mtls.googleapis.com/",
|
||||
"name": "composer",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -400,7 +401,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190613",
|
||||
"revision": "20200406",
|
||||
"rootUrl": "https://composer.googleapis.com/",
|
||||
"schemas": {
|
||||
"Empty": {
|
||||
@@ -418,7 +419,7 @@
|
||||
"description": "Configuration parameters for this environment."
|
||||
},
|
||||
"createTime": {
|
||||
"description": "Output only.\nThe time at which this environment was created.",
|
||||
"description": "Output only. The time at which this environment was created.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -430,7 +431,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"name": {
|
||||
"description": "The resource name of the environment, in the form:\n\"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
|
||||
"description": "The resource name of the environment, in the form:\n\"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"\n\nEnvironmentId must start with a lowercase letter followed by up to 63\nlowercase letters, numbers, or hyphens, and cannot end with a hyphen.",
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
@@ -454,12 +455,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only.\nThe time at which this environment was last modified.",
|
||||
"description": "Output only. The time at which this environment was last modified.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"uuid": {
|
||||
"description": "Output only.\nThe UUID (Universally Unique IDentifier) associated with this environment.\nThis value is generated when the environment is created.",
|
||||
"description": "Output only. The UUID (Universally Unique IDentifier) associated with this environment.\nThis value is generated when the environment is created.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -470,15 +471,15 @@
|
||||
"id": "EnvironmentConfig",
|
||||
"properties": {
|
||||
"airflowUri": {
|
||||
"description": "Output only.\nThe URI of the Apache Airflow Web UI hosted within this environment (see\n[Airflow web\ninterface](/composer/docs/how-to/accessing/airflow-web-interface)).",
|
||||
"description": "Output only. The URI of the Apache Airflow Web UI hosted within this environment (see\n[Airflow web\ninterface](/composer/docs/how-to/accessing/airflow-web-interface)).",
|
||||
"type": "string"
|
||||
},
|
||||
"dagGcsPrefix": {
|
||||
"description": "Output only.\nThe Cloud Storage prefix of the DAGs for this environment. Although Cloud\nStorage objects reside in a flat namespace, a hierarchical file tree\ncan be simulated using \"/\"-delimited object name prefixes. DAG objects for\nthis environment reside in a simulated directory with the given prefix.",
|
||||
"description": "Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud\nStorage objects reside in a flat namespace, a hierarchical file tree\ncan be simulated using \"/\"-delimited object name prefixes. DAG objects for\nthis environment reside in a simulated directory with the given prefix.",
|
||||
"type": "string"
|
||||
},
|
||||
"gkeCluster": {
|
||||
"description": "Output only.\nThe Kubernetes Engine cluster used to run this environment.",
|
||||
"description": "Output only. The Kubernetes Engine cluster used to run this environment.",
|
||||
"type": "string"
|
||||
},
|
||||
"nodeConfig": {
|
||||
@@ -490,6 +491,10 @@
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"privateEnvironmentConfig": {
|
||||
"$ref": "PrivateEnvironmentConfig",
|
||||
"description": "The configuration used for the Private IP Cloud Composer environment."
|
||||
},
|
||||
"softwareConfig": {
|
||||
"$ref": "SoftwareConfig",
|
||||
"description": "The configuration settings for software inside the environment."
|
||||
@@ -497,6 +502,33 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"IPAllocationPolicy": {
|
||||
"description": "Configuration for controlling how IPs are allocated in the\nGKE cluster running the Apache Airflow software.",
|
||||
"id": "IPAllocationPolicy",
|
||||
"properties": {
|
||||
"clusterIpv4CidrBlock": {
|
||||
"description": "Optional. The IP address range used to allocate IP addresses to pods in\nthe GKE cluster.\n\nThis field is applicable only when `use_ip_aliases` is true.\n\nSet to blank to have GKE choose a range with the default size.\n\nSet to /netmask (e.g. `/14`) to have GKE choose a range with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
|
||||
"type": "string"
|
||||
},
|
||||
"clusterSecondaryRangeName": {
|
||||
"description": "Optional. The name of the GKE cluster's secondary range used to allocate\nIP addresses to pods.\n\nThis field is applicable only when `use_ip_aliases` is true.",
|
||||
"type": "string"
|
||||
},
|
||||
"servicesIpv4CidrBlock": {
|
||||
"description": "Optional. The IP address range of the services IP addresses in this\nGKE cluster.\n\nThis field is applicable only when `use_ip_aliases` is true.\n\nSet to blank to have GKE choose a range with the default size.\n\nSet to /netmask (e.g. `/14`) to have GKE choose a range with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.",
|
||||
"type": "string"
|
||||
},
|
||||
"servicesSecondaryRangeName": {
|
||||
"description": "Optional. The name of the services' secondary range used to allocate\nIP addresses to the GKE cluster.\n\nThis field is applicable only when `use_ip_aliases` is true.",
|
||||
"type": "string"
|
||||
},
|
||||
"useIpAliases": {
|
||||
"description": "Optional. Whether or not to enable Alias IPs in the GKE cluster.\nIf `true`, a VPC-native cluster is created.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ImageVersion": {
|
||||
"description": "ImageVersion information",
|
||||
"id": "ImageVersion",
|
||||
@@ -582,12 +614,16 @@
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"ipAllocationPolicy": {
|
||||
"$ref": "IPAllocationPolicy",
|
||||
"description": "Optional. The configuration for controlling how IPs are allocated in the GKE cluster."
|
||||
},
|
||||
"location": {
|
||||
"description": "Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which\nto deploy the VMs used to run the Apache Airflow software, specified as a\n[relative resource\nname](/apis/design/resource_names#relative_resource_name). For example:\n\"projects/{projectId}/zones/{zoneId}\".\n\nThis `location` must belong to the enclosing environment's project and\nlocation. If both this field and `nodeConfig.machineType` are specified,\n`nodeConfig.machineType` must belong to this `location`; if both are\nunspecified, the service will pick a zone in the Compute Engine region\ncorresponding to the Cloud Composer location, and propagate that choice to\nboth fields. If only one field (`location` or `nodeConfig.machineType`) is\nspecified, the location information from the specified field will be\npropagated to the unspecified field.",
|
||||
"type": "string"
|
||||
},
|
||||
"machineType": {
|
||||
"description": "Optional. The Compute Engine\n[machine type](/compute/docs/machine-types) used for cluster instances,\nspecified as a\n[relative resource\nname](/apis/design/resource_names#relative_resource_name). For example:\n\"projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}\".\n\nThe `machineType` must belong to the enclosing environment's project and\nlocation. If both this field and `nodeConfig.location` are specified,\nthis `machineType` must belong to the `nodeConfig.location`; if both are\nunspecified, the service will pick a zone in the Compute Engine region\ncorresponding to the Cloud Composer location, and propagate that choice to\nboth fields. If exactly one of this field and `nodeConfig.location` is\nspecified, the location information from the specified field will be\npropagated to the unspecified field.\n\nIf this field is unspecified, the `machineTypeId` defaults\nto \"n1-standard-1\".",
|
||||
"description": "Optional. The Compute Engine\n[machine type](/compute/docs/machine-types) used for cluster instances,\nspecified as a\n[relative resource\nname](/apis/design/resource_names#relative_resource_name). For example:\n\"projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}\".\n\nThe `machineType` must belong to the enclosing environment's project and\nlocation. If both this field and `nodeConfig.location` are specified,\nthis `machineType` must belong to the `nodeConfig.location`; if both are\nunspecified, the service will pick a zone in the Compute Engine region\ncorresponding to the Cloud Composer location, and propagate that choice to\nboth fields. If exactly one of this field and `nodeConfig.location` is\nspecified, the location information from the specified field will be\npropagated to the unspecified field.\n\nThe `machineTypeId` must not be a [shared-core machine\ntype](/compute/docs/machine-types#sharedcore).\n\nIf this field is unspecified, the `machineTypeId` defaults\nto \"n1-standard-1\".",
|
||||
"type": "string"
|
||||
},
|
||||
"network": {
|
||||
@@ -659,17 +695,17 @@
|
||||
"id": "OperationMetadata",
|
||||
"properties": {
|
||||
"createTime": {
|
||||
"description": "Output only.\nThe time the operation was submitted to the server.",
|
||||
"description": "Output only. The time the operation was submitted to the server.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"endTime": {
|
||||
"description": "Output only.\nThe time when the operation terminated, regardless of its success.\nThis field is unset if the operation is still ongoing.",
|
||||
"description": "Output only. The time when the operation terminated, regardless of its success.\nThis field is unset if the operation is still ongoing.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"operationType": {
|
||||
"description": "Output only.\nThe type of operation being performed.",
|
||||
"description": "Output only. The type of operation being performed.",
|
||||
"enum": [
|
||||
"TYPE_UNSPECIFIED",
|
||||
"CREATE",
|
||||
@@ -685,15 +721,15 @@
|
||||
"type": "string"
|
||||
},
|
||||
"resource": {
|
||||
"description": "Output only.\nThe resource being operated on, as a [relative resource name](\n/apis/design/resource_names#relative_resource_name).",
|
||||
"description": "Output only. The resource being operated on, as a [relative resource name](\n/apis/design/resource_names#relative_resource_name).",
|
||||
"type": "string"
|
||||
},
|
||||
"resourceUuid": {
|
||||
"description": "Output only.\nThe UUID of the resource being operated on.",
|
||||
"description": "Output only. The UUID of the resource being operated on.",
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
"description": "Output only.\nThe current operation state.",
|
||||
"description": "Output only. The current operation state.",
|
||||
"enum": [
|
||||
"STATE_UNSPECIFIED",
|
||||
"PENDING",
|
||||
@@ -715,6 +751,52 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PrivateClusterConfig": {
|
||||
"description": "Configuration options for the private GKE cluster in a Cloud Composer\nenvironment.",
|
||||
"id": "PrivateClusterConfig",
|
||||
"properties": {
|
||||
"enablePrivateEndpoint": {
|
||||
"description": "Optional. If `true`, access to the public endpoint of the GKE cluster is\ndenied.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"masterIpv4CidrBlock": {
|
||||
"description": "Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If\nleft blank, the default value of '172.16.0.0/23' is used.",
|
||||
"type": "string"
|
||||
},
|
||||
"masterIpv4ReservedRange": {
|
||||
"description": "Output only. The IP range in CIDR notation to use for the hosted master network. This\nrange is used for assigning internal IP addresses to the GKE cluster\nmaster or set of masters and to the internal load balancer virtual IP.\nThis range must not overlap with any other ranges in use\nwithin the cluster's network.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PrivateEnvironmentConfig": {
|
||||
"description": "The configuration information for configuring a Private IP Cloud Composer\nenvironment.",
|
||||
"id": "PrivateEnvironmentConfig",
|
||||
"properties": {
|
||||
"cloudSqlIpv4CidrBlock": {
|
||||
"description": "Optional. The CIDR block from which IP range in tenant project will be reserved for\nCloud SQL. Needs to be disjoint from `web_server_ipv4_cidr_block`.",
|
||||
"type": "string"
|
||||
},
|
||||
"enablePrivateEnvironment": {
|
||||
"description": "Optional. If `true`, a Private IP Cloud Composer environment is created.\nIf this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be\nset to true.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"privateClusterConfig": {
|
||||
"$ref": "PrivateClusterConfig",
|
||||
"description": "Optional. Configuration for the private GKE cluster for a Private IP\nCloud Composer environment."
|
||||
},
|
||||
"webServerIpv4CidrBlock": {
|
||||
"description": "Optional. The CIDR block from which IP range for web server will be reserved. Needs\nto be disjoint from `private_cluster_config.master_ipv4_cidr_block` and\n`cloud_sql_ipv4_cidr_block`.",
|
||||
"type": "string"
|
||||
},
|
||||
"webServerIpv4ReservedRange": {
|
||||
"description": "Output only. The IP range reserved for the tenant project's App Engine VMs.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SoftwareConfig": {
|
||||
"description": "Specifies the selection and configuration of software inside the environment.",
|
||||
"id": "SoftwareConfig",
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "composer:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://composer.mtls.googleapis.com/",
|
||||
"name": "composer",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -400,9 +401,24 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190613",
|
||||
"revision": "20200406",
|
||||
"rootUrl": "https://composer.googleapis.com/",
|
||||
"schemas": {
|
||||
"AllowedIpRange": {
|
||||
"description": "Allowed IP range with user-provided description.",
|
||||
"id": "AllowedIpRange",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "Optional. User-provided description. It must contain at most 300 characters.",
|
||||
"type": "string"
|
||||
},
|
||||
"value": {
|
||||
"description": "IP address or range, defined using CIDR notation, of requests that this\nrule applies to.\nExamples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32`\n or `2001:0db8:0000:0042:0000:8a2e:0370:7334`.\n\n\n<p>IP range prefixes should be properly truncated. For example,\n`1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6,\n`2001:db8::1/32` should be truncated to `2001:db8::/32`.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"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",
|
||||
@@ -418,7 +434,7 @@
|
||||
"description": "Configuration parameters for this environment."
|
||||
},
|
||||
"createTime": {
|
||||
"description": "Output only.\nThe time at which this environment was created.",
|
||||
"description": "Output only. The time at which this environment was created.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -430,7 +446,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"name": {
|
||||
"description": "The resource name of the environment, in the form:\n\"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
|
||||
"description": "The resource name of the environment, in the form:\n\"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"\n\nEnvironmentId must start with a lowercase letter followed by up to 63\nlowercase letters, numbers, or hyphens, and cannot end with a hyphen.",
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
@@ -454,12 +470,12 @@
|
||||
"type": "string"
|
||||
},
|
||||
"updateTime": {
|
||||
"description": "Output only.\nThe time at which this environment was last modified.",
|
||||
"description": "Output only. The time at which this environment was last modified.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"uuid": {
|
||||
"description": "Output only.\nThe UUID (Universally Unique IDentifier) associated with this environment.\nThis value is generated when the environment is created.",
|
||||
"description": "Output only. The UUID (Universally Unique IDentifier) associated with this environment.\nThis value is generated when the environment is created.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -470,15 +486,15 @@
|
||||
"id": "EnvironmentConfig",
|
||||
"properties": {
|
||||
"airflowUri": {
|
||||
"description": "Output only.\nThe URI of the Apache Airflow Web UI hosted within this environment (see\n[Airflow web\ninterface](/composer/docs/how-to/accessing/airflow-web-interface)).",
|
||||
"description": "Output only. The URI of the Apache Airflow Web UI hosted within this environment (see\n[Airflow web\ninterface](/composer/docs/how-to/accessing/airflow-web-interface)).",
|
||||
"type": "string"
|
||||
},
|
||||
"dagGcsPrefix": {
|
||||
"description": "Output only.\nThe Cloud Storage prefix of the DAGs for this environment. Although Cloud\nStorage objects reside in a flat namespace, a hierarchical file tree\ncan be simulated using \"/\"-delimited object name prefixes. DAG objects for\nthis environment reside in a simulated directory with the given prefix.",
|
||||
"description": "Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud\nStorage objects reside in a flat namespace, a hierarchical file tree\ncan be simulated using \"/\"-delimited object name prefixes. DAG objects for\nthis environment reside in a simulated directory with the given prefix.",
|
||||
"type": "string"
|
||||
},
|
||||
"gkeCluster": {
|
||||
"description": "Output only.\nThe Kubernetes Engine cluster used to run this environment.",
|
||||
"description": "Output only. The Kubernetes Engine cluster used to run this environment.",
|
||||
"type": "string"
|
||||
},
|
||||
"nodeConfig": {
|
||||
@@ -497,6 +513,10 @@
|
||||
"softwareConfig": {
|
||||
"$ref": "SoftwareConfig",
|
||||
"description": "The configuration settings for software inside the environment."
|
||||
},
|
||||
"webServerNetworkAccessControl": {
|
||||
"$ref": "WebServerNetworkAccessControl",
|
||||
"description": "Optional. The network-level access control policy for the Airflow web server. If\nunspecified, no network-level access restrictions will be applied."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -622,7 +642,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"machineType": {
|
||||
"description": "Optional. The Compute Engine\n[machine type](/compute/docs/machine-types) used for cluster instances,\nspecified as a\n[relative resource\nname](/apis/design/resource_names#relative_resource_name). For example:\n\"projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}\".\n\nThe `machineType` must belong to the enclosing environment's project and\nlocation. If both this field and `nodeConfig.location` are specified,\nthis `machineType` must belong to the `nodeConfig.location`; if both are\nunspecified, the service will pick a zone in the Compute Engine region\ncorresponding to the Cloud Composer location, and propagate that choice to\nboth fields. If exactly one of this field and `nodeConfig.location` is\nspecified, the location information from the specified field will be\npropagated to the unspecified field.\n\nIf this field is unspecified, the `machineTypeId` defaults\nto \"n1-standard-1\".",
|
||||
"description": "Optional. The Compute Engine\n[machine type](/compute/docs/machine-types) used for cluster instances,\nspecified as a\n[relative resource\nname](/apis/design/resource_names#relative_resource_name). For example:\n\"projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}\".\n\nThe `machineType` must belong to the enclosing environment's project and\nlocation. If both this field and `nodeConfig.location` are specified,\nthis `machineType` must belong to the `nodeConfig.location`; if both are\nunspecified, the service will pick a zone in the Compute Engine region\ncorresponding to the Cloud Composer location, and propagate that choice to\nboth fields. If exactly one of this field and `nodeConfig.location` is\nspecified, the location information from the specified field will be\npropagated to the unspecified field.\n\nThe `machineTypeId` must not be a [shared-core machine\ntype](/compute/docs/machine-types#sharedcore).\n\nIf this field is unspecified, the `machineTypeId` defaults\nto \"n1-standard-1\".",
|
||||
"type": "string"
|
||||
},
|
||||
"network": {
|
||||
@@ -694,17 +714,17 @@
|
||||
"id": "OperationMetadata",
|
||||
"properties": {
|
||||
"createTime": {
|
||||
"description": "Output only.\nThe time the operation was submitted to the server.",
|
||||
"description": "Output only. The time the operation was submitted to the server.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"endTime": {
|
||||
"description": "Output only.\nThe time when the operation terminated, regardless of its success.\nThis field is unset if the operation is still ongoing.",
|
||||
"description": "Output only. The time when the operation terminated, regardless of its success.\nThis field is unset if the operation is still ongoing.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"operationType": {
|
||||
"description": "Output only.\nThe type of operation being performed.",
|
||||
"description": "Output only. The type of operation being performed.",
|
||||
"enum": [
|
||||
"TYPE_UNSPECIFIED",
|
||||
"CREATE",
|
||||
@@ -720,15 +740,15 @@
|
||||
"type": "string"
|
||||
},
|
||||
"resource": {
|
||||
"description": "Output only.\nThe resource being operated on, as a [relative resource name](\n/apis/design/resource_names#relative_resource_name).",
|
||||
"description": "Output only. The resource being operated on, as a [relative resource name](\n/apis/design/resource_names#relative_resource_name).",
|
||||
"type": "string"
|
||||
},
|
||||
"resourceUuid": {
|
||||
"description": "Output only.\nThe UUID of the resource being operated on.",
|
||||
"description": "Output only. The UUID of the resource being operated on.",
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
"description": "Output only.\nThe current operation state.",
|
||||
"description": "Output only. The current operation state.",
|
||||
"enum": [
|
||||
"STATE_UNSPECIFIED",
|
||||
"PENDING",
|
||||
@@ -757,7 +777,11 @@
|
||||
"type": "boolean"
|
||||
},
|
||||
"masterIpv4CidrBlock": {
|
||||
"description": "The IP range in CIDR notation to use for the hosted master network. This\nrange is used for assigning internal IP addresses to the cluster\nmaster or set of masters and to the internal load balancer virtual IP.\nThis range must not overlap with any other ranges in use\nwithin the cluster's network. If left blank, the default value of\n'172.16.0.0/28' is used.",
|
||||
"description": "Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If\nleft blank, the default value of '172.16.0.0/23' is used.",
|
||||
"type": "string"
|
||||
},
|
||||
"masterIpv4ReservedRange": {
|
||||
"description": "Output only. The IP range in CIDR notation to use for the hosted master network. This\nrange is used for assigning internal IP addresses to the cluster\nmaster or set of masters and to the internal load balancer virtual IP.\nThis range must not overlap with any other ranges in use\nwithin the cluster's network.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -767,6 +791,10 @@
|
||||
"description": "The configuration information for configuring a Private IP Cloud Composer\nenvironment.",
|
||||
"id": "PrivateEnvironmentConfig",
|
||||
"properties": {
|
||||
"cloudSqlIpv4CidrBlock": {
|
||||
"description": "Optional. The CIDR block from which IP range in tenant project will be reserved for\nCloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block",
|
||||
"type": "string"
|
||||
},
|
||||
"enablePrivateEnvironment": {
|
||||
"description": "Optional. If `true`, a Private IP Cloud Composer environment is created.\nIf this field is true, `use_ip_aliases` must be true.",
|
||||
"type": "boolean"
|
||||
@@ -774,6 +802,14 @@
|
||||
"privateClusterConfig": {
|
||||
"$ref": "PrivateClusterConfig",
|
||||
"description": "Optional. Configuration for the private GKE cluster for a Private IP\nCloud Composer environment."
|
||||
},
|
||||
"webServerIpv4CidrBlock": {
|
||||
"description": "Optional. The CIDR block from which IP range for web server will be reserved. Needs\nto be disjoint from private_cluster_config.master_ipv4_cidr_block and\ncloud_sql_ipv4_cidr_block.",
|
||||
"type": "string"
|
||||
},
|
||||
"webServerIpv4ReservedRange": {
|
||||
"description": "Output only. The IP range reserved for the tenant project's App Engine VMs.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -840,6 +876,20 @@
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"WebServerNetworkAccessControl": {
|
||||
"description": "Network-level access control policy for the Airflow web server.",
|
||||
"id": "WebServerNetworkAccessControl",
|
||||
"properties": {
|
||||
"allowedIpRanges": {
|
||||
"description": "A collection of allowed IP ranges with descriptions.",
|
||||
"items": {
|
||||
"$ref": "AllowedIpRange"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "containeranalysis:v1alpha1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://containeranalysis.mtls.googleapis.com/",
|
||||
"name": "containeranalysis",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -601,7 +602,8 @@
|
||||
"PACKAGE_MANAGER",
|
||||
"DEPLOYABLE",
|
||||
"DISCOVERY",
|
||||
"ATTESTATION_AUTHORITY"
|
||||
"ATTESTATION_AUTHORITY",
|
||||
"UPGRADE"
|
||||
],
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -1204,7 +1206,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190625",
|
||||
"revision": "20200327",
|
||||
"rootUrl": "https://containeranalysis.googleapis.com/",
|
||||
"schemas": {
|
||||
"Artifact": {
|
||||
@@ -1264,54 +1266,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
"description": "The configuration for logging of each type of permission.",
|
||||
"items": {
|
||||
"$ref": "AuditLogConfig"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"service": {
|
||||
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"logType": {
|
||||
"description": "The log type that this config enables.",
|
||||
"enum": [
|
||||
"LOG_TYPE_UNSPECIFIED",
|
||||
"ADMIN_READ",
|
||||
"DATA_WRITE",
|
||||
"DATA_READ"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default case. Should never be this.",
|
||||
"Admin reads. Example: CloudIAM getIamPolicy",
|
||||
"Data writes. Example: CloudSQL Users create",
|
||||
"Data reads. Example: CloudSQL Users list"
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Basis": {
|
||||
"description": "Basis describes the base image portion (Note) of the DockerImage\nrelationship. Linked occurrences are derived from this or an\nequivalent image via:\n FROM <Basis.resource_url>\nOr an equivalent reference, e.g. a tag of the resource_url.",
|
||||
"id": "Basis",
|
||||
@@ -1336,7 +1290,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1716,6 +1670,10 @@
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"cpe": {
|
||||
"description": "The CPE of the resource being scanned.",
|
||||
"type": "string"
|
||||
},
|
||||
"operation": {
|
||||
"$ref": "Operation",
|
||||
"description": "Output only. An operation that indicates the status of the current scan.\nThis field is deprecated, do not use."
|
||||
@@ -1737,7 +1695,8 @@
|
||||
"PACKAGE_MANAGER",
|
||||
"DEPLOYABLE",
|
||||
"DISCOVERY",
|
||||
"ATTESTATION_AUTHORITY"
|
||||
"ATTESTATION_AUTHORITY",
|
||||
"UPGRADE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unknown",
|
||||
@@ -1747,7 +1706,8 @@
|
||||
"This represents a package installed via a package manager.",
|
||||
"The note and occurrence track deployment events.",
|
||||
"The note and occurrence track the initial discovery status of a resource.",
|
||||
"This represents a logical \"role\" that can attest to artifacts."
|
||||
"This represents a logical \"role\" that can attest to artifacts.",
|
||||
"This represents an available software upgrade."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
@@ -1802,23 +1762,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1863,7 +1823,24 @@
|
||||
"GetIamPolicyRequest": {
|
||||
"description": "Request message for `GetIamPolicy` method.",
|
||||
"id": "GetIamPolicyRequest",
|
||||
"properties": {},
|
||||
"properties": {
|
||||
"options": {
|
||||
"$ref": "GetPolicyOptions",
|
||||
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetPolicyOptions": {
|
||||
"description": "Encapsulates settings provided to GetIamPolicy.",
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetVulnzOccurrencesSummaryResponse": {
|
||||
@@ -1954,7 +1931,7 @@
|
||||
"id": "GoogleDevtoolsContaineranalysisV1alpha1GitSourceContext",
|
||||
"properties": {
|
||||
"revisionId": {
|
||||
"description": "Required.\nGit commit hash.",
|
||||
"description": "Required. Git commit hash.",
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
@@ -2269,7 +2246,8 @@
|
||||
"PACKAGE_MANAGER",
|
||||
"DEPLOYABLE",
|
||||
"DISCOVERY",
|
||||
"ATTESTATION_AUTHORITY"
|
||||
"ATTESTATION_AUTHORITY",
|
||||
"UPGRADE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unknown",
|
||||
@@ -2279,7 +2257,8 @@
|
||||
"This represents a package installed via a package manager.",
|
||||
"The note and occurrence track deployment events.",
|
||||
"The note and occurrence track the initial discovery status of a resource.",
|
||||
"This represents a logical \"role\" that can attest to artifacts."
|
||||
"This represents a logical \"role\" that can attest to artifacts.",
|
||||
"This represents an available software upgrade."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -2288,7 +2267,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the note in the form\n\"providers/{provider_id}/notes/{NOTE_ID}\"",
|
||||
"description": "The name of the note in the form\n\"projects/{provider_project_id}/notes/{NOTE_ID}\"",
|
||||
"type": "string"
|
||||
},
|
||||
"package": {
|
||||
@@ -2311,6 +2290,10 @@
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"upgrade": {
|
||||
"$ref": "UpgradeNote",
|
||||
"description": "A note describing an upgrade."
|
||||
},
|
||||
"vulnerabilityType": {
|
||||
"$ref": "VulnerabilityType",
|
||||
"description": "A package vulnerability type of note."
|
||||
@@ -2361,7 +2344,8 @@
|
||||
"PACKAGE_MANAGER",
|
||||
"DEPLOYABLE",
|
||||
"DISCOVERY",
|
||||
"ATTESTATION_AUTHORITY"
|
||||
"ATTESTATION_AUTHORITY",
|
||||
"UPGRADE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unknown",
|
||||
@@ -2371,7 +2355,8 @@
|
||||
"This represents a package installed via a package manager.",
|
||||
"The note and occurrence track deployment events.",
|
||||
"The note and occurrence track the initial discovery status of a resource.",
|
||||
"This represents a logical \"role\" that can attest to artifacts."
|
||||
"This represents a logical \"role\" that can attest to artifacts.",
|
||||
"This represents an available software upgrade."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -2400,6 +2385,10 @@
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"upgrade": {
|
||||
"$ref": "UpgradeOccurrence",
|
||||
"description": "Describes an upgrade."
|
||||
},
|
||||
"vulnerabilityDetails": {
|
||||
"$ref": "VulnerabilityDetails",
|
||||
"description": "Details of a security vulnerability note."
|
||||
@@ -2506,30 +2495,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
"description": "Specifies cloud audit logging configuration for this policy.",
|
||||
"items": {
|
||||
"$ref": "AuditConfig"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -2633,11 +2615,6 @@
|
||||
"policy": {
|
||||
"$ref": "Policy",
|
||||
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
|
||||
"format": "google-fieldmask",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -2802,6 +2779,73 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"UpgradeDistribution": {
|
||||
"description": "The Upgrade Distribution represents metadata about the Upgrade for each\noperating system (CPE). Some distributions have additional metadata around\nupdates, classifying them into various categories and severities.",
|
||||
"id": "UpgradeDistribution",
|
||||
"properties": {
|
||||
"classification": {
|
||||
"description": "The operating system classification of this Upgrade, as specified by the\nupstream operating system upgrade feed.",
|
||||
"type": "string"
|
||||
},
|
||||
"cpeUri": {
|
||||
"description": "Required - The specific operating system this metadata applies to. See\nhttps://cpe.mitre.org/specification/.",
|
||||
"type": "string"
|
||||
},
|
||||
"cve": {
|
||||
"description": "The cve that would be resolved by this upgrade.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"severity": {
|
||||
"description": "The severity as specified by the upstream operating system.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"UpgradeNote": {
|
||||
"description": "An Upgrade Note represents a potential upgrade of a package to a given\nversion. For each package version combination (i.e. bash 4.0, bash 4.1,\nbash 4.1.2), there will be a Upgrade Note.",
|
||||
"id": "UpgradeNote",
|
||||
"properties": {
|
||||
"distributions": {
|
||||
"description": "Metadata about the upgrade for each specific operating system.",
|
||||
"items": {
|
||||
"$ref": "UpgradeDistribution"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"package": {
|
||||
"description": "Required - The package this Upgrade is for.",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"$ref": "Version",
|
||||
"description": "Required - The version of the package in machine + human readable form."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"UpgradeOccurrence": {
|
||||
"description": "An Upgrade Occurrence represents that a specific resource_url could install a\nspecific upgrade. This presence is supplied via local sources (i.e. it is\npresent in the mirror and the running system has noticed its availability).",
|
||||
"id": "UpgradeOccurrence",
|
||||
"properties": {
|
||||
"distribution": {
|
||||
"$ref": "UpgradeDistribution",
|
||||
"description": "Metadata about the upgrade for available for the specific operating system\nfor the resource_url. This allows efficient filtering, as well as\nmaking it easier to use the occurrence."
|
||||
},
|
||||
"package": {
|
||||
"description": "Required - The package this Upgrade is for.",
|
||||
"type": "string"
|
||||
},
|
||||
"parsedVersion": {
|
||||
"$ref": "Version",
|
||||
"description": "Required - The version of the package in a machine + human readable form."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Version": {
|
||||
"description": "Version contains structured information about the version of the package.\nFor a discussion of this in Debian/Ubuntu:\nhttp://serverfault.com/questions/604541/debian-packages-version-convention\nFor a discussion of this in Redhat/Fedora/Centos:\nhttp://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/",
|
||||
"id": "Version",
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "containeranalysis:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://containeranalysis.mtls.googleapis.com/",
|
||||
"name": "containeranalysis",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -118,7 +119,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The name of the project in the form of `projects/[PROJECT_ID]`, under which\nthe notes are to be created.",
|
||||
"description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which\nthe notes are to be created.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -146,12 +147,12 @@
|
||||
],
|
||||
"parameters": {
|
||||
"noteId": {
|
||||
"description": "The ID to use for this note.",
|
||||
"description": "Required. The ID to use for this note.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The name of the project in the form of `projects/[PROJECT_ID]`, under which\nthe note is to be created.",
|
||||
"description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which\nthe note is to be created.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -179,7 +180,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the note in the form of\n`projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
|
||||
"description": "Required. The name of the note in the form of\n`projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/notes/[^/]+$",
|
||||
"required": true,
|
||||
@@ -204,7 +205,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the note in the form of\n`projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
|
||||
"description": "Required. The name of the note in the form of\n`projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/notes/[^/]+$",
|
||||
"required": true,
|
||||
@@ -273,7 +274,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The name of the project to list notes for in the form of\n`projects/[PROJECT_ID]`.",
|
||||
"description": "Required. The name of the project to list notes for in the form of\n`projects/[PROJECT_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -298,7 +299,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the note in the form of\n`projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
|
||||
"description": "Required. The name of the note in the form of\n`projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/notes/[^/]+$",
|
||||
"required": true,
|
||||
@@ -397,7 +398,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "The name of the note to list occurrences for in the form of\n`projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
|
||||
"description": "Required. The name of the note to list occurrences for in the form of\n`projects/[PROVIDER_ID]/notes/[NOTE_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/notes/[^/]+$",
|
||||
"required": true,
|
||||
@@ -439,7 +440,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The name of the project in the form of `projects/[PROJECT_ID]`, under which\nthe occurrences are to be created.",
|
||||
"description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which\nthe occurrences are to be created.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -467,7 +468,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "The name of the project in the form of `projects/[PROJECT_ID]`, under which\nthe occurrence is to be created.",
|
||||
"description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which\nthe occurrence is to be created.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -495,7 +496,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the occurrence in the form of\n`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
|
||||
"description": "Required. The name of the occurrence in the form of\n`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
|
||||
"required": true,
|
||||
@@ -520,7 +521,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the occurrence in the form of\n`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
|
||||
"description": "Required. The name of the occurrence in the form of\n`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
|
||||
"required": true,
|
||||
@@ -573,7 +574,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the occurrence in the form of\n`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
|
||||
"description": "Required. The name of the occurrence in the form of\n`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
|
||||
"required": true,
|
||||
@@ -603,7 +604,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The name of the project to get a vulnerability summary for in the form of\n`projects/[PROJECT_ID]`.",
|
||||
"description": "Required. The name of the project to get a vulnerability summary for in the form of\n`projects/[PROJECT_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -644,7 +645,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The name of the project to list occurrences for in the form of\n`projects/[PROJECT_ID]`.",
|
||||
"description": "Required. The name of the project to list occurrences for in the form of\n`projects/[PROJECT_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -669,7 +670,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the occurrence in the form of\n`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
|
||||
"description": "Required. The name of the occurrence in the form of\n`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
|
||||
"required": true,
|
||||
@@ -763,7 +764,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the scan configuration in the form of\n`projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.",
|
||||
"description": "Required. The name of the scan configuration in the form of\n`projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -788,7 +789,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "The filter expression.",
|
||||
"description": "Required. The filter expression.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -804,7 +805,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "The name of the project to list scan configurations for in the form of\n`projects/[PROJECT_ID]`.",
|
||||
"description": "Required. The name of the project to list scan configurations for in the form of\n`projects/[PROJECT_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
@@ -829,7 +830,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"name": {
|
||||
"description": "The name of the scan configuration in the form of\n`projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.",
|
||||
"description": "Required. The name of the scan configuration in the form of\n`projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
|
||||
"required": true,
|
||||
@@ -852,7 +853,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190625",
|
||||
"revision": "20200327",
|
||||
"rootUrl": "https://containeranalysis.googleapis.com/",
|
||||
"schemas": {
|
||||
"AliasContext": {
|
||||
@@ -918,54 +919,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
"description": "The configuration for logging of each type of permission.",
|
||||
"items": {
|
||||
"$ref": "AuditLogConfig"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"service": {
|
||||
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"logType": {
|
||||
"description": "The log type that this config enables.",
|
||||
"enum": [
|
||||
"LOG_TYPE_UNSPECIFIED",
|
||||
"ADMIN_READ",
|
||||
"DATA_WRITE",
|
||||
"DATA_READ"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default case. Should never be this.",
|
||||
"Admin reads. Example: CloudIAM getIamPolicy",
|
||||
"Data writes. Example: CloudSQL Users create",
|
||||
"Data reads. Example: CloudSQL Users list"
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Authority": {
|
||||
"description": "Note kind that represents a logical attestation \"role\" or \"authority\". For\nexample, an organization might have one `Authority` for \"QA\" and one for\n\"build\". This note is intended to act strictly as a grouping mechanism for\nthe attached occurrences (Attestations). This grouping mechanism also\nprovides a security boundary, since IAM ACLs gate the ability for a principle\nto attach an occurrence to a given note. It also provides a single point of\nlookup to find all attached attestation occurrences, even if they don't all\nlive in the same project.",
|
||||
"id": "Authority",
|
||||
@@ -1000,7 +953,7 @@
|
||||
"additionalProperties": {
|
||||
"$ref": "Note"
|
||||
},
|
||||
"description": "The notes to create. Max allowed length is 1000.",
|
||||
"description": "Required. The notes to create. Max allowed length is 1000.",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
@@ -1025,7 +978,7 @@
|
||||
"id": "BatchCreateOccurrencesRequest",
|
||||
"properties": {
|
||||
"occurrences": {
|
||||
"description": "The occurrences to create. Max allowed length is 1000.",
|
||||
"description": "Required. The occurrences to create. Max allowed length is 1000.",
|
||||
"items": {
|
||||
"$ref": "Occurrence"
|
||||
},
|
||||
@@ -1057,7 +1010,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1501,7 +1454,7 @@
|
||||
},
|
||||
"maxAffectedVersion": {
|
||||
"$ref": "Version",
|
||||
"description": "Deprecated, do not use. Use fixed_location instead.\n\nThe max version of the package in which the vulnerability exists."
|
||||
"description": "The max version of the package in which the vulnerability exists."
|
||||
},
|
||||
"minAffectedVersion": {
|
||||
"$ref": "Version",
|
||||
@@ -1518,6 +1471,11 @@
|
||||
"severityName": {
|
||||
"description": "The severity (eg: distro assigned severity) for this vulnerability.",
|
||||
"type": "string"
|
||||
},
|
||||
"sourceUpdateTime": {
|
||||
"description": "The time this information was last changed at the source. This is an\nupstream timestamp from the underlying information source - e.g. Ubuntu\nsecurity tracker.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1662,23 +1620,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1818,7 +1776,24 @@
|
||||
"GetIamPolicyRequest": {
|
||||
"description": "Request message for `GetIamPolicy` method.",
|
||||
"id": "GetIamPolicyRequest",
|
||||
"properties": {},
|
||||
"properties": {
|
||||
"options": {
|
||||
"$ref": "GetPolicyOptions",
|
||||
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GetPolicyOptions": {
|
||||
"description": "Encapsulates settings provided to GetIamPolicy.",
|
||||
"id": "GetPolicyOptions",
|
||||
"properties": {
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GitSourceContext": {
|
||||
@@ -2453,30 +2428,23 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
"description": "Specifies cloud audit logging configuration for this policy.",
|
||||
"items": {
|
||||
"$ref": "AuditConfig"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -2583,11 +2551,6 @@
|
||||
"policy": {
|
||||
"$ref": "Policy",
|
||||
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
|
||||
},
|
||||
"updateMask": {
|
||||
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
|
||||
"format": "google-fieldmask",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -2794,6 +2757,11 @@
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"sourceUpdateTime": {
|
||||
"description": "The time this information was last changed at the source. This is an\nupstream timestamp from the underlying information source - e.g. Ubuntu\nsecurity tracker.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"windowsDetails": {
|
||||
"description": "Windows details get their own format because the information format and\nmodel don't match a normal detail. Specifically Windows updates are done as\npatches, thus Windows vulnerabilities really are a missing package, rather\nthan a package being at an incorrect version.",
|
||||
"items": {
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -5,7 +5,7 @@
|
||||
"description": "Searches over a website or collection of websites",
|
||||
"discoveryVersion": "v1",
|
||||
"documentationLink": "https://developers.google.com/custom-search/v1/using_rest",
|
||||
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/DuDrBlvHLFXE8uorI6UhfoH-kUs\"",
|
||||
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/DuDrBlvHLFXE8uorI6UhfoH-kUs\"",
|
||||
"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"
|
||||
|
||||
2754
etc/api/datacatalog/v1beta1/datacatalog-api.json
Normal file
2754
etc/api/datacatalog/v1beta1/datacatalog-api.json
Normal file
File diff suppressed because it is too large
Load Diff
@@ -29,6 +29,7 @@
|
||||
},
|
||||
"id": "dataflow:v1b3",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://dataflow.mtls.googleapis.com/",
|
||||
"name": "dataflow",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -819,6 +820,47 @@
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"flexTemplates": {
|
||||
"methods": {
|
||||
"launch": {
|
||||
"description": "Launch a job with a FlexTemplate.",
|
||||
"flatPath": "v1b3/projects/{projectId}/locations/{location}/flexTemplates:launch",
|
||||
"httpMethod": "POST",
|
||||
"id": "dataflow.projects.locations.flexTemplates.launch",
|
||||
"parameterOrder": [
|
||||
"projectId",
|
||||
"location"
|
||||
],
|
||||
"parameters": {
|
||||
"location": {
|
||||
"description": "Required. The [regional endpoint]\n(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to\nwhich to direct the request. E.g., us-central1, us-west1.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1b3/projects/{projectId}/locations/{location}/flexTemplates:launch",
|
||||
"request": {
|
||||
"$ref": "LaunchFlexTemplateRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "LaunchFlexTemplateResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/compute",
|
||||
"https://www.googleapis.com/auth/compute.readonly",
|
||||
"https://www.googleapis.com/auth/userinfo.email"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"jobs": {
|
||||
"methods": {
|
||||
"create": {
|
||||
@@ -1972,7 +2014,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190628",
|
||||
"revision": "20200319",
|
||||
"rootUrl": "https://dataflow.googleapis.com/",
|
||||
"schemas": {
|
||||
"ApproximateProgress": {
|
||||
@@ -2276,6 +2318,25 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ContainerSpec": {
|
||||
"description": "Container Spec.",
|
||||
"id": "ContainerSpec",
|
||||
"properties": {
|
||||
"image": {
|
||||
"description": "Name of the docker container image. E.g., gcr.io/project/some-image",
|
||||
"type": "string"
|
||||
},
|
||||
"metadata": {
|
||||
"$ref": "TemplateMetadata",
|
||||
"description": "Metadata describing a template including description and validation rules."
|
||||
},
|
||||
"sdkInfo": {
|
||||
"$ref": "SDKInfo",
|
||||
"description": "Required. SDK info of the Flex Template."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CounterMetadata": {
|
||||
"description": "CounterMetadata includes all static non-name non-value counter attributes.",
|
||||
"id": "CounterMetadata",
|
||||
@@ -2809,6 +2870,14 @@
|
||||
"$ref": "WorkerPool"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"workerRegion": {
|
||||
"description": "The Compute Engine region\n(https://cloud.google.com/compute/docs/regions-zones/regions-zones) in\nwhich worker processing should occur, e.g. \"us-west1\". Mutually exclusive\nwith worker_zone. If neither worker_region nor worker_zone is specified,\ndefault to the control plane's region.",
|
||||
"type": "string"
|
||||
},
|
||||
"workerZone": {
|
||||
"description": "The Compute Engine zone\n(https://cloud.google.com/compute/docs/regions-zones/regions-zones) in\nwhich worker processing should occur, e.g. \"us-west1-a\". Mutually exclusive\nwith worker_region. If neither worker_region nor worker_zone is specified,\na zone in the control plane's region is chosen based on available capacity.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -3035,9 +3104,27 @@
|
||||
"$ref": "TemplateMetadata",
|
||||
"description": "The template metadata describing the template name, available\nparameters, etc."
|
||||
},
|
||||
"runtimeMetadata": {
|
||||
"$ref": "RuntimeMetadata",
|
||||
"description": "Describes the runtime metadata with SDKInfo and available parameters."
|
||||
},
|
||||
"status": {
|
||||
"$ref": "Status",
|
||||
"description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details."
|
||||
},
|
||||
"templateType": {
|
||||
"description": "Template Type.",
|
||||
"enum": [
|
||||
"UNKNOWN",
|
||||
"LEGACY",
|
||||
"FLEX"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unknown Template Type.",
|
||||
"Legacy Template.",
|
||||
"Flex Template."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -3552,6 +3639,58 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"LaunchFlexTemplateParameter": {
|
||||
"description": "Launch FlexTemplate Parameter.",
|
||||
"id": "LaunchFlexTemplateParameter",
|
||||
"properties": {
|
||||
"containerSpec": {
|
||||
"$ref": "ContainerSpec",
|
||||
"description": "Spec about the container image to launch."
|
||||
},
|
||||
"containerSpecGcsPath": {
|
||||
"description": "Gcs path to a file with json serialized ContainerSpec as content.",
|
||||
"type": "string"
|
||||
},
|
||||
"jobName": {
|
||||
"description": "Required. The job name to use for the created job.",
|
||||
"type": "string"
|
||||
},
|
||||
"parameters": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "The parameters for FlexTemplate.\nEx. {\"num_workers\":\"5\"}",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"LaunchFlexTemplateRequest": {
|
||||
"description": "A request to launch a Cloud Dataflow job from a FlexTemplate.",
|
||||
"id": "LaunchFlexTemplateRequest",
|
||||
"properties": {
|
||||
"launchParameter": {
|
||||
"$ref": "LaunchFlexTemplateParameter",
|
||||
"description": "Required. Parameter to launch a job form Flex Template."
|
||||
},
|
||||
"validateOnly": {
|
||||
"description": "If true, the request is validated but not actually executed.\nDefaults to false.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"LaunchFlexTemplateResponse": {
|
||||
"description": "Response to the request to launch a job from Flex Template.",
|
||||
"id": "LaunchFlexTemplateResponse",
|
||||
"properties": {
|
||||
"job": {
|
||||
"$ref": "Job",
|
||||
"description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"LaunchTemplateParameters": {
|
||||
"description": "Parameters to provide to the template being launched.",
|
||||
"id": "LaunchTemplateParameters",
|
||||
@@ -3691,7 +3830,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"ListJobsResponse": {
|
||||
"description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest.",
|
||||
"description": "Response to a request to list Cloud Dataflow jobs in a project. This might\nbe a partial response, depending on the page size in the ListJobsRequest.\nHowever, if the project does not have any jobs, an instance of\nListJobsResponse is not returned and the requests's response\nbody is empty {}.",
|
||||
"id": "ListJobsResponse",
|
||||
"properties": {
|
||||
"failedLocation": {
|
||||
@@ -3755,6 +3894,33 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MemInfo": {
|
||||
"description": "Information about the memory usage of a worker or a container within a\nworker.",
|
||||
"id": "MemInfo",
|
||||
"properties": {
|
||||
"currentLimitBytes": {
|
||||
"description": "Instantenous memory limit in bytes.",
|
||||
"format": "uint64",
|
||||
"type": "string"
|
||||
},
|
||||
"currentRssBytes": {
|
||||
"description": "Instantenous memory (RSS) size in bytes.",
|
||||
"format": "uint64",
|
||||
"type": "string"
|
||||
},
|
||||
"timestamp": {
|
||||
"description": "Timestamp of the measurement.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"totalGbMs": {
|
||||
"description": "Total memory (RSS) usage since start up in GB * ms.",
|
||||
"format": "uint64",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"MetricShortId": {
|
||||
"description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest",
|
||||
"id": "MetricShortId",
|
||||
@@ -4041,6 +4207,34 @@
|
||||
"description": "Required. The name of the parameter.",
|
||||
"type": "string"
|
||||
},
|
||||
"paramType": {
|
||||
"description": "Optional. The type of the parameter.\nUsed for selecting input picker.",
|
||||
"enum": [
|
||||
"DEFAULT",
|
||||
"TEXT",
|
||||
"GCS_READ_BUCKET",
|
||||
"GCS_WRITE_BUCKET",
|
||||
"GCS_READ_FILE",
|
||||
"GCS_WRITE_FILE",
|
||||
"GCS_READ_FOLDER",
|
||||
"GCS_WRITE_FOLDER",
|
||||
"PUBSUB_TOPIC",
|
||||
"PUBSUB_SUBSCRIPTION"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default input type.",
|
||||
"The parameter specifies generic text input.",
|
||||
"The parameter specifies a GCS Bucket to read from.",
|
||||
"The parameter specifies a GCS Bucket to write to.",
|
||||
"The parameter specifies a GCS file path to read from.",
|
||||
"The parameter specifies a GCS file path to write to.",
|
||||
"The parameter specifies a GCS folder path to read from.",
|
||||
"The parameter specifies a GCS folder to write to.",
|
||||
"The parameter specifies a Pub/Sub Topic.",
|
||||
"The parameter specifies a Pub/Sub Subscription."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"regexes": {
|
||||
"description": "Optional. Regexes that the parameter must match.",
|
||||
"items": {
|
||||
@@ -4204,6 +4398,26 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"PubsubSnapshotMetadata": {
|
||||
"description": "Represents a Pubsub snapshot.",
|
||||
"id": "PubsubSnapshotMetadata",
|
||||
"properties": {
|
||||
"expireTime": {
|
||||
"description": "The expire time of the Pubsub snapshot.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"snapshotName": {
|
||||
"description": "The name of the Pubsub snapshot.",
|
||||
"type": "string"
|
||||
},
|
||||
"topicName": {
|
||||
"description": "The name of the Pubsub topic.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ReadInstruction": {
|
||||
"description": "An instruction that reads records.\nTakes no inputs, produces one output.",
|
||||
"id": "ReadInstruction",
|
||||
@@ -4292,12 +4506,26 @@
|
||||
"description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more information, see\ngo/df-resource-signals.",
|
||||
"id": "ResourceUtilizationReport",
|
||||
"properties": {
|
||||
"containers": {
|
||||
"additionalProperties": {
|
||||
"$ref": "ResourceUtilizationReport"
|
||||
},
|
||||
"description": "Per container information.\nKey: container name.",
|
||||
"type": "object"
|
||||
},
|
||||
"cpuTime": {
|
||||
"description": "CPU utilization samples.",
|
||||
"items": {
|
||||
"$ref": "CPUTime"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"memoryInfo": {
|
||||
"description": "Memory utilization samples.",
|
||||
"items": {
|
||||
"$ref": "MemInfo"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -4330,6 +4558,20 @@
|
||||
"description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"ipConfiguration": {
|
||||
"description": "Configuration for VM IPs.",
|
||||
"enum": [
|
||||
"WORKER_IP_UNSPECIFIED",
|
||||
"WORKER_IP_PUBLIC",
|
||||
"WORKER_IP_PRIVATE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The configuration is unknown, or unspecified.",
|
||||
"Workers should have public IP addresses.",
|
||||
"Workers should have private IP addresses."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"kmsKeyName": {
|
||||
"description": "Optional. Name for the Cloud KMS key for the job.\nKey format is:\nprojects/<project>/locations/<location>/keyRings/<keyring>/cryptoKeys/<key>",
|
||||
"type": "string"
|
||||
@@ -4364,9 +4606,75 @@
|
||||
"description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.",
|
||||
"type": "string"
|
||||
},
|
||||
"zone": {
|
||||
"description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.",
|
||||
"workerRegion": {
|
||||
"description": "The Compute Engine region\n(https://cloud.google.com/compute/docs/regions-zones/regions-zones) in\nwhich worker processing should occur, e.g. \"us-west1\". Mutually exclusive\nwith worker_zone. If neither worker_region nor worker_zone is specified,\ndefault to the control plane's region.",
|
||||
"type": "string"
|
||||
},
|
||||
"workerZone": {
|
||||
"description": "The Compute Engine zone\n(https://cloud.google.com/compute/docs/regions-zones/regions-zones) in\nwhich worker processing should occur, e.g. \"us-west1-a\". Mutually exclusive\nwith worker_region. If neither worker_region nor worker_zone is specified,\na zone in the control plane's region is chosen based on available capacity.\nIf both `worker_zone` and `zone` are set, `worker_zone` takes precedence.",
|
||||
"type": "string"
|
||||
},
|
||||
"zone": {
|
||||
"description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.\nIn the future, worker_zone will take precedence.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"RuntimeMetadata": {
|
||||
"description": "RuntimeMetadata describing a runtime environment.",
|
||||
"id": "RuntimeMetadata",
|
||||
"properties": {
|
||||
"parameters": {
|
||||
"description": "The parameters for the template.",
|
||||
"items": {
|
||||
"$ref": "ParameterMetadata"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"sdkInfo": {
|
||||
"$ref": "SDKInfo",
|
||||
"description": "SDK Info for the template."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SDKInfo": {
|
||||
"description": "SDK Information.",
|
||||
"id": "SDKInfo",
|
||||
"properties": {
|
||||
"language": {
|
||||
"description": "Required. The SDK Language.",
|
||||
"enum": [
|
||||
"UNKNOWN",
|
||||
"JAVA",
|
||||
"PYTHON"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"UNKNOWN Language.",
|
||||
"Java.",
|
||||
"Python."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Optional. The SDK version.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SdkHarnessContainerImage": {
|
||||
"description": "Defines a SDK harness container for executing Dataflow pipelines.",
|
||||
"id": "SdkHarnessContainerImage",
|
||||
"properties": {
|
||||
"containerImage": {
|
||||
"description": "A docker container image that resides in Google Container Registry.",
|
||||
"type": "string"
|
||||
},
|
||||
"useSingleCorePerContainer": {
|
||||
"description": "If true, recommends the Dataflow service to use only one core per SDK\ncontainer instance with this image. If false (or unset) recommends using\nmore than one core per SDK container instance with this image for\nefficiency. Note that Dataflow service may choose to override this property\nif needed.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -4595,6 +4903,15 @@
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"description": "User specified description of the snapshot. Maybe empty.",
|
||||
"type": "string"
|
||||
},
|
||||
"diskSizeBytes": {
|
||||
"description": "The disk byte size of the snapshot. Only available for snapshots in READY\nstate.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"description": "The unique ID of this snapshot.",
|
||||
"type": "string"
|
||||
@@ -4603,6 +4920,13 @@
|
||||
"description": "The project this snapshot belongs to.",
|
||||
"type": "string"
|
||||
},
|
||||
"pubsubMetadata": {
|
||||
"description": "PubSub snapshot metadata.",
|
||||
"items": {
|
||||
"$ref": "PubsubSnapshotMetadata"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"sourceJobId": {
|
||||
"description": "The job this snapshot was created from.",
|
||||
"type": "string"
|
||||
@@ -4639,10 +4963,18 @@
|
||||
"description": "Request to create a snapshot of a job.",
|
||||
"id": "SnapshotJobRequest",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "User specified description of the snapshot. Maybe empty.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "The location that contains this job.",
|
||||
"type": "string"
|
||||
},
|
||||
"snapshotSources": {
|
||||
"description": "If true, perform snapshots for sources which support this.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"ttl": {
|
||||
"description": "TTL for the snapshot.",
|
||||
"format": "google-duration",
|
||||
@@ -5151,6 +5483,16 @@
|
||||
"description": "A task that carries configuration information for streaming computations.",
|
||||
"id": "StreamingConfigTask",
|
||||
"properties": {
|
||||
"commitStreamChunkSizeBytes": {
|
||||
"description": "Chunk size for commit streams from the harness to windmill.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"getDataStreamChunkSizeBytes": {
|
||||
"description": "Chunk size for get data streams from the harness to windmill.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"maxWorkItemCommitBytes": {
|
||||
"description": "Maximum size for work item commit supported windmill storage layer.",
|
||||
"format": "int64",
|
||||
@@ -5972,6 +6314,13 @@
|
||||
"description": "Extra arguments for this worker pool.",
|
||||
"type": "object"
|
||||
},
|
||||
"sdkHarnessContainerImages": {
|
||||
"description": "Set of SDK harness containers needed to execute this pipeline. This will\nonly be set in the Fn API path. For non-cross-language pipelines this\nshould have only one entry. Cross-language pipelines will have two or more\nentries.",
|
||||
"items": {
|
||||
"$ref": "SdkHarnessContainerImage"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"subnetwork": {
|
||||
"description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\".",
|
||||
"type": "string"
|
||||
@@ -5997,7 +6346,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"workerHarnessContainerImage": {
|
||||
"description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
|
||||
"description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.\n\nDeprecated for the Fn API path. Use sdk_harness_container_images instead.",
|
||||
"type": "string"
|
||||
},
|
||||
"zone": {
|
||||
|
||||
@@ -22,6 +22,7 @@
|
||||
},
|
||||
"id": "datafusion:v1beta1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://datafusion.mtls.googleapis.com/",
|
||||
"name": "datafusion",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -147,6 +148,11 @@
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"includeUnrevealedLocations": {
|
||||
"description": "If true, the returned list will include locations which are not yet\nrevealed.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"name": {
|
||||
"description": "The resource that owns the locations collection, if applicable.",
|
||||
"location": "path",
|
||||
@@ -270,6 +276,12 @@
|
||||
"resource"
|
||||
],
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"resource": {
|
||||
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
|
||||
"location": "path",
|
||||
@@ -395,7 +407,7 @@
|
||||
]
|
||||
},
|
||||
"setIamPolicy": {
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
|
||||
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.\n\nCan return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy",
|
||||
"httpMethod": "POST",
|
||||
"id": "datafusion.projects.locations.instances.setIamPolicy",
|
||||
@@ -608,11 +620,32 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190617",
|
||||
"revision": "20200318",
|
||||
"rootUrl": "https://datafusion.googleapis.com/",
|
||||
"schemas": {
|
||||
"Accelerator": {
|
||||
"description": "Identifies Data Fusion accelerators for an instance.",
|
||||
"id": "Accelerator",
|
||||
"properties": {
|
||||
"acceleratorType": {
|
||||
"description": "The type of an accelator for a CDF instance.",
|
||||
"enum": [
|
||||
"ACCELERATOR_TYPE_UNSPECIFIED",
|
||||
"CDC",
|
||||
"HEALTHCARE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default value, if unspecified.",
|
||||
"Change Data Capture accelerator for CDF.",
|
||||
"Cloud Healthcare accelerator for CDF. This accelerator is to enable Cloud\nHealthcare specific CDF plugins developed by Healthcare team."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AuditConfig": {
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
|
||||
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"sampleservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:aliya@example.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts jose@example.com from DATA_READ logging, and\naliya@example.com from DATA_WRITE logging.",
|
||||
"id": "AuditConfig",
|
||||
"properties": {
|
||||
"auditLogConfigs": {
|
||||
@@ -622,12 +655,6 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"exemptedMembers": {
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"service": {
|
||||
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
|
||||
"type": "string"
|
||||
@@ -636,7 +663,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"AuditLogConfig": {
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
|
||||
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:jose@example.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
|
||||
"id": "AuditLogConfig",
|
||||
"properties": {
|
||||
"exemptedMembers": {
|
||||
@@ -665,31 +692,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AuthorizationLoggingOptions": {
|
||||
"description": "Authorization-related information used by Cloud Audit Logging.",
|
||||
"id": "AuthorizationLoggingOptions",
|
||||
"properties": {
|
||||
"permissionType": {
|
||||
"description": "The type of the permission that was checked.",
|
||||
"enum": [
|
||||
"PERMISSION_TYPE_UNSPECIFIED",
|
||||
"ADMIN_READ",
|
||||
"ADMIN_WRITE",
|
||||
"DATA_READ",
|
||||
"DATA_WRITE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default. Should not be used.",
|
||||
"A read of admin (meta) data.",
|
||||
"A write of admin (meta) data.",
|
||||
"A read of standard data.",
|
||||
"A write of standard data."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Binding": {
|
||||
"description": "Associates `members` with a `role`.",
|
||||
"id": "Binding",
|
||||
@@ -699,7 +701,7 @@
|
||||
"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."
|
||||
},
|
||||
"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@gmail.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\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",
|
||||
"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",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -718,143 +720,6 @@
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"CloudAuditOptions": {
|
||||
"description": "Write a Cloud Audit log",
|
||||
"id": "CloudAuditOptions",
|
||||
"properties": {
|
||||
"authorizationLoggingOptions": {
|
||||
"$ref": "AuthorizationLoggingOptions",
|
||||
"description": "Information used by the Cloud Audit Logging pipeline."
|
||||
},
|
||||
"logName": {
|
||||
"description": "The log_name to populate in the Cloud Audit Record.",
|
||||
"enum": [
|
||||
"UNSPECIFIED_LOG_NAME",
|
||||
"ADMIN_ACTIVITY",
|
||||
"DATA_ACCESS"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default. Should not be used.",
|
||||
"Corresponds to \"cloudaudit.googleapis.com/activity\"",
|
||||
"Corresponds to \"cloudaudit.googleapis.com/data_access\""
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Condition": {
|
||||
"description": "A condition to be met.",
|
||||
"id": "Condition",
|
||||
"properties": {
|
||||
"iam": {
|
||||
"description": "Trusted attributes supplied by the IAM system.",
|
||||
"enum": [
|
||||
"NO_ATTR",
|
||||
"AUTHORITY",
|
||||
"ATTRIBUTION",
|
||||
"SECURITY_REALM",
|
||||
"APPROVER",
|
||||
"JUSTIFICATION_TYPE",
|
||||
"CREDENTIALS_TYPE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default non-attribute.",
|
||||
"Either principal or (if present) authority selector.",
|
||||
"The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
|
||||
"Any of the security realms in the IAMContext (go/security-realms).\nWhen used with IN, the condition indicates \"any of the request's realms\nmatch one of the given values; with NOT_IN, \"none of the realms match\nany of the given values\". Note that a value can be:\n - 'self' (i.e., allow connections from clients that are in the same\n security realm)\n - a realm (e.g., 'campus-abc')\n - a realm group (e.g., 'realms-for-borg-cell-xx', see: go/realm-groups)\nA match is determined by a realm group\nmembership check performed by a RealmAclRep object (go/realm-acl-howto).\nIt is not permitted to grant access based on the *absence* of a realm, so\nrealm conditions can only be used in a \"positive\" context (e.g., ALLOW/IN\nor DENY/NOT_IN).",
|
||||
"An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).",
|
||||
"What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported.",
|
||||
"What type of credentials have been supplied with this request.\nString values should match enum names from\nsecurity_loas_l2.CredentialsType - currently, only CREDS_TYPE_EMERGENCY\nis supported.\nIt is not permitted to grant access based on the *absence* of a\ncredentials type, so the conditions can only be used in a \"positive\"\ncontext (e.g., ALLOW/IN or DENY/NOT_IN)."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"op": {
|
||||
"description": "An operator to apply the subject with.",
|
||||
"enum": [
|
||||
"NO_OP",
|
||||
"EQUALS",
|
||||
"NOT_EQUALS",
|
||||
"IN",
|
||||
"NOT_IN",
|
||||
"DISCHARGED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default no-op.",
|
||||
"DEPRECATED. Use IN instead.",
|
||||
"DEPRECATED. Use NOT_IN instead.",
|
||||
"The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
|
||||
"The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
|
||||
"Subject is discharged"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"svc": {
|
||||
"description": "Trusted attributes discharged by the service.",
|
||||
"type": "string"
|
||||
},
|
||||
"sys": {
|
||||
"description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
|
||||
"enum": [
|
||||
"NO_ATTR",
|
||||
"REGION",
|
||||
"SERVICE",
|
||||
"NAME",
|
||||
"IP"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default non-attribute type",
|
||||
"Region of the resource",
|
||||
"Service name",
|
||||
"Resource name",
|
||||
"IP address of the caller"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"values": {
|
||||
"description": "The objects of the condition.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"CounterOptions": {
|
||||
"description": "Increment a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nSupported field names:\n - \"authority\", which is \"[token]\" if IAMContext.token is present,\n otherwise the value of IAMContext.authority_selector if present, and\n otherwise a representation of IAMContext.principal; or\n - \"iam_principal\", a representation of IAMContext.principal even if a\n token or authority selector is present; or\n - \"\" (empty string), resulting in a counter with no fields.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support multiple field names (though this may be\nsupported in the future).",
|
||||
"id": "CounterOptions",
|
||||
"properties": {
|
||||
"field": {
|
||||
"description": "The field value to attribute.",
|
||||
"type": "string"
|
||||
},
|
||||
"metric": {
|
||||
"description": "The metric to update.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"DataAccessOptions": {
|
||||
"description": "Write a Data Access (Gin) log",
|
||||
"id": "DataAccessOptions",
|
||||
"properties": {
|
||||
"logMode": {
|
||||
"description": "Whether Gin logging should happen in a fail-closed manner at the caller.\nThis is relevant only in the LocalIAM implementation, for now.",
|
||||
"enum": [
|
||||
"LOG_MODE_UNSPECIFIED",
|
||||
"LOG_FAIL_CLOSED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Client is not required to write a partial Gin log immediately after\nthe authorization check. If client chooses to write one and it fails,\nclient may either fail open (allow the operation to continue) or\nfail closed (handle as a DENY outcome).",
|
||||
"The application's operation in the context of which this authorization\ncheck is being made may only be performed if it is successfully logged\nto Gin. For instance, the authorization library may satisfy this\nobligation by emitting a partial log entry at authorization check time\nand only returning ALLOW to the application if it succeeds.\n\nIf a matching Rule has this directive, but the client has not indicated\nthat it will honor such requirements, then the IAM check will result in\nauthorization failure by setting CheckPolicyResponse.success=false."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"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",
|
||||
@@ -862,39 +727,57 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Expr": {
|
||||
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) > 0\"",
|
||||
"description": "Represents a textual expression in the Common Expression Language (CEL)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n title: \"Summary size limit\"\n description: \"Determines if a summary is less than 100 chars\"\n expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n title: \"Requestor is owner\"\n description: \"Determines if requestor is the document owner\"\n expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n title: \"Public documents\"\n description: \"Determine whether the document should be publicly visible\"\n expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n title: \"Notification string\"\n description: \"Create a notification string with a timestamp.\"\n expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
|
||||
"id": "Expr",
|
||||
"properties": {
|
||||
"description": {
|
||||
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
|
||||
"type": "string"
|
||||
},
|
||||
"expression": {
|
||||
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
|
||||
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
|
||||
"type": "string"
|
||||
},
|
||||
"location": {
|
||||
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"description": "Optional. String indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"description": "Optional. Title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Instance": {
|
||||
"description": "Represents a Data Fusion instance.",
|
||||
"description": "Represents a Data Fusion instance.\nNext available ID: 23",
|
||||
"id": "Instance",
|
||||
"properties": {
|
||||
"accelerators": {
|
||||
"description": "List of accelerators enabled for this CDF instance.",
|
||||
"items": {
|
||||
"$ref": "Accelerator"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"apiEndpoint": {
|
||||
"description": "Output only. Endpoint on which the REST APIs is accessible.",
|
||||
"type": "string"
|
||||
},
|
||||
"availableVersion": {
|
||||
"description": "Available versions that the instance can be upgraded to using\nUpdateInstanceRequest.",
|
||||
"items": {
|
||||
"$ref": "Version"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"createTime": {
|
||||
"description": "Output only. The time the instance was created.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"description": "An optional description of this instance.",
|
||||
"description": "Optional. An optional description of this instance.",
|
||||
"type": "string"
|
||||
},
|
||||
"displayName": {
|
||||
@@ -909,11 +792,15 @@
|
||||
"description": "Option to enable Stackdriver Monitoring.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"gcsBucket": {
|
||||
"description": "Output only. Cloud Storage bucket generated by Data Fusion in the customer project.",
|
||||
"type": "string"
|
||||
},
|
||||
"labels": {
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "The resource labels for instance to use to annotate any related underlying\nresources such as GCE VMs. The character '=' is not allowed to be used\nwithin the labels.",
|
||||
"description": "The resource labels for instance to use to annotate any related underlying\nresources such as Compute Engine VMs. The character '=' is not allowed to\nbe used within the labels.",
|
||||
"type": "object"
|
||||
},
|
||||
"name": {
|
||||
@@ -940,7 +827,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"serviceEndpoint": {
|
||||
"description": "Output only. Endpoint on which the Data Fusion UI and REST APIs are\naccessible.",
|
||||
"description": "Output only. Endpoint on which the Data Fusion UI is accessible.",
|
||||
"type": "string"
|
||||
},
|
||||
"state": {
|
||||
@@ -953,7 +840,9 @@
|
||||
"DELETING",
|
||||
"UPGRADING",
|
||||
"RESTARTING",
|
||||
"UPDATING"
|
||||
"UPDATING",
|
||||
"AUTO_UPDATING",
|
||||
"AUTO_UPGRADING"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Instance does not have a state yet",
|
||||
@@ -963,7 +852,9 @@
|
||||
"Instance is being deleted",
|
||||
"Instance is being upgraded",
|
||||
"Instance is being restarted",
|
||||
"Instance is being updated"
|
||||
"Instance is being updated on customer request",
|
||||
"Instance is being auto-updated",
|
||||
"Instance is being auto-upgraded"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -976,12 +867,14 @@
|
||||
"enum": [
|
||||
"TYPE_UNSPECIFIED",
|
||||
"BASIC",
|
||||
"ENTERPRISE"
|
||||
"ENTERPRISE",
|
||||
"DEVELOPER"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"No type specified. The instance creation will fail.",
|
||||
"Basic Data Fusion instance. In Basic type, the user will be able to\ncreate data pipelines using point and click UI. However, there are\ncertain limitations, such as fewer number of concurrent pipelines, no\nsupport for streaming pipelines, etc.",
|
||||
"Enterprise Data Fusion instance. In Enterprise type, the user will have\nmore features available, such as support for streaming pipelines, higher\nnumber of concurrent pipelines, etc."
|
||||
"Enterprise Data Fusion instance. In Enterprise type, the user will have\nall features available, such as support for streaming pipelines, higher\nnumber of concurrent pipelines, etc.",
|
||||
"Developer Data Fusion instance. In Developer type, the user will have all\nfeatures available but with restrictive capabilities. This is to help\nenterprises design and develop their data ingestion and integration\npipelines at low cost."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -991,7 +884,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"version": {
|
||||
"description": "Output only. Current version of the Data Fusion.",
|
||||
"description": "Current version of Data Fusion.",
|
||||
"type": "string"
|
||||
},
|
||||
"zone": {
|
||||
@@ -1096,25 +989,6 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"LogConfig": {
|
||||
"description": "Specifies what kind of log the caller must write",
|
||||
"id": "LogConfig",
|
||||
"properties": {
|
||||
"cloudAudit": {
|
||||
"$ref": "CloudAuditOptions",
|
||||
"description": "Cloud audit options."
|
||||
},
|
||||
"counter": {
|
||||
"$ref": "CounterOptions",
|
||||
"description": "Counter options."
|
||||
},
|
||||
"dataAccess": {
|
||||
"$ref": "DataAccessOptions",
|
||||
"description": "Data access options."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"NetworkConfig": {
|
||||
"description": "Network configuration for a Data Fusion instance. These configurations\nare used for peering with the customer network. Configurations are optional\nwhen a public Data Fusion instance is to be created. However, providing\nthese configurations allows several benefits, such as reduced network latency\nwhile accessing the customer resources from managed Data Fusion instance\nnodes, as well as access to the customer on-prem resources.",
|
||||
"id": "NetworkConfig",
|
||||
@@ -1124,7 +998,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"network": {
|
||||
"description": "Name of the network in the customer project with which the Tenant Project\nwill be peered for executing pipelines.",
|
||||
"description": "Name of the network in the customer project with which the Tenant Project\nwill be peered for executing pipelines. In case of shared VPC where the\nnetwork resides in another host project the network should specified in\nthe form of projects/{host-project-id}/global/networks/{network}",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1203,7 +1077,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Policy": {
|
||||
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\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-other-app@appspot.gserviceaccount.com\n role: roles/owner\n - members:\n - user:sean@example.com\n role: roles/viewer\n\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](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\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/).",
|
||||
"id": "Policy",
|
||||
"properties": {
|
||||
"auditConfigs": {
|
||||
@@ -1214,29 +1088,19 @@
|
||||
"type": "array"
|
||||
},
|
||||
"bindings": {
|
||||
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
|
||||
"description": "Associates a list of `members` to a `role`. Optionally, may specify a\n`condition` that determines how and when the `bindings` are applied. Each\nof the `bindings` must contain at least one member.",
|
||||
"items": {
|
||||
"$ref": "Binding"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"etag": {
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
|
||||
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\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.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
},
|
||||
"iamOwned": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"rules": {
|
||||
"description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
|
||||
"items": {
|
||||
"$ref": "Rule"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"version": {
|
||||
"description": "Deprecated.",
|
||||
"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.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
@@ -1249,72 +1113,6 @@
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"Rule": {
|
||||
"description": "A rule to be applied in a Policy.",
|
||||
"id": "Rule",
|
||||
"properties": {
|
||||
"action": {
|
||||
"description": "Required",
|
||||
"enum": [
|
||||
"NO_ACTION",
|
||||
"ALLOW",
|
||||
"ALLOW_WITH_LOG",
|
||||
"DENY",
|
||||
"DENY_WITH_LOG",
|
||||
"LOG"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Default no action.",
|
||||
"Matching 'Entries' grant access.",
|
||||
"Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
|
||||
"Matching 'Entries' deny access.",
|
||||
"Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
|
||||
"Matching 'Entries' tell IAM.Check callers to generate logs."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"conditions": {
|
||||
"description": "Additional restrictions that must be met. All conditions must pass for the\nrule to match.",
|
||||
"items": {
|
||||
"$ref": "Condition"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"description": {
|
||||
"description": "Human-readable description of the rule.",
|
||||
"type": "string"
|
||||
},
|
||||
"in": {
|
||||
"description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"logConfig": {
|
||||
"description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
|
||||
"items": {
|
||||
"$ref": "LogConfig"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"notIn": {
|
||||
"description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries can be found at in the Local IAM\ndocumentation (see go/local-iam#features).",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"permissions": {
|
||||
"description": "A permission is a string of form '<service>.<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"SetIamPolicyRequest": {
|
||||
"description": "Request message for `SetIamPolicy` method.",
|
||||
"id": "SetIamPolicyRequest",
|
||||
@@ -1391,6 +1189,17 @@
|
||||
"id": "UpgradeInstanceRequest",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
},
|
||||
"Version": {
|
||||
"description": "The Data Fusion version.",
|
||||
"id": "Version",
|
||||
"properties": {
|
||||
"versionNumber": {
|
||||
"description": "The version number of the Data Fusion instance, such as '6.0.1.0'.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"servicePath": "",
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -23,6 +23,7 @@
|
||||
},
|
||||
"id": "datastore:v1",
|
||||
"kind": "discovery#restDescription",
|
||||
"mtlsRootUrl": "https://datastore.mtls.googleapis.com/",
|
||||
"name": "datastore",
|
||||
"ownerDomain": "google.com",
|
||||
"ownerName": "Google",
|
||||
@@ -117,7 +118,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "The ID of the project against which to make the request.",
|
||||
"description": "Required. The ID of the project against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -145,7 +146,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "The ID of the project against which to make the request.",
|
||||
"description": "Required. The ID of the project against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -173,7 +174,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "The ID of the project against which to make the request.",
|
||||
"description": "Required. The ID of the project against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -201,7 +202,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "Project ID against which to make the request.",
|
||||
"description": "Required. Project ID against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -229,7 +230,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "Project ID against which to make the request.",
|
||||
"description": "Required. Project ID against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -257,7 +258,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "The ID of the project against which to make the request.",
|
||||
"description": "Required. The ID of the project against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -285,7 +286,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "The ID of the project against which to make the request.",
|
||||
"description": "Required. The ID of the project against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -313,7 +314,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "The ID of the project against which to make the request.",
|
||||
"description": "Required. The ID of the project against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -341,7 +342,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "The ID of the project against which to make the request.",
|
||||
"description": "Required. The ID of the project against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -363,6 +364,66 @@
|
||||
"resources": {
|
||||
"indexes": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Creates the specified index.\nA newly created index's initial state is `CREATING`. On completion of the\nreturned google.longrunning.Operation, the state will be `READY`.\nIf the index already exists, the call will return an `ALREADY_EXISTS`\nstatus.\n\nDuring index creation, the process could result in an error, in which\ncase the index will move to the `ERROR` state. The process can be recovered\nby fixing the data that caused the error, removing the index with\ndelete, then\nre-creating the index with create.\n\nIndexes with a single property cannot be created.",
|
||||
"flatPath": "v1/projects/{projectId}/indexes",
|
||||
"httpMethod": "POST",
|
||||
"id": "datastore.projects.indexes.create",
|
||||
"parameterOrder": [
|
||||
"projectId"
|
||||
],
|
||||
"parameters": {
|
||||
"projectId": {
|
||||
"description": "Project ID against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/projects/{projectId}/indexes",
|
||||
"request": {
|
||||
"$ref": "GoogleDatastoreAdminV1Index"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "GoogleLongrunningOperation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/datastore"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes an existing index.\nAn index can only be deleted if it is in a `READY` or `ERROR` state. On\nsuccessful execution of the request, the index will be in a `DELETING`\nstate. And on completion of the\nreturned google.longrunning.Operation, the index will be removed.\n\nDuring index deletion, the process could result in an error, in which\ncase the index will move to the `ERROR` state. The process can be recovered\nby fixing the data that caused the error, followed by calling\ndelete again.",
|
||||
"flatPath": "v1/projects/{projectId}/indexes/{indexId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "datastore.projects.indexes.delete",
|
||||
"parameterOrder": [
|
||||
"projectId",
|
||||
"indexId"
|
||||
],
|
||||
"parameters": {
|
||||
"indexId": {
|
||||
"description": "The resource ID of the index to delete.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "Project ID against which to make the request.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/projects/{projectId}/indexes/{indexId}",
|
||||
"response": {
|
||||
"$ref": "GoogleLongrunningOperation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/datastore"
|
||||
]
|
||||
},
|
||||
"get": {
|
||||
"description": "Gets an index.",
|
||||
"flatPath": "v1/projects/{projectId}/indexes/{indexId}",
|
||||
@@ -564,7 +625,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20190421",
|
||||
"revision": "20200311",
|
||||
"rootUrl": "https://datastore.googleapis.com/",
|
||||
"schemas": {
|
||||
"AllocateIdsRequest": {
|
||||
@@ -572,7 +633,7 @@
|
||||
"id": "AllocateIdsRequest",
|
||||
"properties": {
|
||||
"keys": {
|
||||
"description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
|
||||
"description": "Required. A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
|
||||
"items": {
|
||||
"$ref": "Key"
|
||||
},
|
||||
@@ -900,7 +961,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"outputUrlPrefix": {
|
||||
"description": "Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url field. That\nvalue should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.",
|
||||
"description": "Required. Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url field. That\nvalue should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -953,7 +1014,7 @@
|
||||
"description": "Optionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported."
|
||||
},
|
||||
"inputUrl": {
|
||||
"description": "The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url.",
|
||||
"description": "Required. The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url.",
|
||||
"type": "string"
|
||||
},
|
||||
"labels": {
|
||||
@@ -971,7 +1032,7 @@
|
||||
"id": "GoogleDatastoreAdminV1Index",
|
||||
"properties": {
|
||||
"ancestor": {
|
||||
"description": "The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.\nRequired.",
|
||||
"description": "Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.",
|
||||
"enum": [
|
||||
"ANCESTOR_MODE_UNSPECIFIED",
|
||||
"NONE",
|
||||
@@ -985,26 +1046,26 @@
|
||||
"type": "string"
|
||||
},
|
||||
"indexId": {
|
||||
"description": "The resource ID of the index.\nOutput only.",
|
||||
"description": "Output only. The resource ID of the index.",
|
||||
"type": "string"
|
||||
},
|
||||
"kind": {
|
||||
"description": "The entity kind to which this index applies.\nRequired.",
|
||||
"description": "Required. The entity kind to which this index applies.",
|
||||
"type": "string"
|
||||
},
|
||||
"projectId": {
|
||||
"description": "Project ID.\nOutput only.",
|
||||
"description": "Output only. Project ID.",
|
||||
"type": "string"
|
||||
},
|
||||
"properties": {
|
||||
"description": "An ordered sequence of property names and their index attributes.\nRequired.",
|
||||
"description": "Required. An ordered sequence of property names and their index attributes.",
|
||||
"items": {
|
||||
"$ref": "GoogleDatastoreAdminV1IndexedProperty"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"state": {
|
||||
"description": "The state of the index.\nOutput only.",
|
||||
"description": "Output only. The state of the index.",
|
||||
"enum": [
|
||||
"STATE_UNSPECIFIED",
|
||||
"CREATING",
|
||||
@@ -1048,7 +1109,7 @@
|
||||
"id": "GoogleDatastoreAdminV1IndexedProperty",
|
||||
"properties": {
|
||||
"direction": {
|
||||
"description": "The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.\nRequired.",
|
||||
"description": "Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.",
|
||||
"enum": [
|
||||
"DIRECTION_UNSPECIFIED",
|
||||
"ASCENDING",
|
||||
@@ -1062,7 +1123,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"description": "The property name to index.\nRequired.",
|
||||
"description": "Required. The property name to index.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1307,7 +1368,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"name": {
|
||||
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
|
||||
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.",
|
||||
"type": "string"
|
||||
},
|
||||
"response": {
|
||||
@@ -1417,7 +1478,7 @@
|
||||
"id": "LookupRequest",
|
||||
"properties": {
|
||||
"keys": {
|
||||
"description": "Keys of entities to look up.",
|
||||
"description": "Required. Keys of entities to look up.",
|
||||
"items": {
|
||||
"$ref": "Key"
|
||||
},
|
||||
@@ -1805,7 +1866,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"keys": {
|
||||
"description": "A list of keys with complete key paths whose numeric IDs should not be\nauto-allocated.",
|
||||
"description": "Required. A list of keys with complete key paths whose numeric IDs should not be\nauto-allocated.",
|
||||
"items": {
|
||||
"$ref": "Key"
|
||||
},
|
||||
@@ -1825,7 +1886,7 @@
|
||||
"id": "RollbackRequest",
|
||||
"properties": {
|
||||
"transaction": {
|
||||
"description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
|
||||
"description": "Required. The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
}
|
||||
@@ -1877,7 +1938,7 @@
|
||||
"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). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error\nmessage, and error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
|
||||
"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",
|
||||
"properties": {
|
||||
"code": {
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user