OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Bump version to 1.0.9; update JSON schemas; add new APIs

Browse Source
This commit is contained in:
Sebastian Thiel
2019-07-05 11:32:35 +08:00
parent 99e97ceece
commit e42ebc0c2b
2442 changed files with 190984 additions and 71186 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -1,4 +1,5 @@
.DS_Store
/.vscode/
.timestamp
gen/doc
*.go

2
etc/api/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
View File

@@ -153,7 +153,7 @@
}
}
},
"revision": "20190401",
"revision": "20190624",
"rootUrl": "https://abusiveexperiencereport.googleapis.com/",
"schemas": {
"SiteSummaryResponse": {

2
etc/api/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
View File

@@ -113,7 +113,7 @@
}
}
},
"revision": "20190330",
"revision": "20190619",
"rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"schemas": {
"AmpUrl": {

851
etc/api/accessapproval/v1beta1/accessapproval-api.json Normal file
View File

@@ -0,0 +1,851 @@
{
"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:v1beta1",
"kind": "discovery#restDescription",
"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": {
"getAccessApprovalSettings": {
"description": "Gets the settings associated with a project, folder, or organization.",
"flatPath": "v1beta1/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": "v1beta1/{+name}",
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateAccessApprovalSettings": {
"description": "Updates the settings associated with a project, folder, or organization.\nCompletely replaces the existing settings.",
"flatPath": "v1beta1/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"
}
},
"path": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+parent}/approvalRequests",
"response": {
"$ref": "ListApprovalRequestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"organizations": {
"methods": {
"getAccessApprovalSettings": {
"description": "Gets the settings associated with a project, folder, or organization.",
"flatPath": "v1beta1/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": "v1beta1/{+name}",
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateAccessApprovalSettings": {
"description": "Updates the settings associated with a project, folder, or organization.\nCompletely replaces the existing settings.",
"flatPath": "v1beta1/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"
}
},
"path": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+parent}/approvalRequests",
"response": {
"$ref": "ListApprovalRequestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"projects": {
"methods": {
"getAccessApprovalSettings": {
"description": "Gets the settings associated with a project, folder, or organization.",
"flatPath": "v1beta1/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": "v1beta1/{+name}",
"response": {
"$ref": "AccessApprovalSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"updateAccessApprovalSettings": {
"description": "Updates the settings associated with a project, folder, or organization.\nCompletely replaces the existing settings.",
"flatPath": "v1beta1/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"
}
},
"path": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+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": "v1beta1/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": "v1beta1/{+parent}/approvalRequests",
"response": {
"$ref": "ListApprovalRequestsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
},
"revision": "20190628",
"rootUrl": "https://accessapproval.googleapis.com/",
"schemas": {
"AccessApprovalSettings": {
"description": "Settings on a Project/Folder/Organization related to Access Approval.",
"id": "AccessApprovalSettings",
"properties": {
"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.",
"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"
},
"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": "v1beta1",
"version_module": true
}

6
etc/api/accesscontextmanager/v1/accesscontextmanager-api.json
View File

@@ -692,7 +692,7 @@
}
}
},
"revision": "20190327",
"revision": "20190626",
"rootUrl": "https://accesscontextmanager.googleapis.com/",
"schemas": {
"AccessLevel": {
@@ -995,7 +995,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": {
@@ -1116,7 +1116,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": {

72
etc/api/accesscontextmanager/v1beta/accesscontextmanager-api.json
View File

@@ -598,7 +598,7 @@
}
}
},
"revision": "20190327",
"revision": "20190626",
"rootUrl": "https://accesscontextmanager.googleapis.com/",
"schemas": {
"AccessLevel": {
@@ -689,6 +689,24 @@
},
"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",
@@ -796,6 +814,24 @@
},
"type": "object"
},
"IngressServiceRestriction": {
"description": "Alpha. Specifies how Access Levels are to be used for accessing the Service\nPerimeter.",
"id": "IngressServiceRestriction",
"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"
},
"enableRestriction": {
"description": "Whether to restrict the set of APIs callable outside the Service\nPerimeter via Access Levels.",
"type": "boolean"
}
},
"type": "object"
},
"ListAccessLevelsResponse": {
"description": "A response to `ListAccessLevelsRequest`.",
"id": "ListAccessLevelsResponse",
@@ -871,7 +907,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": {
@@ -974,6 +1010,14 @@
},
"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}`",
"items": {
@@ -994,12 +1038,16 @@
"type": "string"
},
"type": "array"
},
"vpcServiceRestriction": {
"$ref": "VpcServiceRestriction",
"description": "Alpha. Configuration for within Perimeter allowed APIs."
}
},
"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": {
@@ -1024,6 +1072,24 @@
}
},
"type": "object"
},
"VpcServiceRestriction": {
"description": "Alpha. Specifies how APIs are allowed to communicate within the Service\nPerimeter.",
"id": "VpcServiceRestriction",
"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": "",

4
etc/api/adexchangebuyer/v1.2/adexchangebuyer-api.json
View File

@@ -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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/NOlauHfnB89d8mftozC_WUbEAZg\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/uOrrz0XZXUWjq05UnBmp2O_KkFY\"",
"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": "20180823",
"revision": "20190614",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Account": {

23
etc/api/adexchangebuyer/v1.3/adexchangebuyer-api.json
View File

@@ -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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/p1cvbfPnG9B-3MzvMLbhZV5GJsg\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/hcIsQyAOKgIG-XNmjJJ2qekVMV8\"",
"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": "20180823",
"revision": "20190614",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Account": {
@@ -883,6 +883,21 @@
"format": "int32",
"type": "integer"
},
"adTechnologyProviders": {
"properties": {
"detectedProviderIds": {
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"hasUnidentifiedProvider": {
"type": "boolean"
}
},
"type": "object"
},
"advertiserId": {
"description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
"items": {
@@ -1118,10 +1133,6 @@
"description": "The app rating in the app store. Must be in the range [0-5].",
"format": "double",
"type": "number"
},
"store": {
"description": "The URL to the app store to purchase/download the promoted app.",
"type": "string"
}
},
"type": "object"

23
etc/api/adexchangebuyer/v1.4/adexchangebuyer-api.json
View File

@@ -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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/1COhVtbQ2cv316W1bDwpsOuHROo\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/CMOrSNVn1gPVhDl3l-t_ud1epbY\"",
"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": "20180823",
"revision": "20190614",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Account": {
@@ -1570,6 +1570,21 @@
"description": "The link to the Ad Preferences page. This is only supported for native ads.",
"type": "string"
},
"adTechnologyProviders": {
"properties": {
"detectedProviderIds": {
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"hasUnidentifiedProvider": {
"type": "boolean"
}
},
"type": "object"
},
"advertiserId": {
"description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
"items": {
@@ -1847,10 +1862,6 @@
"format": "double",
"type": "number"
},
"store": {
"description": "The URL to the app store to purchase/download the promoted app.",
"type": "string"
},
"videoURL": {
"description": "The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url.",
"type": "string"

238
etc/api/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
View File

@@ -444,7 +444,7 @@
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
"description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list\nmethod.",
"location": "query",
"type": "string"
}
@@ -1394,42 +1394,6 @@
"resources": {
"accounts": {
"resources": {
"creatives": {
"methods": {
"delete": {
"description": "Deletes a single creative.\n\nA creative is deactivated upon deletion and does not count against active\nsnippet quota. A deleted creative should not be used in bidding (all bids\nwith that creative will be rejected).",
"flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/creatives/{creativeId}",
"httpMethod": "DELETE",
"id": "adexchangebuyer2.bidders.accounts.creatives.delete",
"parameterOrder": [
"ownerName",
"creativeId"
],
"parameters": {
"creativeId": {
"description": "The ID of the creative to delete.",
"location": "path",
"required": true,
"type": "string"
},
"ownerName": {
"description": "Name of the owner (bidder or account) of the creative to be deleted.\nFor example:\n\n- For an account-level creative for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level creative for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`",
"location": "path",
"pattern": "^bidders/[^/]+/accounts/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2beta1/{+ownerName}/creatives/{creativeId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"filterSets": {
"methods": {
"create": {
@@ -2521,7 +2485,7 @@
}
}
},
"revision": "20190403",
"revision": "20190701",
"rootUrl": "https://adexchangebuyer.googleapis.com/",
"schemas": {
"AbsoluteDateRange": {
@@ -2586,6 +2550,25 @@
},
"type": "object"
},
"AdTechnologyProviders": {
"description": "Detected ad technology provider information.",
"id": "AdTechnologyProviders",
"properties": {
"detectedProviderIds": {
"description": "The detected ad technology provider IDs for this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for\nmapping of provider ID to provided name, a privacy policy URL, and a list\nof domains which can be attributed to the provider.\n\nIf the creative contains provider IDs that are outside of those listed in\nthe `BidRequest.adslot.consented_providers_settings.consented_providers`\nfield on the (Google bid\nprotocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto]\nand the\n`BidRequest.user.ext.consented_providers_settings.consented_providers`\nfield on the (OpenRTB\nprotocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto],\nand a bid is submitted with that creative for an impression that will\nserve to an EEA user, the bid will be filtered before the auction.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"hasUnidentifiedProvider": {
"description": "Whether the creative contains an unidentified ad technology provider.\n\nIf true for a given creative, any bid submitted with that creative for an\nimpression that will serve to an EEA user will be filtered before the\nauction.",
"type": "boolean"
}
},
"type": "object"
},
"AddDealAssociationRequest": {
"description": "A request for associating a deal and a creative.",
"id": "AddDealAssociationRequest",
@@ -2609,7 +2592,7 @@
"type": "object"
},
"AppContext": {
"description": "@OutputOnly The app type the restriction applies to for mobile device.",
"description": "Output only. The app type the restriction applies to for mobile device.",
"id": "AppContext",
"properties": {
"appTypes": {
@@ -2631,7 +2614,7 @@
"type": "object"
},
"AuctionContext": {
"description": "@OutputOnly The auction type the restriction applies to.",
"description": "Output only. The auction type the restriction applies to.",
"id": "AuctionContext",
"properties": {
"auctionTypes": {
@@ -2734,7 +2717,7 @@
"id": "CalloutStatusRow",
"properties": {
"calloutStatusId": {
"description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes).",
"description": "The ID of the callout status.\nSee\n[callout-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/callout-status-codes).",
"format": "int32",
"type": "integer"
},
@@ -2916,7 +2899,7 @@
"type": "object"
},
"Correction": {
"description": "@OutputOnly Shows any corrections that were applied to this creative.",
"description": "Output only. Shows any corrections that were applied to this creative.",
"id": "Correction",
"properties": {
"contexts": {
@@ -2980,6 +2963,10 @@
"description": "The link to AdChoices destination page.",
"type": "string"
},
"adTechnologyProviders": {
"$ref": "AdTechnologyProviders",
"description": "Output only. The detected ad technology providers."
},
"advertiserName": {
"description": "The name of the company being advertised in the creative.",
"type": "string"
@@ -2990,7 +2977,7 @@
"type": "string"
},
"apiUpdateTime": {
"description": "@OutputOnly The last update timestamp of the creative via API.",
"description": "Output only. The last update timestamp of the creative via API.",
"format": "google-datetime",
"type": "string"
},
@@ -3089,7 +3076,7 @@
"type": "array"
},
"corrections": {
"description": "@OutputOnly Shows any corrections that were applied to this creative.",
"description": "Output only. Shows any corrections that were applied to this creative.",
"items": {
"$ref": "Correction"
},
@@ -3100,7 +3087,7 @@
"type": "string"
},
"dealsStatus": {
"description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"description": "Output only. The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"enum": [
"STATUS_UNSPECIFIED",
"NOT_CHECKED",
@@ -3125,7 +3112,7 @@
"type": "array"
},
"detectedAdvertiserIds": {
"description": "@OutputOnly Detected advertiser IDs, if any.",
"description": "Output only. Detected advertiser IDs, if any.",
"items": {
"format": "int64",
"type": "string"
@@ -3133,21 +3120,21 @@
"type": "array"
},
"detectedDomains": {
"description": "@OutputOnly\nThe detected domains for this creative.",
"description": "Output only. The detected domains for this creative.",
"items": {
"type": "string"
},
"type": "array"
},
"detectedLanguages": {
"description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
"description": "Output only. The detected languages for this creative. The order is\narbitrary. The codes are 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
"items": {
"type": "string"
},
"type": "array"
},
"detectedProductCategories": {
"description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
"description": "Output only. Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
"items": {
"format": "int32",
"type": "integer"
@@ -3155,17 +3142,13 @@
"type": "array"
},
"detectedSensitiveCategories": {
"description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
"description": "Output only. Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"filteringStats": {
"$ref": "FilteringStats",
"description": "@OutputOnly The filtering stats for this creative.\nDeprecated; please use\nbidders.accounts.filterSets.filteredBids.creatives.list\nmethod instead."
},
"html": {
"$ref": "HtmlContent",
"description": "An HTML creative."
@@ -3182,7 +3165,7 @@
"description": "A native creative."
},
"openAuctionStatus": {
"description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"description": "Output only. The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"enum": [
"STATUS_UNSPECIFIED",
"NOT_CHECKED",
@@ -3215,7 +3198,7 @@
"type": "array"
},
"servingRestrictions": {
"description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
"description": "Output only. The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
"items": {
"$ref": "ServingRestriction"
},
@@ -3230,7 +3213,7 @@
"type": "array"
},
"version": {
"description": "@OutputOnly The version of this creative.",
"description": "Output only. The version of this creative.",
"format": "int32",
"type": "integer"
},
@@ -3348,7 +3331,7 @@
"type": "string"
},
"nativeTemplate": {
"description": "The native template for this creative. It will have a value only if\ncreative_size_type = CreativeSizeType.NATIVE.\n@OutputOnly",
"description": "Output only. The native template for this creative. It will have a value\nonly if creative_size_type = CreativeSizeType.NATIVE.",
"enum": [
"UNKNOWN_NATIVE_TEMPLATE",
"NATIVE_CONTENT_AD",
@@ -3415,7 +3398,7 @@
"description": "The number of bids with the specified status."
},
"creativeStatusId": {
"description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).",
"description": "The ID of the creative status.\nSee\n[creative-status-codes](https://developers.google.com/authorized-buyers/rtb/downloads/creative-status-codes).",
"format": "int32",
"type": "integer"
},
@@ -3501,7 +3484,7 @@
},
"endTime": {
"$ref": "TimeOfDay",
"description": "The ending time of the day for the ad to show (minute level granularity).\nThe end time is exclusive.\nThis field is not available for filtering in PQL queries."
"description": "The ending time of the day for the ad to show (minute level\ngranularity). The end time is exclusive. This field is not available\nfor filtering in PQL queries."
},
"startTime": {
"$ref": "TimeOfDay",
@@ -3539,7 +3522,7 @@
"type": "object"
},
"Deal": {
"description": "A deal represents a segment of inventory for displaying ads on.\nA proposal can contain multiple deals. A deal contains the terms and targeting information that\nis used for serving.",
"description": "A deal represents a segment of inventory for displaying ads on.\nA proposal can contain multiple deals. A deal contains the terms and\ntargeting information that is used for serving.",
"id": "Deal",
"properties": {
"availableEndTime": {
@@ -3548,7 +3531,7 @@
"type": "string"
},
"availableStartTime": {
"description": "Optional proposed flight start time of the deal.\nThis will generally be stored in the granularity of one second since deal serving\nstarts at seconds boundary. Any time specified with more granularity\n(e.g., in milliseconds) will be truncated towards the start of time in seconds.",
"description": "Optional proposed flight start time of the deal.\nThis will generally be stored in the granularity of one second since deal\nserving starts at seconds boundary. Any time specified with more\ngranularity (e.g., in milliseconds) will be truncated towards the start of\ntime in seconds.",
"format": "google-datetime",
"type": "string"
},
@@ -3566,12 +3549,12 @@
"type": "string"
},
"createTime": {
"description": "The time of the deal creation.\n@OutputOnly",
"description": "Output only. The time of the deal creation.",
"format": "google-datetime",
"type": "string"
},
"creativePreApprovalPolicy": {
"description": "Specifies the creative pre-approval policy.\n@OutputOnly",
"description": "Output only. Specifies the creative pre-approval policy.",
"enum": [
"CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED",
"SELLER_PRE_APPROVAL_REQUIRED",
@@ -3586,10 +3569,10 @@
},
"creativeRestrictions": {
"$ref": "CreativeRestrictions",
"description": "Restricitions about the creatives associated with the deal (i.e., size)\nThis is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.\n@OutputOnly"
"description": "Output only. Restricitions about the creatives associated with the deal\n(i.e., size) This is available for Programmatic Guaranteed/Preferred Deals\nin Ad Manager."
},
"creativeSafeFrameCompatibility": {
"description": "Specifies whether the creative is safeFrame compatible.\n@OutputOnly",
"description": "Output only. Specifies whether the creative is safeFrame compatible.",
"enum": [
"CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED",
"COMPATIBLE",
@@ -3603,12 +3586,12 @@
"type": "string"
},
"dealId": {
"description": "A unique deal ID for the deal (server-assigned).\n@OutputOnly",
"description": "Output only. A unique deal ID for the deal (server-assigned).",
"type": "string"
},
"dealServingMetadata": {
"$ref": "DealServingMetadata",
"description": "Metadata about the serving status of this deal.\n@OutputOnly"
"description": "Output only. Metadata about the serving status of this deal."
},
"dealTerms": {
"$ref": "DealTerms",
@@ -3627,15 +3610,15 @@
"type": "string"
},
"externalDealId": {
"description": "The external deal ID assigned to this deal once the deal is finalized.\nThis is the deal ID that shows up in serving/reporting etc.\n@OutputOnly",
"description": "Output only. The external deal ID assigned to this deal once the deal is\nfinalized. This is the deal ID that shows up in serving/reporting etc.",
"type": "string"
},
"isSetupComplete": {
"description": "True, if the buyside inventory setup is complete for this deal.\n@OutputOnly",
"description": "Output only. True, if the buyside inventory setup is complete for this\ndeal.",
"type": "boolean"
},
"programmaticCreativeSource": {
"description": "Specifies the creative source for programmatic deals. PUBLISHER means\ncreative is provided by seller and ADVERTISER means creative is\nprovided by buyer.\n@OutputOnly",
"description": "Output only. Specifies the creative source for programmatic deals.\nPUBLISHER means creative is provided by seller and ADVERTISER means\ncreative is provided by buyer.",
"enum": [
"PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED",
"ADVERTISER",
@@ -3649,11 +3632,11 @@
"type": "string"
},
"proposalId": {
"description": "ID of the proposal that this deal is part of.\n@OutputOnly",
"description": "Output only. ID of the proposal that this deal is part of.",
"type": "string"
},
"sellerContacts": {
"description": "Seller contact information for the deal.\n@OutputOnly",
"description": "Output only. Seller contact information for the deal.",
"items": {
"$ref": "ContactInformation"
},
@@ -3679,7 +3662,7 @@
},
"targeting": {
"$ref": "MarketplaceTargeting",
"description": "Specifies the subset of inventory targeted by the deal.\n@OutputOnly"
"description": "Output only. Specifies the subset of inventory targeted by the deal."
},
"targetingCriterion": {
"description": "The shared targeting visible to buyers and sellers. Each shared\ntargeting entity is AND'd together.",
@@ -3689,7 +3672,7 @@
"type": "array"
},
"updateTime": {
"description": "The time when the deal was last updated.\n@OutputOnly",
"description": "Output only. The time when the deal was last updated.",
"format": "google-datetime",
"type": "string"
},
@@ -3743,7 +3726,7 @@
"properties": {
"dealPauseStatus": {
"$ref": "DealPauseStatus",
"description": "Tracks which parties (if any) have paused a deal.\n@OutputOnly"
"description": "Output only. Tracks which parties (if any) have paused a deal."
}
},
"type": "object"
@@ -3803,7 +3786,7 @@
"id": "DeliveryControl",
"properties": {
"creativeBlockingLevel": {
"description": "Specified the creative blocking levels to be applied.\n@OutputOnly",
"description": "Output only. Specified the creative blocking levels to be applied.",
"enum": [
"CREATIVE_BLOCKING_LEVEL_UNSPECIFIED",
"PUBLISHER_BLOCKING_RULES",
@@ -3817,7 +3800,7 @@
"type": "string"
},
"deliveryRateType": {
"description": "Specifies how the impression delivery will be paced.\n@OutputOnly",
"description": "Output only. Specifies how the impression delivery will be paced.",
"enum": [
"DELIVERY_RATE_TYPE_UNSPECIFIED",
"EVENLY",
@@ -3833,7 +3816,7 @@
"type": "string"
},
"frequencyCaps": {
"description": "Specifies any frequency caps.\n@OutputOnly",
"description": "Output only. Specifies any frequency caps.",
"items": {
"$ref": "FrequencyCap"
},
@@ -3843,7 +3826,7 @@
"type": "object"
},
"Disapproval": {
"description": "@OutputOnly The reason and details for a disapproval.",
"description": "Output only. The reason and details for a disapproval.",
"id": "Disapproval",
"properties": {
"details": {
@@ -4241,24 +4224,6 @@
},
"type": "object"
},
"FilteringStats": {
"description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
"id": "FilteringStats",
"properties": {
"date": {
"$ref": "Date",
"description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24."
},
"reasons": {
"description": "The set of filtering reasons for this date.",
"items": {
"$ref": "Reason"
},
"type": "array"
}
},
"type": "object"
},
"FirstPartyMobileApplicationTargeting": {
"description": "Represents a list of targeted and excluded mobile application IDs that\npublishers own.\nMobile application IDs are from App Store and Google Play Store.\nAndroid App ID, for example, com.google.android.apps.maps, can be found in\nGoogle Play Store URL.\niOS App ID (which is a number) can be found at the end of iTunes store URL.\nFirst party mobile applications is either included or excluded.",
"id": "FirstPartyMobileApplicationTargeting",
@@ -4585,7 +4550,7 @@
"Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/authorized-buyers/rtb/downloads/vendors).",
"Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/authorized-buyers/rtb/downloads/ad-sensitive-categories).",
"Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/authorized-buyers/rtb/downloads/ad-product-categories).",
"Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/authorized-buyers/rtb/downloads/snippet-status-report-proto)."
"Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in\n[snippet-status-report-proto](https://developers.google.com/authorized-buyers/rtb/downloads/snippet-status-report-proto)."
],
"type": "string"
},
@@ -4802,7 +4767,7 @@
"type": "object"
},
"LocationContext": {
"description": "@OutputOnly The Geo criteria the restriction applies to.",
"description": "Output only. The Geo criteria the restriction applies to.",
"id": "LocationContext",
"properties": {
"geoCriteriaIds": {
@@ -5018,12 +4983,12 @@
"id": "Note",
"properties": {
"createTime": {
"description": "The timestamp for when this note was created.\n@OutputOnly",
"description": "Output only. The timestamp for when this note was created.",
"format": "google-datetime",
"type": "string"
},
"creatorRole": {
"description": "The role of the person (buyer/seller) creating the note.\n@OutputOnly",
"description": "Output only. The role of the person (buyer/seller) creating the note.",
"enum": [
"BUYER_SELLER_ROLE_UNSPECIFIED",
"BUYER",
@@ -5041,11 +5006,11 @@
"type": "string"
},
"noteId": {
"description": "The unique ID for the note.\n@OutputOnly",
"description": "Output only. The unique ID for the note.",
"type": "string"
},
"proposalRevision": {
"description": "The revision number of the proposal when the note is created.\n@OutputOnly",
"description": "Output only. The revision number of the proposal when the note is created.",
"format": "int64",
"type": "string"
}
@@ -5094,7 +5059,7 @@
"type": "object"
},
"PlatformContext": {
"description": "@OutputOnly The type of platform the restriction applies to.",
"description": "Output only. The type of platform the restriction applies to.",
"id": "PlatformContext",
"properties": {
"platforms": {
@@ -5180,12 +5145,12 @@
"id": "Product",
"properties": {
"availableEndTime": {
"description": "The proposed end time for the deal. The field will be truncated to the order of\nseconds during serving.",
"description": "The proposed end time for the deal. The field will be truncated to the\norder of seconds during serving.",
"format": "google-datetime",
"type": "string"
},
"availableStartTime": {
"description": "Inventory availability dates. The start time will be truncated to seconds during serving.\nThus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will be truncated to 3:23:34\nwhen serving.",
"description": "Inventory availability dates. The start time will be truncated to seconds\nduring serving. Thus, a field specified as 3:23:34.456 (HH:mm:ss.SSS) will\nbe truncated to 3:23:34 when serving.",
"format": "google-datetime",
"type": "string"
},
@@ -5273,7 +5238,7 @@
"properties": {
"billedBuyer": {
"$ref": "Buyer",
"description": "Reference to the buyer that will get billed for this proposal.\n@OutputOnly"
"description": "Output only. Reference to the buyer that will get billed for this proposal."
},
"buyer": {
"$ref": "Buyer",
@@ -5291,7 +5256,7 @@
"description": "Private data for buyer. (hidden from seller)."
},
"deals": {
"description": "The deals associated with this proposal. For Private Auction proposals (whose deals have\nNonGuaranteedAuctionTerms), there will only be one deal.",
"description": "The deals associated with this proposal. For Private Auction proposals\n(whose deals have NonGuaranteedAuctionTerms), there will only be one deal.",
"items": {
"$ref": "Deal"
},
@@ -5302,15 +5267,15 @@
"type": "string"
},
"isRenegotiating": {
"description": "True if the proposal is being renegotiated.\n@OutputOnly",
"description": "Output only. True if the proposal is being renegotiated.",
"type": "boolean"
},
"isSetupComplete": {
"description": "True, if the buyside inventory setup is complete for this proposal.\n@OutputOnly",
"description": "Output only. True, if the buyside inventory setup is complete for this\nproposal.",
"type": "boolean"
},
"lastUpdaterOrCommentorRole": {
"description": "The role of the last user that either updated the proposal or left a\ncomment.\n@OutputOnly",
"description": "Output only. The role of the last user that either updated the proposal or\nleft a comment.",
"enum": [
"BUYER_SELLER_ROLE_UNSPECIFIED",
"BUYER",
@@ -5324,14 +5289,14 @@
"type": "string"
},
"notes": {
"description": "The notes associated with this proposal.\n@OutputOnly",
"description": "Output only. The notes associated with this proposal.",
"items": {
"$ref": "Note"
},
"type": "array"
},
"originatorRole": {
"description": "Indicates whether the buyer/seller created the proposal.\n@OutputOnly",
"description": "Output only. Indicates whether the buyer/seller created the proposal.",
"enum": [
"BUYER_SELLER_ROLE_UNSPECIFIED",
"BUYER",
@@ -5345,20 +5310,20 @@
"type": "string"
},
"privateAuctionId": {
"description": "Private auction ID if this proposal is a private auction proposal.\n@OutputOnly",
"description": "Output only. Private auction ID if this proposal is a private auction\nproposal.",
"type": "string"
},
"proposalId": {
"description": "The unique ID of the proposal.\n@OutputOnly",
"description": "Output only. The unique ID of the proposal.",
"type": "string"
},
"proposalRevision": {
"description": "The revision number for the proposal.\nEach update to the proposal or the deal causes the proposal revision number\nto auto-increment. The buyer keeps track of the last revision number they\nknow of and pass it in when making an update. If the head revision number\non the server has since incremented, then an ABORTED error is returned\nduring the update operation to let the buyer know that a subsequent update\nwas made.\n@OutputOnly",
"description": "Output only. The revision number for the proposal.\nEach update to the proposal or the deal causes the proposal revision number\nto auto-increment. The buyer keeps track of the last revision number they\nknow of and pass it in when making an update. If the head revision number\non the server has since incremented, then an ABORTED error is returned\nduring the update operation to let the buyer know that a subsequent update\nwas made.",
"format": "int64",
"type": "string"
},
"proposalState": {
"description": "The current state of the proposal.\n@OutputOnly",
"description": "Output only. The current state of the proposal.",
"enum": [
"PROPOSAL_STATE_UNSPECIFIED",
"PROPOSED",
@@ -5382,14 +5347,14 @@
"description": "Reference to the seller on the proposal.\n\nNote: This field may be set only when creating the resource. Modifying\nthis field while updating the resource will result in an error."
},
"sellerContacts": {
"description": "Contact information for the seller.\n@OutputOnly",
"description": "Output only. Contact information for the seller.",
"items": {
"$ref": "ContactInformation"
},
"type": "array"
},
"updateTime": {
"description": "The time when the proposal was last revised.\n@OutputOnly",
"description": "Output only. The time when the proposal was last revised.",
"format": "google-datetime",
"type": "string"
}
@@ -5397,7 +5362,7 @@
"type": "object"
},
"PublisherProfile": {
"description": "Note: this resource requires whitelisting for access. Please contact your\naccount manager for access to Marketplace resources.\n\nRepresents a publisher profile in Marketplace.\n\nAll fields are read only. All string fields are free-form text entered by the publisher\nunless noted otherwise.",
"description": "Note: this resource requires whitelisting for access. Please contact your\naccount manager for access to Marketplace resources.\n\nRepresents a publisher profile in Marketplace.\n\nAll fields are read only. All string fields are free-form text entered by the\npublisher unless noted otherwise.",
"id": "PublisherProfile",
"properties": {
"audienceDescription": {
@@ -5405,11 +5370,11 @@
"type": "string"
},
"buyerPitchStatement": {
"description": "Statement explaining what's unique about publisher's business, and why buyers should\npartner with the publisher.",
"description": "Statement explaining what's unique about publisher's business, and why\nbuyers should partner with the publisher.",
"type": "string"
},
"directDealsContact": {
"description": "Contact information for direct reservation deals. This is free text entered by the publisher\nand may include information like names, phone numbers and email addresses.",
"description": "Contact information for direct reservation deals. This is free text entered\nby the publisher and may include information like names, phone numbers and\nemail addresses.",
"type": "string"
},
"displayName": {
@@ -5417,7 +5382,7 @@
"type": "string"
},
"domains": {
"description": "The list of domains represented in this publisher profile. Empty if this is a parent profile.\nThese are top private domains, meaning that these will not contain a string like\n\"photos.google.co.uk/123\", but will instead contain \"google.co.uk\".",
"description": "The list of domains represented in this publisher profile. Empty if this is\na parent profile. These are top private domains, meaning that these will\nnot contain a string like \"photos.google.co.uk/123\", but will instead\ncontain \"google.co.uk\".",
"items": {
"type": "string"
},
@@ -5428,7 +5393,7 @@
"type": "string"
},
"logoUrl": {
"description": "A Google public URL to the logo for this publisher profile. The logo is stored as\na PNG, JPG, or GIF image.",
"description": "A Google public URL to the logo for this publisher profile. The logo is\nstored as a PNG, JPG, or GIF image.",
"type": "string"
},
"mediaKitUrl": {
@@ -5440,7 +5405,7 @@
"type": "string"
},
"programmaticDealsContact": {
"description": "Contact information for programmatic deals. This is free text entered by the publisher\nand may include information like names, phone numbers and email addresses.",
"description": "Contact information for programmatic deals. This is free text entered by\nthe publisher and may include information like names, phone numbers and\nemail addresses.",
"type": "string"
},
"publisherProfileId": {
@@ -5481,23 +5446,6 @@
},
"type": "object"
},
"Reason": {
"description": "A specific filtering status and how many times it occurred.",
"id": "Reason",
"properties": {
"count": {
"description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
"format": "int64",
"type": "string"
},
"status": {
"description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RelativeDateRange": {
"description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today,\ni.e., the limits for these values are:\noffset_days >= 0\nduration_days >= 1\noffset_days + duration_days <= 30",
"id": "RelativeDateRange",
@@ -5548,7 +5496,7 @@
"type": "object"
},
"SecurityContext": {
"description": "@OutputOnly A security context.",
"description": "Output only. A security context.",
"id": "SecurityContext",
"properties": {
"securities": {
@@ -5622,7 +5570,7 @@
"type": "object"
},
"ServingRestriction": {
"description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
"description": "Output only. A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
"id": "ServingRestriction",
"properties": {
"contexts": {

2
etc/api/adexperiencereport/v1/adexperiencereport-api.json
View File

@@ -152,7 +152,7 @@
}
}
},
"revision": "20190401",
"revision": "20190624",
"rootUrl": "https://adexperiencereport.googleapis.com/",
"schemas": {
"PlatformSummary": {

2
etc/api/admin/datatransfer_v1/admin-api.json
View File

@@ -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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/sO76R3ImJWyHTWFAs7zvdNuGNOQ\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/sO76R3ImJWyHTWFAs7zvdNuGNOQ\"",
"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"

4
etc/api/admin/directory_v1/admin-api.json
View File

@@ -93,7 +93,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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/H1e00FOyzDuXH0cJcWmWd5Z4OJE\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/eWNDpeAZuk1gV8zhFqMfz4qmrho\"",
"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"
@@ -4425,7 +4425,7 @@
},
"kind": {
"default": "api#channel",
"description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
"description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".",
"type": "string"
},
"params": {

81
etc/api/admin/reports_v1/admin-api.json
View File

@@ -18,7 +18,7 @@
"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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/9KOqS4zqNeHxjHku3mNs2ZYTZkM\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Tjl9ZZXM6pyNHTApQara35wGpUg\"",
"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"
@@ -464,7 +464,7 @@
}
}
},
"revision": "20190210",
"revision": "20190521",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Activities": {
@@ -545,6 +545,19 @@
"format": "int64",
"type": "string"
},
"messageValue": {
"description": "Nested value of the parameter.",
"properties": {
"parameter": {
"description": "Looping to get parameter values.",
"items": {
"$ref": "NestedParameter"
},
"type": "array"
}
},
"type": "object"
},
"multiIntValue": {
"description": "Multi-int value of the parameter.",
"items": {
@@ -553,6 +566,22 @@
},
"type": "array"
},
"multiMessageValue": {
"description": "Nested values of the parameter.",
"items": {
"properties": {
"parameter": {
"description": "Parameter value.",
"items": {
"$ref": "NestedParameter"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"multiValue": {
"description": "Multi-string value of the parameter.",
"items": {
@@ -641,7 +670,7 @@
},
"kind": {
"default": "api#channel",
"description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
"description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".",
"type": "string"
},
"params": {
@@ -675,6 +704,52 @@
},
"type": "object"
},
"NestedParameter": {
"description": "JSON template for a parameter used in various reports.",
"id": "NestedParameter",
"properties": {
"boolValue": {
"description": "Boolean value of the parameter.",
"type": "boolean"
},
"intValue": {
"description": "Integral value of the parameter.",
"format": "int64",
"type": "string"
},
"multiBoolValue": {
"description": "Multiple boolean values of the parameter.",
"items": {
"type": "boolean"
},
"type": "array"
},
"multiIntValue": {
"description": "Multiple integral values of the parameter.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"multiValue": {
"description": "Multiple string values of the parameter.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the parameter.",
"type": "string"
},
"value": {
"description": "String value of the parameter.",
"type": "string"
}
},
"type": "object"
},
"UsageReport": {
"description": "JSON template for a usage report.",
"id": "UsageReport",

4
etc/api/adsense/v1.4/adsense-api.json
View File

@@ -18,7 +18,7 @@
"description": "Accesses AdSense publishers' inventory and generates performance reports.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/adsense/management/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/ld40vBRJ4phE23ahJPajJ2mgzIg\"",
"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 +1655,7 @@
}
}
},
"revision": "20190402",
"revision": "20190703",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Account": {

4
etc/api/adsensehost/v4.1/adsensehost-api.json
View File

@@ -15,7 +15,7 @@
"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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/nnisR9D7hmRfhgKQh6i2Jnx7grk\"",
"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"
@@ -1072,7 +1072,7 @@
}
}
},
"revision": "20190402",
"revision": "20190703",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Account": {

77
etc/api/alertcenter/v1beta1/alertcenter-api.json
View File

@@ -182,7 +182,7 @@
"type": "string"
},
"orderBy": {
"description": "Optional. The sort order of the list results.\nIf not specified results may be returned in arbitrary order.\nYou can sort the results in descending order based on the creation\ntimestamp using `order_by=\"create_time desc\"`.\nCurrently, only sorting by `create_time desc` is supported.",
"description": "Optional. The sort order of the list results.\nIf not specified results may be returned in arbitrary order.\nYou can sort the results in descending order based on the creation\ntimestamp using `order_by=\"create_time desc\"`.\nCurrently, supported sorting are `create_time asc`, `create_time desc`,\n`update_time desc`",
"location": "query",
"type": "string"
},
@@ -357,7 +357,7 @@
}
}
},
"revision": "20190329",
"revision": "20190628",
"rootUrl": "https://alertcenter.googleapis.com/",
"schemas": {
"AccountWarning": {
@@ -375,6 +375,70 @@
},
"type": "object"
},
"ActivityRule": {
"description": "Alerts from G Suite Security Center rules service configured by admin.",
"id": "ActivityRule",
"properties": {
"actionNames": {
"description": "List of action names associated with the rule threshold.",
"items": {
"type": "string"
},
"type": "array"
},
"createTime": {
"description": "Rule create timestamp.",
"format": "google-datetime",
"type": "string"
},
"description": {
"description": "Description of the rule.",
"type": "string"
},
"displayName": {
"description": "Alert display name.",
"type": "string"
},
"name": {
"description": "Rule name.",
"type": "string"
},
"query": {
"description": "Query that is used to get the data from the associated source.",
"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.",
"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.",
"type": "string"
},
"threshold": {
"description": "Alert threshold is for example \u201cCOUNT > 5\u201d.",
"type": "string"
},
"triggerSource": {
"description": "The trigger sources for this rule.\n\n* GMAIL_EVENTS\n* DEVICE_EVENTS\n* USER_EVENTS",
"type": "string"
},
"updateTime": {
"description": "The timestamp of the last update to the rule.",
"format": "google-datetime",
"type": "string"
},
"windowSize": {
"description": "Rule window size. Possible values are 1 hour or 24 hours.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"Alert": {
"description": "An alert affecting a customer.",
"id": "Alert",
@@ -425,6 +489,11 @@
"type": {
"description": "Required. The type of the alert.\nThis is output only after alert is created.\nFor a list of available alert types see\n[G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).",
"type": "string"
},
"updateTime": {
"description": "Output only. The time this alert was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
@@ -800,6 +869,10 @@
"description": "Entity whose actions triggered a Gmail phishing alert.",
"id": "MaliciousEntity",
"properties": {
"displayName": {
"description": "The header from display name.",
"type": "string"
},
"fromHeader": {
"description": "The sender email address.",
"type": "string"

4
etc/api/analytics/v2.4/analytics-api.json
View File

@@ -17,7 +17,7 @@
"description": "Views and manages your Google Analytics data.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/analytics/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/B4sj54YbZa4aQo8XJHngizOjfDQ\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/0LMEInvFibiB5NCs38CsuDxWjRk\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/analytics-16.png",
"x32": "https://www.google.com/images/icons/product/analytics-32.png"
@@ -358,7 +358,7 @@
}
}
},
"revision": "20180730",
"revision": "20190604",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "analytics/v2.4/",
"title": "Google Analytics API",

8
etc/api/analytics/v3/analytics-api.json
View File

@@ -32,7 +32,7 @@
"description": "Views and manages your Google Analytics data.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/analytics/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/E9RbERPla_emX6bTPxlVkk3P0io\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/H4vWgpd1MCO4wKLGF823qtL1fw0\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/analytics-16.png",
"x32": "https://www.google.com/images/icons/product/analytics-32.png"
@@ -1380,7 +1380,7 @@
]
},
"get": {
"description": "Returns a filters to which the user has access.",
"description": "Returns filters to which the user has access.",
"httpMethod": "GET",
"id": "analytics.management.filters.get",
"parameterOrder": [
@@ -3805,7 +3805,7 @@
}
}
},
"revision": "20180730",
"revision": "20190604",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Account": {
@@ -7351,7 +7351,7 @@
"type": "string"
},
"dataRetentionResetOnNewActivity": {
"description": "Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).\nSet to false to delete data associated with the user identifer automatically after the rentention period.\nThis property cannot be set on insert.",
"description": "Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).\nSet to false to delete data associated with the user identifier automatically after the rentention period.\nThis property cannot be set on insert.",
"type": "boolean"
},
"dataRetentionTtl": {

2
etc/api/analyticsreporting/v4/analyticsreporting-api.json
View File

@@ -154,7 +154,7 @@
}
}
},
"revision": "20190401",
"revision": "20190625",
"rootUrl": "https://analyticsreporting.googleapis.com/",
"schemas": {
"Activity": {

36
etc/api/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
View File

@@ -824,7 +824,7 @@
}
}
},
"revision": "20190330",
"revision": "20190622",
"rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
"schemas": {
"ClaimDeviceRequest": {
@@ -1163,6 +1163,16 @@
"Zero-touch enrollment section type."
],
"type": "string"
},
"vacationModeExpireTime": {
"description": "The timestamp when the device will exit \u2018vacation mode\u2019. This value is\npresent iff the device is in 'vacation mode'.",
"format": "google-datetime",
"type": "string"
},
"vacationModeStartTime": {
"description": "The timestamp when the device was put into \u2018vacation mode\u2019. This value is\npresent iff the device is in 'vacation mode'.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
@@ -1495,7 +1505,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": {
@@ -1592,6 +1602,16 @@
"Zero-touch enrollment section type."
],
"type": "string"
},
"vacationModeDays": {
"description": "The duration of the vacation unlock starting from when the request is\nprocessed. (1 day is treated as 24 hours)",
"format": "int32",
"type": "integer"
},
"vacationModeExpireTime": {
"description": "The expiration time of the vacation unlock.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
@@ -1641,7 +1661,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": {
@@ -1693,6 +1713,16 @@
"Zero-touch enrollment section type."
],
"type": "string"
},
"vacationModeDays": {
"description": "The duration of the vacation unlock starting from when the request is\nprocessed. (1 day is treated as 24 hours)",
"format": "int32",
"type": "integer"
},
"vacationModeExpireTime": {
"description": "The expiration time of the vacation unlock.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"

134
etc/api/androidenterprise/v1/androidenterprise-api.json
View File

@@ -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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/tMJPG1kuAV-MqSsPmggFhhbAchQ\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/cVTv8b9hTTB3FqZyWpqQbG2zALc\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/android-16.png",
"x32": "https://www.google.com/images/icons/product/android-32.png"
@@ -74,6 +74,40 @@
"resources": {
"devices": {
"methods": {
"forceReportUpload": {
"description": "Uploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours for a given device.",
"httpMethod": "POST",
"id": "androidenterprise.devices.forceReportUpload",
"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"
},
"userId": {
"description": "The ID of the user.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUpload",
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
},
"get": {
"description": "Retrieves the details of a device.",
"httpMethod": "GET",
@@ -2885,7 +2919,7 @@
}
}
},
"revision": "20190401",
"revision": "20190624",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Administrator": {
@@ -3121,6 +3155,24 @@
},
"type": "object"
},
"AppState": {
"description": "List of states set by the app.",
"id": "AppState",
"properties": {
"keyedAppState": {
"description": "List of keyed app states. This field will always be present.",
"items": {
"$ref": "KeyedAppState"
},
"type": "array"
},
"packageName": {
"description": "The package name of the app. This field will always be present.",
"type": "string"
}
},
"type": "object"
},
"AppUpdateEvent": {
"description": "An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API.",
"id": "AppUpdateEvent",
@@ -3284,6 +3336,48 @@
"policy": {
"$ref": "Policy",
"description": "The policy enforced on the device."
},
"report": {
"$ref": "DeviceReport",
"description": "The device report updated with the latest app states."
}
},
"type": "object"
},
"DeviceReport": {
"description": "Device report updated with the latest app states for managed apps on the device.",
"id": "DeviceReport",
"properties": {
"appState": {
"description": "List of app states set by managed apps on the device. App states are defined by the app's developers. This field will always be present.",
"items": {
"$ref": "AppState"
},
"type": "array"
},
"lastUpdatedTimestampMillis": {
"description": "The timestamp of the last report update in milliseconds since epoch. This field will always be present.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"DeviceReportUpdateEvent": {
"description": "An event generated when an updated device report is available.",
"id": "DeviceReportUpdateEvent",
"properties": {
"deviceId": {
"description": "The Android ID of the device. This field will always be present.",
"type": "string"
},
"report": {
"$ref": "DeviceReport",
"description": "The device report updated with the latest app states. This field will always be present."
},
"userId": {
"description": "The ID of the user. This field will always be present.",
"type": "string"
}
},
"type": "object"
@@ -3589,6 +3683,34 @@
},
"type": "object"
},
"KeyedAppState": {
"description": "Represents a keyed app state containing a key, timestamp, severity level, optional description, and optional data.",
"id": "KeyedAppState",
"properties": {
"data": {
"description": "Additional field intended for machine-readable data. For example, a number or JSON object. To prevent XSS, we recommend removing any HTML from the data before displaying it.",
"type": "string"
},
"key": {
"description": "Key indicating what the app is providing a state for. The content of the key is set by the app's developer. To prevent XSS, we recommend removing any HTML from the key before displaying it. This field will always be present.",
"type": "string"
},
"message": {
"description": "Free-form, human-readable message describing the app state. For example, an error message. To prevent XSS, we recommend removing any HTML from the message before displaying it.",
"type": "string"
},
"severity": {
"description": "Severity of the app state. This field will always be present.",
"type": "string"
},
"stateTimestampMillis": {
"description": "Timestamp of when the app set the state in milliseconds since epoch. This field will always be present.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"LocalizedText": {
"description": "A localized string with its locale.",
"id": "LocalizedText",
@@ -3853,6 +3975,10 @@
"$ref": "AppUpdateEvent",
"description": "Notifications about app updates."
},
"deviceReportUpdateEvent": {
"$ref": "DeviceReportUpdateEvent",
"description": "Notifications about device report updates."
},
"enterpriseId": {
"description": "The ID of the enterprise for which the notification is sent. This will always be present.",
"type": "string"
@@ -3962,6 +4088,10 @@
"description": "The auto-update policy for apps installed on the device. \"choiceToTheUser\" allows the device's user to configure the app update policy. \"always\" enables auto updates. \"never\" disables auto updates. \"wifiOnly\" enables auto updates only when the device is connected to wifi.",
"type": "string"
},
"deviceReportPolicy": {
"description": "Whether the device reports app states to the EMM. The default value is \"deviceReportDisabled\".",
"type": "string"
},
"maintenanceWindow": {
"$ref": "MaintenanceWindow",
"description": "The maintenance window defining when apps running in the foreground should be updated."

139
etc/api/androidmanagement/v1/androidmanagement-api.json
View File

@@ -918,7 +918,7 @@
}
}
},
"revision": "20190329",
"revision": "20190624",
"rootUrl": "https://androidmanagement.googleapis.com/",
"schemas": {
"AlwaysOnVpnPackage": {
@@ -1173,6 +1173,13 @@
"description": "The package name of the app that installed this app.",
"type": "string"
},
"keyedAppStates": {
"description": "List of keyed app states reported by the app.",
"items": {
"$ref": "KeyedAppState"
},
"type": "array"
},
"packageName": {
"description": "Package name of the app.",
"type": "string"
@@ -1212,6 +1219,29 @@
},
"type": "object"
},
"ApplicationReportingSettings": {
"description": "Settings controlling the behavior of application reports.",
"id": "ApplicationReportingSettings",
"properties": {
"includeRemovedApps": {
"description": "Whether removed apps are included in application reports.",
"type": "boolean"
}
},
"type": "object"
},
"BlockAction": {
"description": "An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a device or work profile to displays a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified.",
"id": "BlockAction",
"properties": {
"blockAfterDays": {
"description": "Number of days the policy is non-compliant before the device or work profile is blocked. To block access immediately, set to 0. blockAfterDays must be less than wipeAfterDays.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ChoosePrivateKeyRule": {
"description": "A rule for automatically choosing a private key and certificate to authenticate the device to a server.",
"id": "ChoosePrivateKeyRule",
@@ -1521,6 +1551,13 @@
],
"type": "string"
},
"systemProperties": {
"additionalProperties": {
"type": "string"
},
"description": "Map of selected system properties name and value related to the device.",
"type": "object"
},
"user": {
"$ref": "User",
"description": "The user who owns the device."
@@ -1927,6 +1964,49 @@
},
"type": "object"
},
"KeyedAppState": {
"description": "Keyed app state reported by the app.",
"id": "KeyedAppState",
"properties": {
"createTime": {
"description": "The creation time of the app state on the device.",
"format": "google-datetime",
"type": "string"
},
"data": {
"description": "Optionally, a machine-readable value to be read by the EMM. For example, setting values that the admin can choose to query against in the EMM console (e.g. \u201cnotify me if the battery_warning data < 10\u201d).",
"type": "string"
},
"key": {
"description": "The key for the app state. Acts as a point of reference for what the app is providing state for. For example, when providing managed configuration feedback, this key could be the managed configuration key.",
"type": "string"
},
"lastUpdateTime": {
"description": "The time the app state was most recently updated.",
"format": "google-datetime",
"type": "string"
},
"message": {
"description": "Optionally, a free-form message string to explain the app state. If the state was triggered by a particular value (e.g. a managed configuration value), it should be included in the message.",
"type": "string"
},
"severity": {
"description": "The severity of the app state.",
"enum": [
"SEVERITY_UNSPECIFIED",
"INFO",
"ERROR"
],
"enumDescriptions": [
"Unspecified severity level.",
"Information severity level.",
"Error severity level. This should only be set for genuine error conditions that a management organization needs to take action to fix."
],
"type": "string"
}
},
"type": "object"
},
"LaunchAppAction": {
"description": "An action to launch an app.",
"id": "LaunchAppAction",
@@ -2330,7 +2410,7 @@
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.",
"type": "string"
},
"response": {
@@ -2606,7 +2686,7 @@
"type": "array"
},
"complianceRules": {
"description": "Rules declaring which mitigating actions to take when a device is not compliant with its policy. When the conditions for multiple rules are satisfied, all of the mitigating actions for the rules are taken. There is a maximum limit of 100 rules.",
"description": "Rules declaring which mitigating actions to take when a device is not compliant with its policy. When the conditions for multiple rules are satisfied, all of the mitigating actions for the rules are taken. There is a maximum limit of 100 rules. Use policy enforcement rules instead.",
"items": {
"$ref": "ComplianceRule"
},
@@ -2751,6 +2831,11 @@
"format": "int64",
"type": "string"
},
"minimumApiLevel": {
"description": "The minimum allowed Android API level.",
"format": "int32",
"type": "integer"
},
"mobileNetworksConfigDisabled": {
"description": "Whether configuring mobile networks is disabled.",
"type": "boolean"
@@ -2834,6 +2919,13 @@
],
"type": "string"
},
"policyEnforcementRules": {
"description": "Rules that define the behavior when a particular policy can not be applied on device",
"items": {
"$ref": "PolicyEnforcementRule"
},
"type": "array"
},
"privateKeySelectionEnabled": {
"description": "Allows showing UI on a device for a user to choose a private key alias if there are no matching rules in ChoosePrivateKeyRules. For devices below Android P, setting this may leave enterprise keys vulnerable.",
"type": "boolean"
@@ -2956,6 +3048,25 @@
},
"type": "object"
},
"PolicyEnforcementRule": {
"description": "A rule that defines the actions to take if a device or work profile is not compliant with the policy specified in settingName.",
"id": "PolicyEnforcementRule",
"properties": {
"blockAction": {
"$ref": "BlockAction",
"description": "An action to block access to apps and data on a fully managed device or in a work profile. This action also triggers a user-facing notification with information (where possible) on how to correct the compliance issue. Note: wipeAction must also be specified."
},
"settingName": {
"description": "The top-level policy to enforce. For example, applications or passwordPolicies.",
"type": "string"
},
"wipeAction": {
"$ref": "WipeAction",
"description": "An action to reset a fully managed device or delete a work profile. Note: blockAction must also be specified."
}
},
"type": "object"
},
"PowerManagementEvent": {
"description": "A power management event.",
"id": "PowerManagementEvent",
@@ -3127,7 +3238,7 @@
"type": "object"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
@@ -3157,6 +3268,10 @@
"description": "Settings controlling the behavior of status reports.",
"id": "StatusReportingSettings",
"properties": {
"applicationReportingSettings": {
"$ref": "ApplicationReportingSettings",
"description": "Application reporting settings. Only applicable if application_reports_enabled is true."
},
"applicationReportsEnabled": {
"description": "Whether app reports are enabled.",
"type": "boolean"
@@ -3360,6 +3475,22 @@
}
},
"type": "object"
},
"WipeAction": {
"description": "An action to reset a fully managed device or delete a work profile. Note: blockAction must also be specified.",
"id": "WipeAction",
"properties": {
"preserveFrp": {
"description": "Whether the factory-reset protection data is preserved on the device. This setting doesn\u2019t apply to work profiles.",
"type": "boolean"
},
"wipeAfterDays": {
"description": "Number of days the policy is non-compliant before the device or work profile is wiped. wipeAfterDays must be greater than blockAfterDays.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
},
"servicePath": "",

6
etc/api/androidpublisher/v1.1/androidpublisher-api.json
View File

@@ -15,7 +15,7 @@
"description": "Accesses Android application developers' Google Play accounts.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/android-publisher",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/tb235cukOw0QTEs8Jj_MLyR9hpU\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Smmb-YrB3v4AA7xw1tkHqin8N68\"",
"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": "20190402",
"revision": "20190702",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"InappPurchase": {
@@ -215,7 +215,7 @@
"type": "string"
},
"purchaseState": {
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled",
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled \n- Pending",
"format": "int32",
"type": "integer"
},

4
etc/api/androidpublisher/v1/androidpublisher-api.json
View File

@@ -15,7 +15,7 @@
"description": "Accesses Android application developers' Google Play accounts.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/android-publisher",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/Sfv9GD7qh13jRKioykGJhYinVyQ\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/ntYqdbu8sX8YWLKgjvBOuA7H100\"",
"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": "20190402",
"revision": "20190702",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"SubscriptionPurchase": {

23
etc/api/androidpublisher/v2/androidpublisher-api.json
View File

@@ -15,7 +15,7 @@
"description": "Accesses Android application developers' Google Play accounts.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/android-publisher",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/gXYIj64zEo-phf2ZwoXfn7ydEgw\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Xzykam64w9J0PZpvN6-fPRpjjvM\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/android-16.png",
"x32": "https://www.google.com/images/icons/product/android-32.png"
@@ -1604,9 +1604,8 @@
"type": "string"
},
"track": {
"description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
"description": "The track to read or modify.",
"location": "path",
"pattern": "(alpha|beta|production|rollout|internal)",
"required": true,
"type": "string"
}
@@ -1641,9 +1640,8 @@
"type": "string"
},
"track": {
"description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
"description": "The track to read or modify.",
"location": "path",
"pattern": "(alpha|beta|production|rollout|internal)",
"required": true,
"type": "string"
}
@@ -1681,9 +1679,8 @@
"type": "string"
},
"track": {
"description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
"description": "The track to read or modify.",
"location": "path",
"pattern": "(alpha|beta|production|rollout|internal)",
"required": true,
"type": "string"
}
@@ -1771,7 +1768,7 @@
]
},
"patch": {
"description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.",
"description": "Updates the track configuration for the specified track type. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "androidpublisher.edits.tracks.patch",
"parameterOrder": [
@@ -1811,7 +1808,7 @@
]
},
"update": {
"description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.",
"description": "Updates the track configuration for the specified track type.",
"httpMethod": "PUT",
"id": "androidpublisher.edits.tracks.update",
"parameterOrder": [
@@ -2486,7 +2483,7 @@
}
}
},
"revision": "20190402",
"revision": "20190702",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Apk": {
@@ -3148,7 +3145,7 @@
"type": "string"
},
"purchaseState": {
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled",
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled \n- Pending",
"format": "int32",
"type": "integer"
},
@@ -3395,7 +3392,7 @@
"type": "string"
},
"profileId": {
"description": "The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
"description": "The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
"type": "string"
},
"profileName": {
@@ -3445,12 +3442,14 @@
"id": "Testers",
"properties": {
"googleGroups": {
"description": "A list of all Google Groups, as email addresses, that define testers for this track.",
"items": {
"type": "string"
},
"type": "array"
},
"googlePlusCommunities": {
"description": "A list of all Google+ Communities, as URLs, that define testers for this track.",
"items": {
"type": "string"
},

260
etc/api/androidpublisher/v3/androidpublisher-api.json
View File

@@ -15,7 +15,7 @@
"description": "Accesses Android application developers' Google Play accounts.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/android-publisher",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/mMZW6Q2vSHYGy6aNeVUMU2HLbYU\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/tLEn1KkE5NEmlpywSz1Qx5p8WMk\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/android-16.png",
"x32": "https://www.google.com/images/icons/product/android-32.png"
@@ -1344,9 +1344,8 @@
"type": "string"
},
"track": {
"description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
"description": "The track to read or modify.",
"location": "path",
"pattern": "(alpha|beta|production|rollout|internal)",
"required": true,
"type": "string"
}
@@ -1381,9 +1380,8 @@
"type": "string"
},
"track": {
"description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
"description": "The track to read or modify.",
"location": "path",
"pattern": "(alpha|beta|production|rollout|internal)",
"required": true,
"type": "string"
}
@@ -1421,9 +1419,8 @@
"type": "string"
},
"track": {
"description": "The track to read or modify. Acceptable values are: \"alpha\", \"beta\", \"production\", \"rollout\" or \"internal\".",
"description": "The track to read or modify.",
"location": "path",
"pattern": "(alpha|beta|production|rollout|internal)",
"required": true,
"type": "string"
}
@@ -1511,7 +1508,7 @@
]
},
"patch": {
"description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume. This method supports patch semantics.",
"description": "Updates the track configuration for the specified track type. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "androidpublisher.edits.tracks.patch",
"parameterOrder": [
@@ -1551,7 +1548,7 @@
]
},
"update": {
"description": "Updates the track configuration for the specified track type. When halted, the rollout track cannot be updated without adding new APKs, and adding new APKs will cause it to resume.",
"description": "Updates the track configuration for the specified track type.",
"httpMethod": "PUT",
"id": "androidpublisher.edits.tracks.update",
"parameterOrder": [
@@ -1798,6 +1795,91 @@
}
}
},
"internalappsharingartifacts": {
"methods": {
"uploadapk": {
"description": "Uploads an APK to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.",
"httpMethod": "POST",
"id": "androidpublisher.internalappsharingartifacts.uploadapk",
"mediaUpload": {
"accept": [
"application/octet-stream",
"application/vnd.android.package-archive"
],
"maxSize": "1GB",
"protocols": {
"resumable": {
"multipart": true,
"path": "/resumable/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk"
},
"simple": {
"multipart": true,
"path": "/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/apk"
}
}
},
"parameterOrder": [
"packageName"
],
"parameters": {
"packageName": {
"description": "Unique identifier for the Android app; for example, \"com.spiffygame\".",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "internalappsharing/{packageName}/artifacts/apk",
"response": {
"$ref": "InternalAppSharingArtifact"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"supportsMediaUpload": true
},
"uploadbundle": {
"description": "Uploads an app bundle to internal app sharing. If you are using the Google API client libraries, please increase the timeout of the http request before calling this endpoint (a timeout of 2 minutes is recommended). See: https://developers.google.com/api-client-library/java/google-api-java-client/errors for an example in java.",
"httpMethod": "POST",
"id": "androidpublisher.internalappsharingartifacts.uploadbundle",
"mediaUpload": {
"accept": [
"application/octet-stream"
],
"maxSize": "2GB",
"protocols": {
"resumable": {
"multipart": true,
"path": "/resumable/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle"
},
"simple": {
"multipart": true,
"path": "/upload/androidpublisher/v3/applications/internalappsharing/{packageName}/artifacts/bundle"
}
}
},
"parameterOrder": [
"packageName"
],
"parameters": {
"packageName": {
"description": "Unique identifier for the Android app; for example, \"com.spiffygame\".",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "internalappsharing/{packageName}/artifacts/bundle",
"response": {
"$ref": "InternalAppSharingArtifact"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
],
"supportsMediaUpload": true
}
}
},
"orders": {
"methods": {
"refund": {
@@ -1838,6 +1920,43 @@
"resources": {
"products": {
"methods": {
"acknowledge": {
"description": "Acknowledges a purchase of an inapp item.",
"httpMethod": "POST",
"id": "androidpublisher.purchases.products.acknowledge",
"parameterOrder": [
"packageName",
"productId",
"token"
],
"parameters": {
"packageName": {
"description": "The package name of the application the inapp product was sold in (for example, 'com.some.thing').",
"location": "path",
"required": true,
"type": "string"
},
"productId": {
"description": "The inapp product SKU (for example, 'com.some.thing.inapp1').",
"location": "path",
"required": true,
"type": "string"
},
"token": {
"description": "The token provided to the user's device when the subscription was purchased.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge",
"request": {
"$ref": "ProductPurchasesAcknowledgeRequest"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
},
"get": {
"description": "Checks the purchase and consumption status of an inapp item.",
"httpMethod": "GET",
@@ -1879,6 +1998,43 @@
},
"subscriptions": {
"methods": {
"acknowledge": {
"description": "Acknowledges a subscription purchase.",
"httpMethod": "POST",
"id": "androidpublisher.purchases.subscriptions.acknowledge",
"parameterOrder": [
"packageName",
"subscriptionId",
"token"
],
"parameters": {
"packageName": {
"description": "The package name of the application for which this subscription was purchased (for example, 'com.some.thing').",
"location": "path",
"required": true,
"type": "string"
},
"subscriptionId": {
"description": "The purchased subscription ID (for example, 'monthly001').",
"location": "path",
"required": true,
"type": "string"
},
"token": {
"description": "The token provided to the user's device when the subscription was purchased.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:acknowledge",
"request": {
"$ref": "SubscriptionPurchasesAcknowledgeRequest"
},
"scopes": [
"https://www.googleapis.com/auth/androidpublisher"
]
},
"cancel": {
"description": "Cancels a user's subscription purchase. The subscription remains valid until its expiration time.",
"httpMethod": "POST",
@@ -2226,7 +2382,7 @@
}
}
},
"revision": "20190402",
"revision": "20190702",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Apk": {
@@ -2758,6 +2914,50 @@
},
"type": "object"
},
"InternalAppSharingArtifact": {
"description": "An artifact resource which gets created when uploading an APK or Android App Bundle through internal app sharing.",
"id": "InternalAppSharingArtifact",
"properties": {
"certificateFingerprint": {
"description": "The SHA256 fingerprint of the certificate used to signed the generated artifact.",
"type": "string"
},
"downloadUrl": {
"description": "The download URL generated for the uploaded artifact. Users that are authorized to download can follow the link to the Play Store app to install it.",
"type": "string"
},
"sha256": {
"description": "The SHA-256 hash of the artifact represented as a lowercase hexadecimal number, matching the output of the sha256sum command.",
"type": "string"
}
},
"type": "object"
},
"IntroductoryPriceInfo": {
"description": "Contains the introductory price information for a subscription.",
"id": "IntroductoryPriceInfo",
"properties": {
"introductoryPriceAmountMicros": {
"description": "Introductory price of the subscription, not including tax. The currency is the same as price_currency_code. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is \u20ac1.99, price_amount_micros is 1990000.",
"format": "int64",
"type": "string"
},
"introductoryPriceCurrencyCode": {
"description": "ISO 4217 currency code for the introductory subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is \"GBP\".",
"type": "string"
},
"introductoryPriceCycles": {
"description": "The number of billing period to offer introductory pricing.",
"format": "int32",
"type": "integer"
},
"introductoryPricePeriod": {
"description": "Introductory price period, specified in ISO 8601 format. Common values are (but not limited to) \"P1W\" (one week), \"P1M\" (one month), \"P3M\" (three months), \"P6M\" (six months), and \"P1Y\" (one year).",
"type": "string"
}
},
"type": "object"
},
"Listing": {
"id": "Listing",
"properties": {
@@ -2867,6 +3067,11 @@
"description": "A ProductPurchase resource indicates the status of a user's inapp product purchase.",
"id": "ProductPurchase",
"properties": {
"acknowledgementState": {
"description": "The acknowledgement state of the inapp product. Possible values are: \n- Yet to be acknowledged \n- Acknowledged",
"format": "int32",
"type": "integer"
},
"consumptionState": {
"description": "The consumption state of the inapp product. Possible values are: \n- Yet to be consumed \n- Consumed",
"format": "int32",
@@ -2886,7 +3091,7 @@
"type": "string"
},
"purchaseState": {
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled",
"description": "The purchase state of the order. Possible values are: \n- Purchased \n- Canceled \n- Pending",
"format": "int32",
"type": "integer"
},
@@ -2903,6 +3108,16 @@
},
"type": "object"
},
"ProductPurchasesAcknowledgeRequest": {
"id": "ProductPurchasesAcknowledgeRequest",
"properties": {
"developerPayload": {
"description": "Payload to attach to the purchase.",
"type": "string"
}
},
"type": "object"
},
"Prorate": {
"id": "Prorate",
"properties": {
@@ -3063,6 +3278,11 @@
"description": "A SubscriptionPurchase resource indicates the status of a user's subscription purchase.",
"id": "SubscriptionPurchase",
"properties": {
"acknowledgementState": {
"description": "The acknowledgement state of the subscription product. Possible values are: \n- Yet to be acknowledged \n- Acknowledged",
"format": "int32",
"type": "integer"
},
"autoRenewing": {
"description": "Whether the subscription will automatically be renewed when it reaches its current expiry time.",
"type": "boolean"
@@ -3106,6 +3326,10 @@
"description": "The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
"type": "string"
},
"introductoryPriceInfo": {
"$ref": "IntroductoryPriceInfo",
"description": "Introductory price information of the subscription. This is only present when the subscription was purchased with an introductory price.\n\nThis field does not indicate the subscription is currently in introductory price period."
},
"kind": {
"default": "androidpublisher#subscriptionPurchase",
"description": "This kind represents a subscriptionPurchase object in the androidpublisher service.",
@@ -3138,7 +3362,7 @@
"type": "string"
},
"profileId": {
"description": "The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
"description": "The Google profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'.",
"type": "string"
},
"profileName": {
@@ -3163,6 +3387,16 @@
},
"type": "object"
},
"SubscriptionPurchasesAcknowledgeRequest": {
"id": "SubscriptionPurchasesAcknowledgeRequest",
"properties": {
"developerPayload": {
"description": "Payload to attach to the purchase.",
"type": "string"
}
},
"type": "object"
},
"SubscriptionPurchasesDeferRequest": {
"id": "SubscriptionPurchasesDeferRequest",
"properties": {
@@ -3188,12 +3422,14 @@
"id": "Testers",
"properties": {
"googleGroups": {
"description": "A list of all Google Groups, as email addresses, that define testers for this track.",
"items": {
"type": "string"
},
"type": "array"
},
"googlePlusCommunities": {
"description": "A list of all Google+ Communities, as URLs, that define testers for this track.",
"items": {
"type": "string"
},

14
etc/api/api-list.yaml
View File

@@ -7,6 +7,8 @@ api:
- v1
acceleratedmobilepageurl:
- v1
accessapproval:
- v1beta1
accesscontextmanager:
- v1
- v1beta
@@ -108,6 +110,7 @@ api:
- v1beta1
- v2
cloudscheduler:
- v1
- v1beta1
cloudsearch:
- v1
@@ -122,6 +125,8 @@ api:
- v2
clouduseraccounts:
- vm_beta
commentanalyzer:
- v1alpha1
composer:
- v1
compute:
@@ -141,6 +146,8 @@ api:
- v1
dataflow:
- v1b4
datafusion:
- v1beta1
dataproc:
- v1
datastore:
@@ -179,9 +186,13 @@ api:
- v2
factchecktools:
- v1alpha1
fcm:
- v1
file:
- v1
- v1beta1
firebase:
- v1beta1
firebasedynamiclinks:
- v1
firebasehosting:
@@ -256,6 +267,8 @@ api:
- v3
oauth2:
- v2
osconfig:
- v1alpha2
oslogin:
- v1
- v1beta
@@ -387,6 +400,7 @@ api:
webmasters:
- v3
websecurityscanner:
- v1
- v1beta
youtube:
- v3

8
etc/api/appengine/v1/appengine-api.json
View File

@@ -188,7 +188,7 @@
]
},
"repair": {
"description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
"description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B\"name\"%3A\"projects%2F-%2FserviceAccounts%2Funique_id\"%2C\"resource\"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.",
"flatPath": "v1/apps/{appsId}:repair",
"httpMethod": "POST",
"id": "appengine.apps.repair",
@@ -1572,7 +1572,7 @@
}
}
},
"revision": "20190321",
"revision": "20190624",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
"ApiConfigHandler": {
@@ -2774,7 +2774,7 @@
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.",
"type": "string"
},
"response": {
@@ -3166,7 +3166,7 @@
"type": "object"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {

6
etc/api/appengine/v1alpha/appengine-api.json
View File

@@ -694,7 +694,7 @@
}
}
},
"revision": "20190321",
"revision": "20190624",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
"AuthorizedCertificate": {
@@ -1039,7 +1039,7 @@
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.",
"type": "string"
},
"response": {
@@ -1227,7 +1227,7 @@
"type": "object"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {

10
etc/api/appengine/v1beta/appengine-api.json
View File

@@ -188,7 +188,7 @@
]
},
"repair": {
"description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
"description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B\"name\"%3A\"projects%2F-%2FserviceAccounts%2Funique_id\"%2C\"resource\"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.",
"flatPath": "v1beta/apps/{appsId}:repair",
"httpMethod": "POST",
"id": "appengine.apps.repair",
@@ -1572,7 +1572,7 @@
}
}
},
"revision": "20190321",
"revision": "20190624",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
"ApiConfigHandler": {
@@ -1803,7 +1803,7 @@
"description": "Target scaling by CPU usage."
},
"customMetrics": {
"description": "Target scaling by user-provided metrics.",
"description": "Target scaling by user-provided metrics. Only applicable in the App Engine flexible environment.",
"items": {
"$ref": "CustomMetric"
},
@@ -2847,7 +2847,7 @@
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.",
"type": "string"
},
"response": {
@@ -3235,7 +3235,7 @@
"type": "object"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {

4
etc/api/appsactivity/v1/appsactivity-api.json
View File

@@ -14,7 +14,7 @@
"description": "Provides a historical view of activity.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/google-apps/activity/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/9Xk6E4xFbOR6o0M0-9JQPib6zYY\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/YPqFJe65d5FfTDGB1HI65s4HAx4\"",
"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": "20190402",
"revision": "20190701",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Activity": {

4
etc/api/appstate/v1/appstate-api.json
View File

@@ -15,7 +15,7 @@
"description": "The Google App State API.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/games/services/web/api/states",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/swZo7JM2ROZKlpCcnTqj1lpN-m0\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/9LfeWNSu4Rz9I4ria7noLYTjYQs\"",
"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"
@@ -211,7 +211,7 @@
}
}
},
"revision": "20190328",
"revision": "20190627",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"GetResponse": {

495
etc/api/bigquery/v2/bigquery-api.json
View File

@@ -27,7 +27,7 @@
}
},
"basePath": "/bigquery/v2/",
"baseUrl": "https://www.googleapis.com/bigquery/v2/",
"baseUrl": "https://bigquery.googleapis.com/bigquery/v2/",
"batchPath": "batch/bigquery/v2",
"description": "A data platform for customers to create, manage, share and query data.",
"discoveryVersion": "v1",
@@ -693,7 +693,7 @@
"type": "string"
},
"maxResults": {
"description": "The maximum number of results per page.",
"description": "The maximum number of results to return in a single response page.\nLeverage the page tokens to iterate through the entire collection.",
"format": "uint32",
"location": "query",
"type": "integer"
@@ -824,6 +824,226 @@
}
}
},
"routines": {
"methods": {
"delete": {
"description": "Deletes the routine specified by routineId from the dataset.",
"flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}",
"httpMethod": "DELETE",
"id": "bigquery.routines.delete",
"parameterOrder": [
"projectId",
"datasetId",
"routineId"
],
"parameters": {
"datasetId": {
"description": "Dataset ID of the routine to delete",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"projectId": {
"description": "Project ID of the routine to delete",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"routineId": {
"description": "Routine ID of the routine to delete",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the specified routine resource by routine ID.",
"flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}",
"httpMethod": "GET",
"id": "bigquery.routines.get",
"parameterOrder": [
"projectId",
"datasetId",
"routineId"
],
"parameters": {
"datasetId": {
"description": "Dataset ID of the requested routine",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"fieldMask": {
"description": "If set, only the Routine fields in the field mask are returned in the\nresponse. If unset, all Routine fields are returned.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"projectId": {
"description": "Project ID of the requested routine",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"routineId": {
"description": "Routine ID of the requested routine",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}",
"response": {
"$ref": "Routine"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"insert": {
"description": "Creates a new routine in the dataset.",
"flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines",
"httpMethod": "POST",
"id": "bigquery.routines.insert",
"parameterOrder": [
"projectId",
"datasetId"
],
"parameters": {
"datasetId": {
"description": "Dataset ID of the new routine",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"projectId": {
"description": "Project ID of the new routine",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "projects/{+projectId}/datasets/{+datasetId}/routines",
"request": {
"$ref": "Routine"
},
"response": {
"$ref": "Routine"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all routines in the specified dataset. Requires the READER dataset\nrole.",
"flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines",
"httpMethod": "GET",
"id": "bigquery.routines.list",
"parameterOrder": [
"projectId",
"datasetId"
],
"parameters": {
"datasetId": {
"description": "Dataset ID of the routines to list",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"maxResults": {
"description": "The maximum number of results to return in a single response page.\nLeverage the page tokens to iterate through the entire collection.",
"format": "uint32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Page token, returned by a previous call, to request the next page of\nresults",
"location": "query",
"type": "string"
},
"projectId": {
"description": "Project ID of the routines to list",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "projects/{+projectId}/datasets/{+datasetId}/routines",
"response": {
"$ref": "ListRoutinesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"update": {
"description": "Updates information in an existing routine. The update method replaces the\nentire Routine resource.",
"flatPath": "projects/{projectsId}/datasets/{datasetsId}/routines/{routinesId}",
"httpMethod": "PUT",
"id": "bigquery.routines.update",
"parameterOrder": [
"projectId",
"datasetId",
"routineId"
],
"parameters": {
"datasetId": {
"description": "Dataset ID of the routine to update",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"projectId": {
"description": "Project ID of the routine to update",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
},
"routineId": {
"description": "Routine ID of the routine to update",
"location": "path",
"pattern": "^[^/]+$",
"required": true,
"type": "string"
}
},
"path": "projects/{+projectId}/datasets/{+datasetId}/routines/{+routineId}",
"request": {
"$ref": "Routine"
},
"response": {
"$ref": "Routine"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"tabledata": {
"methods": {
"insertAll": {
@@ -1174,11 +1394,11 @@
}
}
},
"revision": "20190314",
"rootUrl": "https://www.googleapis.com/",
"revision": "20190630",
"rootUrl": "https://bigquery.googleapis.com/",
"schemas": {
"AggregateClassificationMetrics": {
"description": "Aggregate metrics for classification models. For multi-class models,\nthe metrics are either macro-averaged: metrics are calculated for each\nlabel and then an unweighted average is taken of those values or\nmicro-averaged: the metric is calculated globally by counting the total\nnumber of correctly predicted rows.",
"description": "Aggregate metrics for classification/classifier models. For multi-class\nmodels, the metrics are either macro-averaged or micro-averaged. When\nmacro-averaged, the metrics are calculated for each label and then an\nunweighted average is taken of those values. When micro-averaged, the\nmetric is calculated globally by counting the total number of correctly\npredicted rows.",
"id": "AggregateClassificationMetrics",
"properties": {
"accuracy": {
@@ -1219,6 +1439,51 @@
},
"type": "object"
},
"Argument": {
"description": "Input/output argument of a function or a stored procedure.",
"id": "Argument",
"properties": {
"argumentKind": {
"description": "Optional. Defaults to FIXED_TYPE.",
"enum": [
"ARGUMENT_KIND_UNSPECIFIED",
"FIXED_TYPE",
"ANY_TYPE"
],
"enumDescriptions": [
"",
"The argument is a variable with fully specified type, which can be a\nstruct or an array, but not a table.",
"The argument is any type, including struct or array, but not a table.\nTo be added: FIXED_TABLE, ANY_TABLE"
],
"type": "string"
},
"dataType": {
"$ref": "StandardSqlDataType",
"description": "Required unless argument_kind = ANY_TYPE."
},
"mode": {
"description": "Optional. Specifies whether the argument is input or output.\nCan be set for procedures only.",
"enum": [
"MODE_UNSPECIFIED",
"IN",
"OUT",
"INOUT"
],
"enumDescriptions": [
"",
"The argument is input-only.",
"The argument is output-only.",
"The argument is both an input and an output."
],
"type": "string"
},
"name": {
"description": "Optional. The name of this argument. Can be absent for function return\nargument.",
"type": "string"
}
},
"type": "object"
},
"BigQueryModelTraining": {
"id": "BigQueryModelTraining",
"properties": {
@@ -1316,7 +1581,7 @@
"type": "object"
},
"BinaryClassificationMetrics": {
"description": "Evaluation metrics for binary classification models.",
"description": "Evaluation metrics for binary classification/classifier models.",
"id": "BinaryClassificationMetrics",
"properties": {
"aggregateClassificationMetrics": {
@@ -1329,6 +1594,14 @@
"$ref": "BinaryConfusionMatrix"
},
"type": "array"
},
"negativeLabel": {
"description": "Label representing the negative class.",
"type": "string"
},
"positiveLabel": {
"description": "Label representing the positive class.",
"type": "string"
}
},
"type": "object"
@@ -1337,6 +1610,16 @@
"description": "Confusion matrix for binary classification models.",
"id": "BinaryConfusionMatrix",
"properties": {
"accuracy": {
"description": "The fraction of predictions given the correct label.",
"format": "double",
"type": "number"
},
"f1Score": {
"description": "The equally weighted average of recall and precision.",
"format": "double",
"type": "number"
},
"falseNegatives": {
"description": "Number of false samples predicted as false.",
"format": "int64",
@@ -1353,12 +1636,12 @@
"type": "number"
},
"precision": {
"description": "Aggregate precision.",
"description": "The fraction of actual positive predictions that had positive actual\nlabels.",
"format": "double",
"type": "number"
},
"recall": {
"description": "Aggregate recall.",
"description": "The fraction of actual positive labels that were given a positive\nprediction.",
"format": "double",
"type": "number"
},
@@ -1620,6 +1903,9 @@
"$ref": "DatasetReference",
"description": "[Required] A reference that identifies the dataset."
},
"defaultEncryptionConfiguration": {
"$ref": "EncryptionConfiguration"
},
"defaultPartitionExpirationMs": {
"description": "[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.",
"format": "int64",
@@ -1824,12 +2110,12 @@
"type": "object"
},
"EvaluationMetrics": {
"description": "Evaluation metrics of a model. These are either computed on all\ntraining data or just the eval data based on whether eval data was used\nduring training.",
"description": "Evaluation metrics of a model. These are either computed on all training\ndata or just the eval data based on whether eval data was used during\ntraining. These are not present for imported models.",
"id": "EvaluationMetrics",
"properties": {
"binaryClassificationMetrics": {
"$ref": "BinaryClassificationMetrics",
"description": "Populated for binary classification models."
"description": "Populated for binary classification/classifier models."
},
"clusteringMetrics": {
"$ref": "ClusteringMetrics",
@@ -1837,7 +2123,7 @@
},
"multiClassClassificationMetrics": {
"$ref": "MultiClassClassificationMetrics",
"description": "Populated for multi-class classification models."
"description": "Populated for multi-class classification/classifier models."
},
"regressionMetrics": {
"$ref": "RegressionMetrics",
@@ -2041,9 +2327,13 @@
"description": "[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS."
},
"hivePartitioningMode": {
"description": "[Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error.",
"description": "[Optional, Trusted Tester] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. Note: this setting is in the process of being deprecated in favor of hivePartitioningOptions.",
"type": "string"
},
"hivePartitioningOptions": {
"$ref": "HivePartitioningOptions",
"description": "[Optional, Trusted Tester] Options to configure hive partitioning support."
},
"ignoreUnknownValues": {
"description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.",
"type": "boolean"
@@ -2165,6 +2455,20 @@
},
"type": "object"
},
"HivePartitioningOptions": {
"id": "HivePartitioningOptions",
"properties": {
"mode": {
"description": "[Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.",
"type": "string"
},
"sourceUriPrefix": {
"description": "[Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).",
"type": "string"
}
},
"type": "object"
},
"IterationResult": {
"description": "Information about a single iteration of the training run.",
"id": "IterationResult",
@@ -2386,9 +2690,13 @@
"type": "string"
},
"hivePartitioningMode": {
"description": "[Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error.",
"description": "[Optional, Trusted Tester] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error.",
"type": "string"
},
"hivePartitioningOptions": {
"$ref": "HivePartitioningOptions",
"description": "[Optional, Trusted Tester] Options to configure hive partitioning support."
},
"ignoreUnknownValues": {
"description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names",
"type": "boolean"
@@ -2772,6 +3080,10 @@
},
"type": "array"
},
"reservation_id": {
"description": "[Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.",
"type": "string"
},
"startTime": {
"description": "[Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.",
"format": "int64",
@@ -2875,7 +3187,7 @@
"description": "[Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries."
},
"statementType": {
"description": "The type of query statement, if valid. Possible values (new values might be added in the future): \"SELECT\": SELECT query. \"INSERT\": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"UPDATE\": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"DELETE\": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"MERGE\": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"CREATE_TABLE\": CREATE [OR REPLACE] TABLE without AS SELECT. \"CREATE_TABLE_AS_SELECT\": CREATE [OR REPLACE] TABLE ... AS SELECT ... . \"DROP_TABLE\": DROP TABLE query. \"CREATE_VIEW\": CREATE [OR REPLACE] VIEW ... AS SELECT ... . \"DROP_VIEW\": DROP VIEW query. \"CREATE_FUNCTION\": CREATE FUNCTION query. \"DROP_FUNCTION\" : DROP FUNCTION query. \"ALTER_TABLE\": ALTER TABLE query. \"ALTER_VIEW\": ALTER VIEW query.",
"description": "The type of query statement, if valid. Possible values (new values might be added in the future): \"SELECT\": SELECT query. \"INSERT\": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"UPDATE\": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"DELETE\": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"MERGE\": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. \"ALTER_TABLE\": ALTER TABLE query. \"ALTER_VIEW\": ALTER VIEW query. \"CREATE_FUNCTION\": CREATE FUNCTION query. \"CREATE_MODEL\": CREATE [OR REPLACE] MODEL ... AS SELECT ... . \"CREATE_PROCEDURE\": CREATE PROCEDURE query. \"CREATE_TABLE\": CREATE [OR REPLACE] TABLE without AS SELECT. \"CREATE_TABLE_AS_SELECT\": CREATE [OR REPLACE] TABLE ... AS SELECT ... . \"CREATE_VIEW\": CREATE [OR REPLACE] VIEW ... AS SELECT ... . \"DROP_FUNCTION\" : DROP FUNCTION query. \"DROP_PROCEDURE\": DROP PROCEDURE query. \"DROP_TABLE\": DROP TABLE query. \"DROP_VIEW\": DROP VIEW query.",
"type": "string"
},
"timeline": {
@@ -3019,6 +3331,34 @@
},
"type": "object"
},
"ListRoutinesResponse": {
"id": "ListRoutinesResponse",
"properties": {
"nextPageToken": {
"description": "A token to request the next page of results.",
"type": "string"
},
"routines": {
"description": "Routines in the requested dataset. Only the following fields are populated:\netag, project_id, dataset_id, routine_id, routine_type, creation_time,\nlast_modified_time, language.",
"items": {
"$ref": "Routine"
},
"type": "array"
}
},
"type": "object"
},
"LocationMetadata": {
"description": "BigQuery-specific metadata about a location. This will be set on\ngoogle.cloud.location.Location.metadata in Cloud Location API\nresponses.",
"id": "LocationMetadata",
"properties": {
"legacyLocationId": {
"description": "The legacy BigQuery location ID, e.g. \u201cEU\u201d for the \u201ceurope\u201d location.\nThis is for any API consumers that need the legacy \u201cUS\u201d and \u201cEU\u201d locations.",
"type": "string"
}
},
"type": "object"
},
"MaterializedViewDefinition": {
"id": "MaterializedViewDefinition",
"properties": {
@@ -3043,7 +3383,7 @@
"type": "string"
},
"description": {
"description": "[Optional] A user-friendly description of this model.\n@mutable bigquery.models.patch",
"description": "[Optional] A user-friendly description of this model.",
"type": "string"
},
"etag": {
@@ -3051,7 +3391,7 @@
"type": "string"
},
"expirationTime": {
"description": "[Optional] The time when this model expires, in milliseconds since the\nepoch. If not present, the model will persist indefinitely. Expired models\nwill be deleted and their storage reclaimed. The defaultTableExpirationMs\nproperty of the encapsulating dataset can be used to set a default\nexpirationTime on newly created models.\n@mutable bigquery.models.patch",
"description": "[Optional] The time when this model expires, in milliseconds since the\nepoch. If not present, the model will persist indefinitely. Expired models\nwill be deleted and their storage reclaimed. The defaultTableExpirationMs\nproperty of the encapsulating dataset can be used to set a default\nexpirationTime on newly created models.",
"format": "int64",
"type": "string"
},
@@ -3063,11 +3403,11 @@
"type": "array"
},
"friendlyName": {
"description": "[Optional] A descriptive name for this model.\n@mutable bigquery.models.patch",
"description": "[Optional] A descriptive name for this model.",
"type": "string"
},
"labelColumns": {
"description": "Output only. Label columns that were used to train this model.\nThe output of the model will have a \u201cpredicted_\u201d prefix to these columns.",
"description": "Output only. Label columns that were used to train this model.\nThe output of the model will have a \"predicted_\" prefix to these columns.",
"items": {
"$ref": "StandardSqlField"
},
@@ -3077,7 +3417,7 @@
"additionalProperties": {
"type": "string"
},
"description": "[Optional] The labels associated with this model. You can use these to\norganize and group your models. Label keys and values can be no longer\nthan 63 characters, can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nLabel values are optional. Label keys must start with a letter and each\nlabel in the list must have a different key.\n@mutable bigquery.models.patch",
"description": "[Optional] The labels associated with this model. You can use these to\norganize and group your models. Label keys and values can be no longer\nthan 63 characters, can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nLabel values are optional. Label keys must start with a letter and each\nlabel in the list must have a different key.",
"type": "object"
},
"lastModifiedTime": {
@@ -3099,13 +3439,15 @@
"MODEL_TYPE_UNSPECIFIED",
"LINEAR_REGRESSION",
"LOGISTIC_REGRESSION",
"KMEANS"
"KMEANS",
"TENSORFLOW"
],
"enumDescriptions": [
"",
"Linear regression model.",
"Logistic regression model.",
"[Beta] K-means clustering model."
"Logistic regression based classification model.",
"[Beta] K-means clustering model.",
"[Beta] An imported TensorFlow model."
],
"type": "string"
},
@@ -3170,7 +3512,7 @@
"type": "object"
},
"MultiClassClassificationMetrics": {
"description": "Evaluation metrics for multi-class classification models.",
"description": "Evaluation metrics for multi-class classification/classifier models.",
"id": "MultiClassClassificationMetrics",
"properties": {
"aggregateClassificationMetrics": {
@@ -3550,6 +3892,81 @@
},
"type": "object"
},
"Routine": {
"description": "A user-defined function or a stored procedure.",
"id": "Routine",
"properties": {
"arguments": {
"description": "Optional.",
"items": {
"$ref": "Argument"
},
"type": "array"
},
"creationTime": {
"description": "Output only. The time when this routine was created, in milliseconds since\nthe epoch.",
"format": "int64",
"type": "string"
},
"definitionBody": {
"description": "Required. The body of the routine.\n\nFor functions, this is the expression in the AS clause.\n\nIf language=SQL, it is the substring inside (but excluding) the\nparentheses. For example, for the function created with the following\nstatement:\n\n`CREATE FUNCTION JoinLines(x string, y string) as (concat(x, \"\\n\", y))`\n\nThe definition_body is `concat(x, \"\\n\", y)` (\\n is not replaced with\nlinebreak).\n\nIf language=JAVASCRIPT, it is the evaluated string in the AS clause.\nFor example, for the function created with the following statement:\n\n`CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return \"\\n\";\\n'`\n\nThe definition_body is\n\n`return \"\\n\";\\n`\n\nNote that both \\n are replaced with linebreaks.",
"type": "string"
},
"etag": {
"description": "Output only. A hash of this resource.",
"type": "string"
},
"importedLibraries": {
"description": "Optional. If language = \"JAVASCRIPT\", this field stores the path of the\nimported JAVASCRIPT libraries.",
"items": {
"type": "string"
},
"type": "array"
},
"language": {
"description": "Optional. Defaults to \"SQL\".",
"enum": [
"LANGUAGE_UNSPECIFIED",
"SQL",
"JAVASCRIPT"
],
"enumDescriptions": [
"",
"SQL language.",
"JavaScript language."
],
"type": "string"
},
"lastModifiedTime": {
"description": "Output only. The time when this routine was last modified, in milliseconds\nsince the epoch.",
"format": "int64",
"type": "string"
},
"returnType": {
"$ref": "StandardSqlDataType",
"description": "Optional if language = \"SQL\"; required otherwise.\n\nIf absent, the return type is inferred from definition_body at query time\nin each query that references this routine. If present, then the evaluated\nresult will be cast to the specified returned type at query time.\n\nFor example, for the functions created with the following statements:\n\n* `CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y);`\n\n* `CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1));`\n\n* `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));`\n\nThe return_type is `{type_kind: \"FLOAT64\"}` for `Add` and `Decrement`, and\nis absent for `Increment` (inferred as FLOAT64 at query time).\n\nSuppose the function `Add` is replaced by\n `CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y);`\n\nThen the inferred return type of `Increment` is automatically changed to\nINT64 at query time, while the return type of `Decrement` remains FLOAT64."
},
"routineReference": {
"$ref": "RoutineReference",
"description": "Required. Reference describing the ID of this routine."
},
"routineType": {
"description": "Required.",
"enum": [
"ROUTINE_TYPE_UNSPECIFIED",
"SCALAR_FUNCTION",
"PROCEDURE"
],
"enumDescriptions": [
"",
"Non-builtin permanent scalar function.",
"Stored procedure."
],
"type": "string"
}
},
"type": "object"
},
"RoutineReference": {
"id": "RoutineReference",
"properties": {
@@ -4186,11 +4603,11 @@
"type": "string"
},
"earlyStop": {
"description": "Whether to stop early when the loss doesn't improve significantly\nany more (compared to min_relative_progress).",
"description": "Whether to stop early when the loss doesn't improve significantly\nany more (compared to min_relative_progress). Used only for iterative\ntraining algorithms.",
"type": "boolean"
},
"initialLearnRate": {
"description": "Specifies the initial learning rate for line search to start at.",
"description": "Specifies the initial learning rate for the line search learn rate\nstrategy.",
"format": "double",
"type": "number"
},
@@ -4216,16 +4633,16 @@
"format": "double",
"type": "number"
},
"description": "Weights associated with each label class, for rebalancing the\ntraining data.",
"description": "Weights associated with each label class, for rebalancing the\ntraining data. Only applicable for classification models.",
"type": "object"
},
"learnRate": {
"description": "Learning rate in training.",
"description": "Learning rate in training. Used only for iterative training algorithms.",
"format": "double",
"type": "number"
},
"learnRateStrategy": {
"description": "The strategy to determine learning rate.",
"description": "The strategy to determine learn rate for the current iteration.",
"enum": [
"LEARN_RATE_STRATEGY_UNSPECIFIED",
"LINE_SEARCH",
@@ -4253,20 +4670,38 @@
"type": "string"
},
"maxIterations": {
"description": "The maximum number of iterations in training.",
"description": "The maximum number of iterations in training. Used only for iterative\ntraining algorithms.",
"format": "int64",
"type": "string"
},
"minRelativeProgress": {
"description": "When early_stop is true, stops training when accuracy improvement is\nless than 'min_relative_progress'.",
"description": "When early_stop is true, stops training when accuracy improvement is\nless than 'min_relative_progress'. Used only for iterative training\nalgorithms.",
"format": "double",
"type": "number"
},
"modelUri": {
"description": "[Beta] Google Cloud Storage URI from which the model was imported. Only\napplicable for imported models.",
"type": "string"
},
"numClusters": {
"description": "[Beta] Number of clusters for clustering models.",
"format": "int64",
"type": "string"
},
"optimizationStrategy": {
"description": "Optimization strategy for training linear regression models.",
"enum": [
"OPTIMIZATION_STRATEGY_UNSPECIFIED",
"BATCH_GRADIENT_DESCENT",
"NORMAL_EQUATION"
],
"enumDescriptions": [
"",
"Uses an iterative batch gradient descent algorithm.",
"Uses a normal equation to solve linear regression problem."
],
"type": "string"
},
"warmStart": {
"description": "Whether to train a model from the last checkpoint.",
"type": "boolean"

18
etc/api/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
View File

@@ -408,7 +408,7 @@
"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 \u201cnone+gsession\u201d 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.",
"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",
"type": "string"
}
@@ -549,7 +549,7 @@
"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 \u201cnone+gsession\u201d 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.",
"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",
"type": "string"
}
@@ -827,7 +827,7 @@
"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 \u201cnone+gsession\u201d 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.",
"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",
"type": "string"
}
@@ -968,7 +968,7 @@
"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 \u201cnone+gsession\u201d 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.",
"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",
"type": "string"
}
@@ -1223,7 +1223,7 @@
}
}
},
"revision": "20190323",
"revision": "20190629",
"rootUrl": "https://bigquerydatatransfer.googleapis.com/",
"schemas": {
"CheckValidCredsRequest": {
@@ -1372,6 +1372,10 @@
},
"type": "array"
},
"deprecated": {
"description": "If true, it should not be used in new transfers, and it should not be\nvisible to users.",
"type": "boolean"
},
"description": {
"description": "Parameter description.",
"type": "string"
@@ -1667,7 +1671,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": {
@@ -1863,7 +1867,7 @@
"type": "object"
},
"runTime": {
"description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
"description": "For batch transfer runs, specifies the date and time of the data should be\ningested.",
"format": "google-datetime",
"type": "string"
},

125
etc/api/bigtableadmin/v1/bigtableadmin-api.json
View File

@@ -94,77 +94,8 @@
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "bigtableadmin.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Location"
}
},
"list": {
"description": "Lists information about the supported locations for this service.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "bigtableadmin.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
}
}
}
}
}
}
},
"revision": "20190328",
"resources": {},
"revision": "20190506",
"rootUrl": "https://bigtableadmin.googleapis.com/",
"schemas": {
"Cluster": {
@@ -363,58 +294,6 @@
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"PartialUpdateInstanceRequest": {
"description": "Request message for BigtableInstanceAdmin.PartialUpdateInstance.",
"id": "PartialUpdateInstanceRequest",

143
etc/api/bigtableadmin/v2/bigtableadmin-api.json
View File

@@ -694,7 +694,8 @@
"https://www.googleapis.com/auth/bigtable.admin.instance",
"https://www.googleapis.com/auth/cloud-bigtable.admin",
"https://www.googleapis.com/auth/cloud-bigtable.admin.cluster",
"https://www.googleapis.com/auth/cloud-platform"
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
@@ -1199,7 +1200,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"
@@ -1341,11 +1342,93 @@
}
}
}
},
"locations": {
"methods": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "bigtableadmin.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2/{+name}",
"response": {
"$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/bigtable.admin",
"https://www.googleapis.com/auth/bigtable.admin.cluster",
"https://www.googleapis.com/auth/bigtable.admin.instance",
"https://www.googleapis.com/auth/cloud-bigtable.admin",
"https://www.googleapis.com/auth/cloud-bigtable.admin.cluster",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
"description": "Lists information about the supported locations for this service.",
"flatPath": "v2/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "bigtableadmin.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v2/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/bigtable.admin",
"https://www.googleapis.com/auth/bigtable.admin.cluster",
"https://www.googleapis.com/auth/bigtable.admin.instance",
"https://www.googleapis.com/auth/cloud-bigtable.admin",
"https://www.googleapis.com/auth/cloud-bigtable.admin.cluster",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
}
}
}
},
"revision": "20190328",
"revision": "20190506",
"rootUrl": "https://bigtableadmin.googleapis.com/",
"schemas": {
"AppProfile": {
@@ -1429,7 +1512,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "Unimplemented. The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -1903,6 +1986,24 @@
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
@@ -1939,6 +2040,40 @@
},
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"Modification": {
"description": "A create, update, or delete of a particular column family.",
"id": "Modification",

18
etc/api/binaryauthorization/v1beta1/binaryauthorization-api.json
View File

@@ -107,7 +107,7 @@
"projects": {
"methods": {
"getPolicy": {
"description": "Gets the policy for this project. Returns a default\npolicy if the project does not have one.",
"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": "v1beta1/projects/{projectsId}/policy",
"httpMethod": "GET",
"id": "binaryauthorization.projects.getPolicy",
@@ -255,6 +255,12 @@
"resource"
],
"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.",
"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",
@@ -404,6 +410,12 @@
"resource"
],
"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.",
"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",
@@ -481,7 +493,7 @@
}
}
},
"revision": "20190322",
"revision": "20190628",
"rootUrl": "https://binaryauthorization.googleapis.com/",
"schemas": {
"AdmissionRule": {
@@ -592,7 +604,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",

2
etc/api/blogger/v2/blogger-api.json
View File

@@ -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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/-Mtk4jzrnfn1WM7fqzAFlj2E6ZM\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/-Mtk4jzrnfn1WM7fqzAFlj2E6ZM\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/blogger-16.png",
"x32": "https://www.google.com/images/icons/product/blogger-32.png"

2
etc/api/blogger/v3/blogger-api.json
View File

@@ -17,7 +17,7 @@
"description": "API for access to the data within Blogger.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/zeFiTF7dFzipBcUZ7HKiIsW5EE0\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/zeFiTF7dFzipBcUZ7HKiIsW5EE0\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/blogger-16.png",
"x32": "https://www.google.com/images/icons/product/blogger-32.png"

2
etc/api/books/v1/books-api.json
View File

@@ -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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/h5Orf5DrqrrUcgcY5Qi7H6FmfVA\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/h5Orf5DrqrrUcgcY5Qi7H6FmfVA\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/ebooks-16.png",
"x32": "https://www.google.com/images/icons/product/ebooks-32.png"

16
etc/api/calendar/v3/calendar-api.json
View File

@@ -26,7 +26,7 @@
"description": "Manipulates events and other calendar data.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/google-apps/calendar/firstapp",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/K8LMZ9chM5kSVFHSd0_S-CEUrGk\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Uw1wZjyl7UpAF8rQe1IdxXCUbFE\"",
"icons": {
"x16": "http://www.google.com/images/icons/product/calendar-16.png",
"x32": "http://www.google.com/images/icons/product/calendar-32.png"
@@ -1164,13 +1164,13 @@
"type": "string"
},
"timeMax": {
"description": "Upper bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.",
"description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.",
"format": "date-time",
"location": "query",
"type": "string"
},
"timeMin": {
"description": "Lower bound (inclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.",
"description": "Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.",
"format": "date-time",
"location": "query",
"type": "string"
@@ -1561,13 +1561,13 @@
"type": "string"
},
"timeMax": {
"description": "Upper bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.",
"description": "Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.",
"format": "date-time",
"location": "query",
"type": "string"
},
"timeMin": {
"description": "Lower bound (inclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.",
"description": "Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.",
"format": "date-time",
"location": "query",
"type": "string"
@@ -1724,7 +1724,7 @@
}
}
},
"revision": "20190331",
"revision": "20190702",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Acl": {
@@ -2019,7 +2019,7 @@
},
"kind": {
"default": "api#channel",
"description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
"description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".",
"type": "string"
},
"params": {
@@ -2130,7 +2130,7 @@
"description": "Additional properties related to a conference. An example would be a solution-specific setting for enabling video streaming."
},
"signature": {
"description": "The signature of the conference data.\nGenereated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.\nUnset for a conference with a failed create request.\nOptional for a conference with a pending create request.",
"description": "The signature of the conference data.\nGenerated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied.\nUnset for a conference with a failed create request.\nOptional for a conference with a pending create request.",
"type": "string"
}
},

2
etc/api/chat/v1/chat-api.json
View File

@@ -316,7 +316,7 @@
}
}
},
"revision": "20190330",
"revision": "20190622",
"rootUrl": "https://chat.googleapis.com/",
"schemas": {
"ActionParameter": {

4
etc/api/civicinfo/v2/civicinfo-api.json
View File

@@ -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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/zO2CfoALuTqzkQa7fll9-ZeHSVM\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/2HSm5Y_VQu7HMhXJ9JbMEFESbM0\"",
"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": "20181017",
"revision": "20190402",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"AdministrationRegion": {

8
etc/api/classroom/v1/classroom-api.json
View File

@@ -867,7 +867,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`",
"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`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
@@ -2151,7 +2151,7 @@
}
}
},
"revision": "20190401",
"revision": "20190701",
"rootUrl": "https://classroom.googleapis.com/",
"schemas": {
"Announcement": {
@@ -2195,7 +2195,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 specified in this\nfield 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 will be able to see the announcement."
},
"materials": {
"description": "Additional materials.\n\nAnnouncements must have no more than 20 material items.",
@@ -2382,7 +2382,7 @@
},
"teacherFolder": {
"$ref": "DriveFolder",
"description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only."
"description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain\nadministrators.\n\nRead-only."
},
"teacherGroupEmail": {
"description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",

121
etc/api/cloudasset/v1/cloudasset-api.json
View File

@@ -145,7 +145,7 @@
],
"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 Format](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/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.",
"location": "query",
"repeated": true,
"type": "string"
@@ -219,7 +219,7 @@
}
}
},
"revision": "20190327",
"revision": "20190625",
"rootUrl": "https://cloudasset.googleapis.com/",
"schemas": {
"Asset": {
@@ -238,6 +238,13 @@
"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.",
"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.",
"items": {
"$ref": "GoogleCloudOrgpolicyV1Policy"
},
"type": "array"
},
"resource": {
"$ref": "Resource",
"description": "Representation of the resource."
@@ -313,7 +320,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -334,7 +341,7 @@
"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 returned.\nSee [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/resource-manager/docs/cloud-asset-inventory/overview)\nfor all supported asset types.",
"items": {
"type": "string"
},
@@ -396,10 +403,112 @@
"uri": {
"description": "The uri of the Cloud Storage object. It's the same uri that is used by\ngsutil. For example: \"gs://bucket_name/object_name\". See [Viewing and\nEditing Object\nMetadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)\nfor more information.",
"type": "string"
},
"uriPrefix": {
"description": "The uri prefix of all generated Cloud Storage objects. For example:\n\"gs://bucket_name/object_name_prefix\". Each object uri is in format:\n\"gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only\ncontains assets for that type. <shard number> starts from 0. For example:\n\"gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0\" is\nthe first shard of output objects containing all\ncompute.googleapis.com/Disk assets. An INVALID_ARGUMENT error will be\nreturned if file with the same name \"gs://bucket_name/object_name_prefix\"\nalready exists.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudOrgpolicyV1BooleanPolicy": {
"description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
"id": "GoogleCloudOrgpolicyV1BooleanPolicy",
"properties": {
"enforced": {
"description": "If `true`, then the `Policy` is enforced. If `false`, then any\nconfiguration is acceptable.\n\nSuppose you have a `Constraint`\n`constraints/compute.disableSerialPortAccess` with `constraint_default`\nset to `ALLOW`. A `Policy` for that `Constraint` exhibits the following\nbehavior:\n - If the `Policy` at this resource has enforced set to `false`, serial\n port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial\n port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port\n connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the\n resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the\n resource hierarchy, the behavior is as if the`Policy` were set at\n this resource.\n\nThe following examples demonstrate the different possible layerings:\n\nExample 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\nThe constraint at `projects/bar` and `organizations/foo` will not be\nenforced.\n\nExample 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\nThe constraint at `organizations/foo` is not enforced.\nThe constraint at `projects/bar` is enforced.\n\nExample 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: {}}\nThe constraint at `organizations/foo` is enforced.\nThe constraint at `projects/bar` is not enforced, because\n`constraint_default` for the `Constraint` is `ALLOW`.",
"type": "boolean"
}
},
"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.",
"id": "GoogleCloudOrgpolicyV1ListPolicy",
"properties": {
"allValues": {
"description": "The policy all_values state.",
"enum": [
"ALL_VALUES_UNSPECIFIED",
"ALLOW",
"DENY"
],
"enumDescriptions": [
"Indicates that allowed_values or denied_values must be set.",
"A policy with this set allows all values.",
"A policy with this set denies all values."
],
"type": "string"
},
"allowedValues": {
"description": "List of values allowed at this resource. Can only be set if `all_values`\nis set to `ALL_VALUES_UNSPECIFIED`.",
"items": {
"type": "string"
},
"type": "array"
},
"deniedValues": {
"description": "List of values denied at this resource. Can only be set if `all_values`\nis set to `ALL_VALUES_UNSPECIFIED`.",
"items": {
"type": "string"
},
"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`.",
"type": "boolean"
},
"suggestedValue": {
"description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Policy`. If `suggested_value`\nis not set, it will inherit the value specified higher in the hierarchy,\nunless `inherit_from_parent` is `false`.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudOrgpolicyV1Policy": {
"description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.",
"id": "GoogleCloudOrgpolicyV1Policy",
"properties": {
"booleanPolicy": {
"$ref": "GoogleCloudOrgpolicyV1BooleanPolicy",
"description": "For boolean `Constraints`, whether to enforce the `Constraint` or not."
},
"constraint": {
"description": "The name of the `Constraint` the `Policy` is configuring, for example,\n`constraints/serviceuser.services`.\n\nImmutable after creation.",
"type": "string"
},
"etag": {
"description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
"format": "byte",
"type": "string"
},
"listPolicy": {
"$ref": "GoogleCloudOrgpolicyV1ListPolicy",
"description": "List of values either allowed or disallowed."
},
"restoreDefault": {
"$ref": "GoogleCloudOrgpolicyV1RestoreDefault",
"description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
},
"updateTime": {
"description": "The time stamp the `Policy` was previously updated. This is set by the\nserver, not specified by the caller, and represents the last time a call to\n`SetOrgPolicy` was made for that `Policy`. Any value set by the client will\nbe ignored.",
"format": "google-datetime",
"type": "string"
},
"version": {
"description": "Version of the `Policy`. Default version is 0;",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GoogleCloudOrgpolicyV1RestoreDefault": {
"description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.",
"id": "GoogleCloudOrgpolicyV1RestoreDefault",
"properties": {},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "Operation",
@@ -421,7 +530,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": {
@@ -513,7 +622,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": {

12
etc/api/cloudasset/v1beta1/cloudasset-api.json
View File

@@ -400,7 +400,7 @@
}
}
},
"revision": "20190327",
"revision": "20190625",
"rootUrl": "https://cloudasset.googleapis.com/",
"schemas": {
"Asset": {
@@ -494,7 +494,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -577,6 +577,10 @@
"uri": {
"description": "The uri of the Cloud Storage object. It's the same uri that is used by\ngsutil. For example: \"gs://bucket_name/object_name\". See [Viewing and\nEditing Object\nMetadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)\nfor more information.",
"type": "string"
},
"uriPrefix": {
"description": "The uri prefix of all generated Cloud Storage objects. For example:\n\"gs://bucket_name/object_name_prefix\". Each object uri is in format:\n\"gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only\ncontains assets for that type. <shard number> starts from 0. For example:\n\"gs://bucket_name/object_name_prefix/google.compute.disk/0\" is the first\nshard of output objects containing all google.compute.disk assets.\nAn INVALID_ARGUMENT error will be returned if file with the same name\n\"gs://bucket_name/object_name_prefix\" already exists.",
"type": "string"
}
},
"type": "object"
@@ -602,7 +606,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": {
@@ -694,7 +698,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": {

6
etc/api/cloudbilling/v1/cloudbilling-api.json
View File

@@ -175,7 +175,7 @@
]
},
"list": {
"description": "Lists the billing accounts that the current authenticated user has\npermission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).",
"description": "Lists the billing accounts that the current authenticated user has\npermission to\n[view](https://cloud.google.com/billing/docs/how-to/billing-access).",
"flatPath": "v1/billingAccounts",
"httpMethod": "GET",
"id": "cloudbilling.billingAccounts.list",
@@ -488,7 +488,7 @@
}
}
},
"revision": "20190314",
"revision": "20190617",
"rootUrl": "https://cloudbilling.googleapis.com/",
"schemas": {
"AggregationInfo": {
@@ -606,7 +606,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "Unimplemented. The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",

29
etc/api/cloudbuild/v1/cloudbuild-api.json
View File

@@ -573,7 +573,7 @@
}
}
},
"revision": "20190323",
"revision": "20190702",
"rootUrl": "https://cloudbuild.googleapis.com/",
"schemas": {
"ArtifactObjects": {
@@ -1051,6 +1051,13 @@
"description": "Substitutions data for Build resource.",
"type": "object"
},
"tags": {
"description": "Tags for annotation of a `BuildTrigger`",
"items": {
"type": "string"
},
"type": "array"
},
"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."
@@ -1089,12 +1096,6 @@
"properties": {},
"type": "object"
},
"CheckSuiteFilter": {
"description": "A CheckSuiteFilter is a filter that indicates that we should build on all\ncheck suite events.",
"id": "CheckSuiteFilter",
"properties": {},
"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",
@@ -1119,21 +1120,17 @@
"description": "GitHubEventsConfig describes the configuration of a trigger that creates a\nbuild whenever a GitHub event is received.\n\nThis message is experimental.",
"id": "GitHubEventsConfig",
"properties": {
"checkSuite": {
"$ref": "CheckSuiteFilter",
"description": "Output only. Indicates that a build was generated from a check suite\nevent."
},
"installationId": {
"description": "The installationID that emmits the GitHub event.",
"description": "The installationID that emits the GitHub event.",
"format": "int64",
"type": "string"
},
"name": {
"description": "Name of the repository.",
"description": "Name of the repository. For example: The name for\nhttps://github.com/googlecloudplatform/cloud-builders is \"cloud-builders\".",
"type": "string"
},
"owner": {
"description": "Owner of the repository.",
"description": "Owner of the repository. For example: The owner for\nhttps://github.com/googlecloudplatform/cloud-builders is\n\"googlecloudplatform\".",
"type": "string"
},
"pullRequest": {
@@ -1248,7 +1245,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": {
@@ -1436,7 +1433,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": {

4
etc/api/cloudbuild/v1alpha1/cloudbuild-api.json
View File

@@ -244,7 +244,7 @@
}
}
},
"revision": "20190323",
"revision": "20190702",
"rootUrl": "https://cloudbuild.googleapis.com/",
"schemas": {
"ArtifactObjects": {
@@ -990,7 +990,7 @@
"type": "string"
},
"projectId": {
"description": "The project ID of the GCP project in which the `WorkerPool` is created.",
"description": "The project ID of the GCP project for which the `WorkerPool` is created.",
"type": "string"
},
"regions": {

2
etc/api/clouddebugger/v2/clouddebugger-api.json
View File

@@ -422,7 +422,7 @@
}
}
},
"revision": "20190313",
"revision": "20190614",
"rootUrl": "https://clouddebugger.googleapis.com/",
"schemas": {
"AliasContext": {

8
etc/api/clouderrorreporting/v1beta1/clouderrorreporting-api.json
View File

@@ -204,7 +204,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 https://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/projects/example-project/events:report?key=123ABC456`",
"flatPath": "v1beta1/projects/{projectsId}/events:report",
"httpMethod": "POST",
"id": "clouderrorreporting.projects.events.report",
@@ -213,7 +213,7 @@
],
"parameters": {
"projectName": {
"description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](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/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840). Example:\n`projects/my-project-123`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
@@ -401,7 +401,7 @@
}
}
},
"revision": "20190321",
"revision": "20190626",
"rootUrl": "https://clouderrorreporting.googleapis.com/",
"schemas": {
"DeleteEventsResponse": {
@@ -634,7 +634,7 @@
"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 [`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 [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API)\nas returned by V8.\n* **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of [`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 [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of [`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": {

14
etc/api/cloudfunctions/v1/cloudfunctions-api.json
View File

@@ -539,7 +539,7 @@
}
}
},
"revision": "20190328",
"revision": "20190620",
"rootUrl": "https://cloudfunctions.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -596,7 +596,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -682,7 +682,7 @@
"type": "object"
},
"maxInstances": {
"description": "The limit on the maximum number of function instances that may coexist at a\ngiven time. This feature is currently in alpha, available only for\nwhitelisted users.",
"description": "The limit on the maximum number of function instances that may coexist at a\ngiven time.",
"format": "int32",
"type": "integer"
},
@@ -695,7 +695,7 @@
"type": "string"
},
"runtime": {
"description": "The runtime in which the function is going to run. Example values include:\n`go111`: for Go 1.11\n`nodejs6`: for Node.js 6\n`nodejs8`: for Node.js 8\n`nodejs10`: for Node.js 10\n`python37`: for Python 3.7\n`ruby25`: for Ruby 2.5\n\nIf empty, defaults to `nodejs6`.",
"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",
"type": "string"
},
"serviceAccountEmail": {
@@ -726,7 +726,7 @@
],
"enumDescriptions": [
"Not specified. Invalid state.",
"Function has been succesfully deployed and is serving.",
"Function has been successfully deployed and is serving.",
"Function deployment failed and the function isn\u2019t serving.",
"Function is being created or updated.",
"Function is being deleted.",
@@ -973,7 +973,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": {
@@ -1146,7 +1146,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": {

10
etc/api/cloudfunctions/v1beta2/cloudfunctions-api.json
View File

@@ -452,7 +452,7 @@
}
}
},
"revision": "20190328",
"revision": "20190620",
"rootUrl": "https://cloudfunctions.googleapis.com/",
"schemas": {
"CallFunctionRequest": {
@@ -525,7 +525,7 @@
"type": "string"
},
"maxInstances": {
"description": "The limit on the maximum number of function instances that may coexist at a\ngiven time. This feature is currently in alpha, available only for\nwhitelisted users.",
"description": "The limit on the maximum number of function instances that may coexist at a\ngiven time.",
"format": "int32",
"type": "integer"
},
@@ -538,7 +538,7 @@
"type": "string"
},
"runtime": {
"description": "The runtime in which the function is going to run. If empty, defaults to\nNode.js 6.",
"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",
"type": "string"
},
"serviceAccount": {
@@ -795,7 +795,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": {
@@ -937,7 +937,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": {

6
etc/api/cloudidentity/v1/cloudidentity-api.json
View File

@@ -496,7 +496,7 @@
}
}
},
"revision": "20190330",
"revision": "20190629",
"rootUrl": "https://cloudidentity.googleapis.com/",
"schemas": {
"EntityKey": {
@@ -677,7 +677,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": {
@@ -709,7 +709,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": {

6
etc/api/cloudidentity/v1beta1/cloudidentity-api.json
View File

@@ -451,7 +451,7 @@
}
}
},
"revision": "20190330",
"revision": "20190629",
"rootUrl": "https://cloudidentity.googleapis.com/",
"schemas": {
"EntityKey": {
@@ -621,7 +621,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": {
@@ -653,7 +653,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": {

263
etc/api/cloudiot/v1/cloudiot-api.json
View File

@@ -749,35 +749,6 @@
},
"groups": {
"methods": {
"bindDeviceToGateway": {
"description": "Associates the device with the gateway.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:bindDeviceToGateway",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.bindDeviceToGateway",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:bindDeviceToGateway",
"request": {
"$ref": "BindDeviceToGatewayRequest"
},
"response": {
"$ref": "BindDeviceToGatewayResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"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}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:getIamPolicy",
@@ -864,72 +835,11 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"unbindDeviceFromGateway": {
"description": "Deletes the association between the device and the gateway.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:unbindDeviceFromGateway",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.unbindDeviceFromGateway",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The name of the registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}:unbindDeviceFromGateway",
"request": {
"$ref": "UnbindDeviceFromGatewayRequest"
},
"response": {
"$ref": "UnbindDeviceFromGatewayResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
},
"resources": {
"devices": {
"methods": {
"get": {
"description": "Gets details about a device.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.groups.devices.get",
"parameterOrder": [
"name"
],
"parameters": {
"fieldMask": {
"description": "The fields of the `Device` resource to be returned in the response. If the\nfield mask is unset or empty, all fields are returned.",
"format": "google-fieldmask",
"location": "query",
"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}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"list": {
"description": "List devices in a device registry.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices",
@@ -1005,173 +915,6 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"modifyCloudToDeviceConfig": {
"description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}:modifyCloudToDeviceConfig",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.devices.modifyCloudToDeviceConfig",
"parameterOrder": [
"name"
],
"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}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:modifyCloudToDeviceConfig",
"request": {
"$ref": "ModifyCloudToDeviceConfigRequest"
},
"response": {
"$ref": "DeviceConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"patch": {
"description": "Updates a device.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}",
"httpMethod": "PATCH",
"id": "cloudiot.projects.locations.registries.groups.devices.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"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`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Device"
},
"response": {
"$ref": "Device"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
},
"sendCommandToDevice": {
"description": "Sends a command to the specified device. In order for a device to be able\nto receive commands, it must:\n1) be connected to Cloud IoT Core using the MQTT protocol, and\n2) be subscribed to the group of MQTT topics specified by\n /devices/{device-id}/commands/#. This subscription will receive commands\n at the top-level topic /devices/{device-id}/commands as well as commands\n for subfolders, like /devices/{device-id}/commands/subfolder.\n Note that subscribing to specific subfolders is not supported.\nIf the command could not be delivered to the device, this method will\nreturn an error; in particular, if the device is not subscribed, this\nmethod will return FAILED_PRECONDITION. Otherwise, this method will\nreturn OK. If the subscription is QoS 1, at least once delivery will be\nguaranteed; for QoS 0, no acknowledgment will be expected from the device.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}:sendCommandToDevice",
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.groups.devices.sendCommandToDevice",
"parameterOrder": [
"name"
],
"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}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:sendCommandToDevice",
"request": {
"$ref": "SendCommandToDeviceRequest"
},
"response": {
"$ref": "SendCommandToDeviceResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
},
"resources": {
"configVersions": {
"methods": {
"list": {
"description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}/configVersions",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.groups.devices.configVersions.list",
"parameterOrder": [
"name"
],
"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}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
},
"numVersions": {
"description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/{+name}/configVersions",
"response": {
"$ref": "ListDeviceConfigVersionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
}
},
"states": {
"methods": {
"list": {
"description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}/devices/{devicesId}/states",
"httpMethod": "GET",
"id": "cloudiot.projects.locations.registries.groups.devices.states.list",
"parameterOrder": [
"name"
],
"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}`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+/devices/[^/]+$",
"required": true,
"type": "string"
},
"numStates": {
"description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/{+name}/states",
"response": {
"$ref": "ListDeviceStatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
]
}
}
}
}
}
@@ -1184,7 +927,7 @@
}
}
},
"revision": "20190321",
"revision": "20190618",
"rootUrl": "https://cloudiot.googleapis.com/",
"schemas": {
"BindDeviceToGatewayRequest": {
@@ -1214,7 +957,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -1806,7 +1549,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": {

389
etc/api/cloudkms/v1/cloudkms-api.json
View File

@@ -252,6 +252,12 @@
"resource"
],
"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.",
"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",
@@ -278,6 +284,16 @@
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Only include resources that match the filter in the response\n(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).",
"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.",
"format": "int32",
@@ -388,6 +404,11 @@
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"required": true,
"type": "string"
},
"skipInitialVersionCreation": {
"description": "If set to true, the request will create a CryptoKey without any\nCryptoKeyVersions. You must manually call\nCreateCryptoKeyVersion or\nImportCryptoKeyVersion\nbefore you can use this CryptoKey.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/cryptoKeys",
@@ -495,6 +516,12 @@
"resource"
],
"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.",
"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",
@@ -521,6 +548,16 @@
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Only include resources that match the filter in the response\n(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).",
"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.",
"format": "int32",
@@ -852,6 +889,35 @@
"https://www.googleapis.com/auth/cloudkms"
]
},
"import": {
"description": "Imports a new CryptoKeyVersion into an existing CryptoKey using the\nwrapped key material provided in the request.\n\nThe version ID will be assigned the next sequential id within the\nCryptoKey.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions:import",
"httpMethod": "POST",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.import",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the CryptoKey to\nbe imported into.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/cryptoKeyVersions:import",
"request": {
"$ref": "ImportCryptoKeyVersionRequest"
},
"response": {
"$ref": "CryptoKeyVersion"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudkms"
]
},
"list": {
"description": "Lists CryptoKeyVersions.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
@@ -861,6 +927,16 @@
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Only include resources that match the filter in the response\n(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).",
"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.",
"format": "int32",
@@ -968,6 +1044,66 @@
},
"importJobs": {
"methods": {
"create": {
"description": "Create a new ImportJob within a KeyRing.\n\nImportJob.import_method is required.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs",
"httpMethod": "POST",
"id": "cloudkms.projects.locations.keyRings.importJobs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"importJobId": {
"description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the KeyRing associated with the\nImportJobs.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/importJobs",
"request": {
"$ref": "ImportJob"
},
"response": {
"$ref": "ImportJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudkms"
]
},
"get": {
"description": "Returns metadata for a given ImportJob.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs/{importJobsId}",
"httpMethod": "GET",
"id": "cloudkms.projects.locations.keyRings.importJobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the ImportJob to get.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/importJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ImportJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudkms"
]
},
"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}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs/{importJobsId}:getIamPolicy",
@@ -977,6 +1113,12 @@
"resource"
],
"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.",
"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",
@@ -994,6 +1136,53 @@
"https://www.googleapis.com/auth/cloudkms"
]
},
"list": {
"description": "Lists ImportJobs.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs",
"httpMethod": "GET",
"id": "cloudkms.projects.locations.keyRings.importJobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional. Only include resources that match the filter in the response\n(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).",
"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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional pagination token, returned earlier via\nListImportJobsResponse.next_page_token.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/importJobs",
"response": {
"$ref": "ListImportJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudkms"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/importJobs/{importJobsId}:setIamPolicy",
@@ -1061,7 +1250,7 @@
}
}
},
"revision": "20190328",
"revision": "20190626",
"rootUrl": "https://cloudkms.googleapis.com/",
"schemas": {
"AsymmetricDecryptRequest": {
@@ -1165,7 +1354,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -1227,7 +1416,7 @@
"type": "string"
},
"rotationPeriod": {
"description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.\n\nKeys with purpose\nENCRYPT_DECRYPT support\nautomatic rotation. For other keys, this field must be omitted.",
"description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least 24 hours and at most\n876,000 hours.\n\nIf rotation_period is set, next_rotation_time must also be set.\n\nKeys with purpose\nENCRYPT_DECRYPT support\nautomatic rotation. For other keys, this field must be omitted.",
"format": "google-duration",
"type": "string"
},
@@ -1306,6 +1495,19 @@
"format": "google-datetime",
"type": "string"
},
"importFailureReason": {
"description": "Output only. The root cause of an import failure. Only present if\nstate is\nIMPORT_FAILED.",
"type": "string"
},
"importJob": {
"description": "Output only. The name of the ImportJob used to import this\nCryptoKeyVersion. Only present if the underlying key material was\nimported.",
"type": "string"
},
"importTime": {
"description": "Output only. The time at which this CryptoKeyVersion's key material\nwas imported.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
"type": "string"
@@ -1332,7 +1534,9 @@
"ENABLED",
"DISABLED",
"DESTROYED",
"DESTROY_SCHEDULED"
"DESTROY_SCHEDULED",
"PENDING_IMPORT",
"IMPORT_FAILED"
],
"enumDescriptions": [
"Not specified.",
@@ -1340,7 +1544,9 @@
"This version may be used for cryptographic operations.",
"This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
"This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
"This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
"This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state.",
"This version is still being imported. It may not be used, enabled,\ndisabled, or destroyed yet. Cloud KMS will automatically mark this\nversion ENABLED as soon as the version is ready.",
"This version was not imported successfully. It may not be used, enabled,\ndisabled, or destroyed. The submitted key material has been discarded.\nAdditional details can be found in\nCryptoKeyVersion.import_failure_reason."
],
"type": "string"
}
@@ -1521,6 +1727,145 @@
},
"type": "object"
},
"ImportCryptoKeyVersionRequest": {
"description": "Request message for KeyManagementService.ImportCryptoKeyVersion.",
"id": "ImportCryptoKeyVersionRequest",
"properties": {
"algorithm": {
"description": "Required. The algorithm of\nthe key being imported. This does not need to match the\nversion_template of the CryptoKey this\nversion imports into.",
"enum": [
"CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED",
"GOOGLE_SYMMETRIC_ENCRYPTION",
"RSA_SIGN_PSS_2048_SHA256",
"RSA_SIGN_PSS_3072_SHA256",
"RSA_SIGN_PSS_4096_SHA256",
"RSA_SIGN_PSS_4096_SHA512",
"RSA_SIGN_PKCS1_2048_SHA256",
"RSA_SIGN_PKCS1_3072_SHA256",
"RSA_SIGN_PKCS1_4096_SHA256",
"RSA_SIGN_PKCS1_4096_SHA512",
"RSA_DECRYPT_OAEP_2048_SHA256",
"RSA_DECRYPT_OAEP_3072_SHA256",
"RSA_DECRYPT_OAEP_4096_SHA256",
"RSA_DECRYPT_OAEP_4096_SHA512",
"EC_SIGN_P256_SHA256",
"EC_SIGN_P384_SHA384"
],
"enumDescriptions": [
"Not specified.",
"Creates symmetric encryption keys.",
"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.",
"RSAES-OAEP 2048 bit key with a SHA256 digest.",
"RSAES-OAEP 3072 bit key with a SHA256 digest.",
"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."
],
"type": "string"
},
"importJob": {
"description": "Required. The name of the ImportJob that was used to\nwrap this key material.",
"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.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"ImportJob": {
"description": "An ImportJob can be used to create CryptoKeys and\nCryptoKeyVersions using pre-existing key material,\ngenerated outside of Cloud KMS.\n\nWhen an ImportJob is created, Cloud KMS will generate a \"wrapping key\",\nwhich is a public/private key pair. You use the wrapping key to encrypt (also\nknown as wrap) the pre-existing key material to protect it during the import\nprocess. The nature of the wrapping key depends on the choice of\nimport_method. When the wrapping key generation\nis complete, the state will be set to\nACTIVE and the public_key\ncan be fetched. The fetched public key can then be used to wrap your\npre-existing key material.\n\nOnce the key material is wrapped, it can be imported into a new\nCryptoKeyVersion in an existing CryptoKey by calling\nImportCryptoKeyVersion.\nMultiple CryptoKeyVersions can be imported with a single\nImportJob. Cloud KMS uses the private key portion of the wrapping key to\nunwrap the key material. Only Cloud KMS has access to the private key.\n\nAn ImportJob expires 3 days after it is created. Once expired, Cloud KMS\nwill no longer be able to import or unwrap any key material that was wrapped\nwith the ImportJob's public key.\n\nFor more information, see\n[Importing a key](https://cloud.google.com/kms/docs/importing-a-key).",
"id": "ImportJob",
"properties": {
"attestation": {
"$ref": "KeyOperationAttestation",
"description": "Output only. Statement that was generated and signed by the key creator\n(for example, an HSM) at key creation time. Use this statement to verify\nattributes of the key as stored on the HSM, independently of Google.\nOnly present if the chosen ImportMethod is one with a protection\nlevel of HSM."
},
"createTime": {
"description": "Output only. The time at which this ImportJob was created.",
"format": "google-datetime",
"type": "string"
},
"expireEventTime": {
"description": "Output only. The time this ImportJob expired. Only present if\nstate is EXPIRED.",
"format": "google-datetime",
"type": "string"
},
"expireTime": {
"description": "Output only. The time at which this ImportJob is scheduled for\nexpiration and can no longer be used to import key material.",
"format": "google-datetime",
"type": "string"
},
"generateTime": {
"description": "Output only. The time this ImportJob's key material was generated.",
"format": "google-datetime",
"type": "string"
},
"importMethod": {
"description": "Required and immutable. The wrapping method to be used for incoming\nkey material.",
"enum": [
"IMPORT_METHOD_UNSPECIFIED",
"RSA_OAEP_3072_SHA1_AES_256",
"RSA_OAEP_4096_SHA1_AES_256"
],
"enumDescriptions": [
"Not specified.",
"This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping\nscheme defined in the PKCS #11 standard. In summary, this involves\nwrapping the raw key with an ephemeral AES key, and wrapping the\nephemeral AES key with a 3072 bit RSA key. For more details, see\n[RSA AES key wrap\nmechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908).",
"This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping\nscheme defined in the PKCS #11 standard. In summary, this involves\nwrapping the raw key with an ephemeral AES key, and wrapping the\nephemeral AES key with a 4096 bit RSA key. For more details, see\n[RSA AES key wrap\nmechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908)."
],
"type": "string"
},
"name": {
"description": "Output only. The resource name for this ImportJob in the format\n`projects/*/locations/*/keyRings/*/importJobs/*`.",
"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.",
"enum": [
"PROTECTION_LEVEL_UNSPECIFIED",
"SOFTWARE",
"HSM"
],
"enumDescriptions": [
"Not specified.",
"Crypto operations are performed in software.",
"Crypto operations are performed in a Hardware Security Module."
],
"type": "string"
},
"publicKey": {
"$ref": "WrappingPublicKey",
"description": "Output only. The public key with which to wrap key material prior to\nimport. Only returned if state is\nACTIVE."
},
"state": {
"description": "Output only. The current state of the ImportJob, indicating if it can\nbe used.",
"enum": [
"IMPORT_JOB_STATE_UNSPECIFIED",
"PENDING_GENERATION",
"ACTIVE",
"EXPIRED"
],
"enumDescriptions": [
"Not specified.",
"The wrapping key for this job is still being generated. It may not be\nused. Cloud KMS will automatically mark this job as\nACTIVE as soon as the wrapping key is generated.",
"This job may be used in\nCreateCryptoKey and\nCreateCryptoKeyVersion\nrequests.",
"This job can no longer be used and may not leave this state once entered."
],
"type": "string"
}
},
"type": "object"
},
"KeyOperationAttestation": {
"description": "Contains an HSM-generated attestation about a key operation. For more\ninformation, see [Verifying attestations]\n(https://cloud.google.com/kms/docs/attest-key).",
"id": "KeyOperationAttestation",
@@ -1609,6 +1954,29 @@
},
"type": "object"
},
"ListImportJobsResponse": {
"description": "Response message for KeyManagementService.ListImportJobs.",
"id": "ListImportJobsResponse",
"properties": {
"importJobs": {
"description": "The list of ImportJobs.",
"items": {
"$ref": "ImportJob"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in\nListImportJobsRequest.page_token to retrieve the next page of results.",
"type": "string"
},
"totalSize": {
"description": "The total number of ImportJobs that matched the query.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ListKeyRingsResponse": {
"description": "Response message for KeyManagementService.ListKeyRings.",
"id": "ListKeyRingsResponse",
@@ -1837,6 +2205,17 @@
}
},
"type": "object"
},
"WrappingPublicKey": {
"description": "The public key component of the wrapping key. For details of the type of\nkey this public key corresponds to, see the ImportMethod.",
"id": "WrappingPublicKey",
"properties": {
"pem": {
"description": "The public key, encoded in PEM format. For more information, see the [RFC\n7468](https://tools.ietf.org/html/rfc7468) sections for [General\nConsiderations](https://tools.ietf.org/html/rfc7468#section-2) and\n[Textual Encoding of Subject Public Key Info]\n(https://tools.ietf.org/html/rfc7468#section-13).",
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",

4
etc/api/cloudprivatecatalog/v1beta1/cloudprivatecatalog-api.json
View File

@@ -14,7 +14,7 @@
"canonicalName": "Cloud Private Catalog",
"description": "Enable cloud users to discover enterprise catalogs and products in their organizations.",
"discoveryVersion": "v1",
"documentationLink": "https://sites.google.com/corp/google.com/cloudprivatecatalog",
"documentationLink": "https://cloud.google.com/private-catalog/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -522,7 +522,7 @@
}
}
},
"revision": "20190330",
"revision": "20190622",
"rootUrl": "https://cloudprivatecatalog.googleapis.com/",
"schemas": {
"GoogleCloudPrivatecatalogV1beta1Catalog": {

10
etc/api/cloudprivatecatalogproducer/v1beta1/cloudprivatecatalogproducer-api.json
View File

@@ -14,7 +14,7 @@
"canonicalName": "Cloud PrivateCatalog Producer",
"description": "Enables cloud users to manage and share enterprise catalogs intheir organizations.",
"discoveryVersion": "v1",
"documentationLink": "https://sites.google.com/corp/google.com/cloudprivatecatalog",
"documentationLink": "https://cloud.google.com/private-catalog/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -967,7 +967,7 @@
}
}
},
"revision": "20190330",
"revision": "20190622",
"rootUrl": "https://cloudprivatecatalogproducer.googleapis.com/",
"schemas": {
"GoogleCloudPrivatecatalogproducerV1beta1Association": {
@@ -1259,7 +1259,7 @@
"properties": {
"condition": {
"$ref": "GoogleTypeExpr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -1395,7 +1395,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": {
@@ -1416,7 +1416,7 @@
"type": "object"
},
"GoogleRpcStatus": {
"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": "GoogleRpcStatus",
"properties": {
"code": {

2
etc/api/cloudprofiler/v2/cloudprofiler-api.json
View File

@@ -215,7 +215,7 @@
}
}
},
"revision": "20190330",
"revision": "20190629",
"rootUrl": "https://cloudprofiler.googleapis.com/",
"schemas": {
"CreateProfileRequest": {

33
etc/api/cloudresourcemanager/v1/cloudresourcemanager-api.json
View File

@@ -940,14 +940,14 @@
]
},
"list": {
"description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the\nGetProject method.",
"description": "Lists Projects that the caller has the `resourcemanager.projects.get`\npermission on and satisfy the specified filter.\n\nThis method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the\nGetProject method.\n\nNOTE: If the request filter contains a `parent.type` and `parent.id` and\nthe caller has the `resourcemanager.projects.list` permission on the\nparent, the results will be drawn from an alternate index which provides\nmore consistent results. In future versions of this API, this List method\nwill be split into List and Search to properly capture the behavorial\ndifference.",
"flatPath": "v1/projects",
"httpMethod": "GET",
"id": "cloudresourcemanager.projects.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ <code>labels.<em>key</em></code> where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red&nbsp;labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
"description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ `labels.<key>` (where *key* is the name of a label)\n+ `parent.type`\n+ `parent.id`\n\nSome examples of using labels as filters:\n\n| Filter | Description |\n|------------------|-----------------------------------------------------|\n| name:how* | The project's name starts with \"how\". |\n| name:Howl | The project's name is `Howl` or `howl`. |\n| name:HOWL | Equivalent to above. |\n| NAME:howl | Equivalent to above. |\n| labels.color:* | The project has the label `color`. |\n| labels.color:red | The project's label `color` has the value `red`. |\n| labels.color:red&nbsp;labels.size:big |The project's label `color` has\n the value `red` and its label `size` has the value `big`. |\n\nIf no filter is specified, the call will return projects for which the user\nhas the `resourcemanager.projects.get` permission.\n\nNOTE: To perform a by-parent query (eg., what projects are directly in a\nFolder), the caller must have the `resourcemanager.projects.list`\npermission on the parent and the filter must contain both a `parent.type`\nand a `parent.id` restriction\n(example: \"parent.type:folder parent.id:123\"). In this case an alternate\nsearch index is used which provides more consistent results.\n\nOptional.",
"location": "query",
"type": "string"
},
@@ -1170,7 +1170,7 @@
}
}
},
"revision": "20190401",
"revision": "20190701",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"Ancestor": {
@@ -1238,7 +1238,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -1464,7 +1464,12 @@
"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"
},
"GetOrgPolicyRequest": {
@@ -1478,6 +1483,18 @@
},
"type": "object"
},
"GetPolicyOptions": {
"description": "Encapsulates settings provided to GetIamPolicy.",
"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.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Lien": {
"description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource.",
"id": "Lien",
@@ -1696,7 +1713,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": {
@@ -1926,7 +1943,7 @@
"id": "SearchOrganizationsRequest",
"properties": {
"filter": {
"description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a G Suite domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
"description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a G Suite domain, for example:\n\n* Filter `owner.directorycustomerid:123456789` returns Organization\nresources with `owner.directory_customer_id` equal to `123456789`.\n* Filter `domain:google.com` returns Organization resources corresponding\nto the domain `google.com`.\n\nThis field is optional.",
"type": "string"
},
"pageSize": {
@@ -1987,7 +2004,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": {

31
etc/api/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
View File

@@ -177,7 +177,7 @@
"parameterOrder": [],
"parameters": {
"filter": {
"description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a G Suite domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
"description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a G Suite domain, for example:\n\n* Filter `owner.directorycustomerid:123456789` returns Organization\nresources with `owner.directory_customer_id` equal to `123456789`.\n* Filter `domain:google.com` returns Organization resources corresponding\nto the domain `google.com`.\n\nThis field is optional.",
"location": "query",
"type": "string"
},
@@ -316,7 +316,7 @@
]
},
"delete": {
"description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if it has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
"description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if it has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject\nand ListProjects\nmethods.\n\nThe caller must have modify permissions for this Project.",
"flatPath": "v1beta1/projects/{projectId}",
"httpMethod": "DELETE",
"id": "cloudresourcemanager.projects.delete",
@@ -421,14 +421,14 @@
]
},
"list": {
"description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the GetProjectmethod.",
"description": "Lists Projects that the caller has the `resourcemanager.projects.get`\npermission on and satisfy the specified filter.\n\nThis method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the\nGetProject method.\n\nNOTE: If the request filter contains a `parent.type` and `parent.id` and\nthe caller has the `resourcemanager.projects.list` permission on the\nparent, the results will be drawn from an alternate index which provides\nmore consistent results. In future versions of this API, this List method\nwill be split into List and Search to properly capture the behavorial\ndifference.",
"flatPath": "v1beta1/projects",
"httpMethod": "GET",
"id": "cloudresourcemanager.projects.list",
"parameterOrder": [],
"parameters": {
"filter": {
"description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ <code>labels.<em>key</em></code> where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red&nbsp;labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.",
"description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ `labels.<key>` (where *key* is the name of a label)\n+ `parent.type`\n+ `parent.id`\n\nSome examples of using labels as filters:\n\n| Filter | Description |\n|------------------|-----------------------------------------------------|\n| name:how* | The project's name starts with \"how\". |\n| name:Howl | The project's name is `Howl` or `howl`. |\n| name:HOWL | Equivalent to above. |\n| NAME:howl | Equivalent to above. |\n| labels.color:* | The project has the label `color`. |\n| labels.color:red | The project's label `color` has the value `red`. |\n| labels.color:red&nbsp;labels.size:big |The project's label `color` has\n the value `red` and its label `size` has the value `big`. |\n\nIf no filter is specified, the call will return projects for which the user\nhas the `resourcemanager.projects.get` permission.\n\nNOTE: To perform a by-parent query (eg., what projects are directly in a\nFolder), the caller must have the `resourcemanager.projects.list`\npermission on the parent and the filter must contain both a `parent.type`\nand a `parent.id` restriction\n(example: \"parent.type:folder parent.id:123\"). In this case an alternate\nsearch index is used which provides more consistent results.\n\nOptional.",
"location": "query",
"type": "string"
},
@@ -565,7 +565,7 @@
}
}
},
"revision": "20190401",
"revision": "20190701",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"Ancestor": {
@@ -633,7 +633,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -769,7 +769,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.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ListOrganizationsResponse": {

31
etc/api/cloudresourcemanager/v2/cloudresourcemanager-api.json
View File

@@ -449,7 +449,7 @@
}
}
},
"revision": "20190401",
"revision": "20190701",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -506,7 +506,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -559,7 +559,7 @@
"type": "string"
},
"lifecycleState": {
"description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
"description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
"enum": [
"LIFECYCLE_STATE_UNSPECIFIED",
"ACTIVE",
@@ -654,7 +654,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.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ListFoldersResponse": {
@@ -707,7 +724,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": {
@@ -786,7 +803,7 @@
"type": "string"
},
"query": {
"description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nThe displayName field in a query expression should use escaped quotes\nfor values that include whitespace to prevent unexpected behavior.\n\nSome example queries are:\n\n|Query | Description|\n|----- | -----------|\n|displayName=Test* | Folders whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.|\n|parent=folders/123 | Folders whose parent is \"folders/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose parent\nis \"folders/123\".| |displayName=\\\\\"Test String\\\\\"|Folders whose display\nname includes both \"Test\" and \"String\".|",
"description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nThe displayName field in a query expression should use escaped quotes\nfor values that include whitespace to prevent unexpected behavior.\n\nSome example queries are:\n\n* Query `displayName=Test*` returns Folder resources whose display name\nstarts with \"Test\".\n* Query `lifecycleState=ACTIVE` returns Folder resources with\n`lifecycleState` set to `ACTIVE`.\n* Query `parent=folders/123` returns Folder resources that have\n`folders/123` as a parent resource.\n* Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active\nFolder resources that have `folders/123` as a parent resource.\n* Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with\ndisplay names that include both \"Test\" and \"String\".",
"type": "string"
}
},
@@ -827,7 +844,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": {

31
etc/api/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
View File

@@ -449,7 +449,7 @@
}
}
},
"revision": "20190401",
"revision": "20190701",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"schemas": {
"AuditConfig": {
@@ -506,7 +506,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -559,7 +559,7 @@
"type": "string"
},
"lifecycleState": {
"description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
"description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
"enum": [
"LIFECYCLE_STATE_UNSPECIFIED",
"ACTIVE",
@@ -654,7 +654,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.\nAcceptable values are 0 and 1.\nIf the value is 0, or the field is omitted, policy format version 1 will be\nreturned.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ListFoldersResponse": {
@@ -707,7 +724,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": {
@@ -786,7 +803,7 @@
"type": "string"
},
"query": {
"description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nThe displayName field in a query expression should use escaped quotes\nfor values that include whitespace to prevent unexpected behavior.\n\nSome example queries are:\n\n|Query | Description|\n|----- | -----------|\n|displayName=Test* | Folders whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.|\n|parent=folders/123 | Folders whose parent is \"folders/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose parent\nis \"folders/123\".| |displayName=\\\\\"Test String\\\\\"|Folders whose display\nname includes both \"Test\" and \"String\".|",
"description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nThe displayName field in a query expression should use escaped quotes\nfor values that include whitespace to prevent unexpected behavior.\n\nSome example queries are:\n\n* Query `displayName=Test*` returns Folder resources whose display name\nstarts with \"Test\".\n* Query `lifecycleState=ACTIVE` returns Folder resources with\n`lifecycleState` set to `ACTIVE`.\n* Query `parent=folders/123` returns Folder resources that have\n`folders/123` as a parent resource.\n* Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active\nFolder resources that have `folders/123` as a parent resource.\n* Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with\ndisplay names that include both \"Test\" and \"String\".",
"type": "string"
}
},
@@ -827,7 +844,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": {

872
etc/api/cloudscheduler/v1/cloudscheduler-api.json Normal file
View File

@@ -0,0 +1,872 @@
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudscheduler.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Scheduler",
"description": "Creates and manages jobs run on a regular recurring schedule.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/scheduler/",
"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": "cloudscheduler:v1",
"kind": "discovery#restDescription",
"name": "cloudscheduler",
"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": {
"get": {
"description": "Gets information about a location.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"httpMethod": "GET",
"id": "cloudscheduler.projects.locations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name for the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Location"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists information about the supported locations for this service.",
"flatPath": "v1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "cloudscheduler.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"jobs": {
"methods": {
"create": {
"description": "Creates a job.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs",
"httpMethod": "POST",
"id": "cloudscheduler.projects.locations.jobs.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required.\n\nThe location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/jobs",
"request": {
"$ref": "Job"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a job.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}",
"httpMethod": "DELETE",
"id": "cloudscheduler.projects.locations.jobs.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets a job.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}",
"httpMethod": "GET",
"id": "cloudscheduler.projects.locations.jobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists jobs.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs",
"httpMethod": "GET",
"id": "cloudscheduler.projects.locations.jobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Requested page size.\n\nThe maximum page size is 500. If unspecified, the page size will\nbe the maximum. Fewer jobs than requested might be returned,\neven if more jobs exist; use next_page_token to determine if more\njobs exist.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server will return. To\nrequest the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nnext_page_token returned from\nthe previous call to ListJobs. It is an error to\nswitch the value of filter or\norder_by while iterating through pages.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required.\n\nThe location name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/jobs",
"response": {
"$ref": "ListJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a job.\n\nIf successful, the updated Job is returned. If the job does\nnot exist, `NOT_FOUND` is returned.\n\nIf UpdateJob does not successfully return, it is possible for the\njob to be in an Job.State.UPDATE_FAILED state. A job in this state may\nnot be executed. If this happens, retry the UpdateJob request\nuntil a successful response is received.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}",
"httpMethod": "PATCH",
"id": "cloudscheduler.projects.locations.jobs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Optionally caller-specified in CreateJob, after\nwhich it becomes output only.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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 job'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* `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), or underscores (_). The maximum length is 500 characters.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "A mask used to specify which fields of the job are being updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Job"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"pause": {
"description": "Pauses a job.\n\nIf a job is paused then the system will stop executing the job\nuntil it is re-enabled via ResumeJob. The\nstate of the job is stored in state; if paused it\nwill be set to Job.State.PAUSED. A job must be in Job.State.ENABLED\nto be paused.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:pause",
"httpMethod": "POST",
"id": "cloudscheduler.projects.locations.jobs.pause",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:pause",
"request": {
"$ref": "PauseJobRequest"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"resume": {
"description": "Resume a job.\n\nThis method reenables a job after it has been Job.State.PAUSED. The\nstate of a job is stored in Job.state; after calling this method it\nwill be set to Job.State.ENABLED. A job must be in\nJob.State.PAUSED to be resumed.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:resume",
"httpMethod": "POST",
"id": "cloudscheduler.projects.locations.jobs.resume",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:resume",
"request": {
"$ref": "ResumeJobRequest"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"run": {
"description": "Forces a job to run now.\n\nWhen this method is called, Cloud Scheduler will dispatch the job, even\nif the job is already running.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:run",
"httpMethod": "POST",
"id": "cloudscheduler.projects.locations.jobs.run",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:run",
"request": {
"$ref": "RunJobRequest"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20190617",
"rootUrl": "https://cloudscheduler.googleapis.com/",
"schemas": {
"AppEngineHttpTarget": {
"description": "App Engine target. The job will be pushed to a job handler by means\nof an HTTP request via an http_method such\nas HTTP POST, HTTP GET, etc. The job is acknowledged by means of an\nHTTP response code in the range [200 - 299]. Error 503 is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error 503 will be retried regardless of\nretry configuration and not counted against retry counts. Any other\nresponse code, or a failure to receive a response before the\ndeadline, constitutes a failed attempt.",
"id": "AppEngineHttpTarget",
"properties": {
"appEngineRouting": {
"$ref": "AppEngineRouting",
"description": "App Engine Routing setting for the job."
},
"body": {
"description": "Body.\n\nHTTP request body. A request body is allowed only if the HTTP method is\nPOST or PUT. It will result in invalid argument error to set a body on a\njob 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. Headers can be set\nwhen the job is created.\n\nCloud Scheduler 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 Scheduler will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n* `X-CloudScheduler`: This header will be set to true.\n\nIf the job has an body, Cloud Scheduler sets\nthe 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 explictly\n setting `Content-Type` to a particular media type when the job is\n created.\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Scheduler. This value is\n output only. It cannot be changed.\n\nThe headers below are output only. They cannot be set or overridden:\n\n* `X-Google-*`: For Google internal use only.\n* `X-AppEngine-*`: For Google internal use only.\n\nIn addition, some App Engine headers, which contain\njob-specific information, are also be sent to the job handler.",
"type": "object"
},
"httpMethod": {
"description": "The HTTP method to use for the request. PATCH and OPTIONS are not\npermitted.",
"enum": [
"HTTP_METHOD_UNSPECIFIED",
"POST",
"GET",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"enumDescriptions": [
"HTTP method unspecified. Defaults to POST.",
"HTTP POST",
"HTTP GET",
"HTTP HEAD",
"HTTP PUT",
"HTTP DELETE",
"HTTP PATCH",
"HTTP OPTIONS"
],
"type": "string"
},
"relativeUri": {
"description": "The relative URI.\n\nThe relative URL must begin with \"/\" and must be a valid HTTP relative URL.\nIt can contain a path, query string arguments, and `#` fragments.\nIf the relative URL is empty, then the root path \"/\" will be used.\nNo spaces are allowed, and the maximum length allowed is 2083 characters.",
"type": "string"
}
},
"type": "object"
},
"AppEngineRouting": {
"description": "App Engine Routing.\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).",
"id": "AppEngineRouting",
"properties": {
"host": {
"description": "Output only. The host that the job is sent to.\n\nFor more information about how App Engine requests are routed, see\n[here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).\n\nThe host is constructed as:\n\n\n* `host = [application_domain_name]`</br>\n `| [service] + '.' + [application_domain_name]`</br>\n `| [version] + '.' + [application_domain_name]`</br>\n `| [version_dot_service]+ '.' + [application_domain_name]`</br>\n `| [instance] + '.' + [application_domain_name]`</br>\n `| [instance_dot_service] + '.' + [application_domain_name]`</br>\n `| [instance_dot_version] + '.' + [application_domain_name]`</br>\n `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`\n\n* `application_domain_name` = The domain name of the app, for\n example <app-id>.appspot.com, which is associated with the\n job's project ID.\n\n* `service =` service\n\n* `version =` version\n\n* `version_dot_service =`\n version `+ '.' +`\n service\n\n* `instance =` instance\n\n* `instance_dot_service =`\n instance `+ '.' +`\n service\n\n* `instance_dot_version =`\n instance `+ '.' +`\n version\n\n* `instance_dot_version_dot_service =`\n instance `+ '.' +`\n version `+ '.' +`\n service\n\n\nIf service is empty, then the job will be sent\nto the service which is the default service when the job is attempted.\n\nIf version is empty, then the job will be sent\nto the version which is the default version when the job is attempted.\n\nIf instance is empty, then the job will be\nsent to an instance which is available when the job is attempted.\n\nIf service,\nversion, or\ninstance is invalid, then the job will be sent\nto the default version of the default service when the job is attempted.",
"type": "string"
},
"instance": {
"description": "App instance.\n\nBy default, the job is sent to an instance which is available when\nthe job is attempted.\n\nRequests can only be sent to a specific instance if\n[manual scaling is used in App Engine\nStandard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).\nApp Engine Flex does not support instances. For more information, see\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).",
"type": "string"
},
"service": {
"description": "App service.\n\nBy default, the job is sent to the service which is the default\nservice when the job is attempted.",
"type": "string"
},
"version": {
"description": "App version.\n\nBy default, the job is sent to the version which is the default\nversion when the job is attempted.",
"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"
},
"HttpTarget": {
"description": "Http target. The job will be pushed to the job handler by means of\nan HTTP request via an http_method such as HTTP\nPOST, HTTP GET, etc. The job is acknowledged by means of an HTTP\nresponse code in the range [200 - 299]. A failure to receive a response\nconstitutes a failed execution. For a redirected request, the response\nreturned by the redirected request is considered.",
"id": "HttpTarget",
"properties": {
"body": {
"description": "HTTP request body. A request body is allowed only if the HTTP\nmethod is POST, PUT, or PATCH. It is an error to set body on a job with an\nincompatible HttpMethod.",
"format": "byte",
"type": "string"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"description": "The user can specify HTTP request headers to send with the job's\nHTTP request. This map contains the header field names and\nvalues. Repeated headers are not supported, but a header value can\ncontain commas. These headers represent a subset of the headers\nthat will accompany the job's HTTP request. Some HTTP request\nheaders will be ignored or replaced. A partial list of headers that\nwill be ignored or replaced is below:\n- Host: This will be computed by Cloud Scheduler and derived from\nuri.\n* `Content-Length`: This will be computed by Cloud Scheduler.\n* `User-Agent`: This will be set to `\"Google-Cloud-Scheduler\"`.\n* `X-Google-*`: Google internal use only.\n* `X-AppEngine-*`: Google internal use only.\n\nThe total size of headers must be less than 80KB.",
"type": "object"
},
"httpMethod": {
"description": "Which HTTP method to use for the request.",
"enum": [
"HTTP_METHOD_UNSPECIFIED",
"POST",
"GET",
"HEAD",
"PUT",
"DELETE",
"PATCH",
"OPTIONS"
],
"enumDescriptions": [
"HTTP method unspecified. Defaults to POST.",
"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."
},
"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.",
"type": "string"
}
},
"type": "object"
},
"Job": {
"description": "Configuration for a job.\nThe maximum allowed size for a job is 100KB.",
"id": "Job",
"properties": {
"appEngineHttpTarget": {
"$ref": "AppEngineHttpTarget",
"description": "App Engine HTTP target."
},
"attemptDeadline": {
"description": "The deadline for job attempts. If the request handler does not respond by\nthis deadline then the request is cancelled and the attempt is marked as a\n`DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in\nexecution logs. Cloud Scheduler will retry the job according\nto the RetryConfig.\n\nThe allowed duration for this deadline is:\n* For HTTP targets, between 15 seconds and 30 minutes.\n* For App Engine HTTP targets, between 15\n seconds and 24 hours.",
"format": "google-duration",
"type": "string"
},
"description": {
"description": "Optionally caller-specified in CreateJob or\nUpdateJob.\n\nA human-readable description for the job. This string must not contain\nmore than 500 characters.",
"type": "string"
},
"httpTarget": {
"$ref": "HttpTarget",
"description": "HTTP target."
},
"lastAttemptTime": {
"description": "Output only. The time the last job attempt started.",
"format": "google-datetime",
"type": "string"
},
"name": {
"description": "Optionally caller-specified in CreateJob, after\nwhich it becomes output only.\n\nThe job name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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 job'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* `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), or underscores (_). The maximum length is 500 characters.",
"type": "string"
},
"pubsubTarget": {
"$ref": "PubsubTarget",
"description": "Pub/Sub target."
},
"retryConfig": {
"$ref": "RetryConfig",
"description": "Settings that determine the retry behavior."
},
"schedule": {
"description": "Required, except when used with UpdateJob.\n\nDescribes the schedule on which the job will be executed.\n\nThe schedule can be either of the following types:\n\n* [Crontab](http://en.wikipedia.org/wiki/Cron#Overview)\n* English-like\n[schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)\n\nAs a general rule, execution `n + 1` of a job will not begin\nuntil execution `n` has finished. Cloud Scheduler will never\nallow two simultaneously outstanding executions. For example,\nthis implies that if the `n+1`th execution is scheduled to run at\n16:00 but the `n`th execution takes until 16:15, the `n+1`th\nexecution will not start until `16:15`.\nA scheduled start time will be delayed if the previous\nexecution has not ended when its scheduled time occurs.\n\nIf retry_count > 0 and a job attempt fails,\nthe job will be tried a total of retry_count\ntimes, with exponential backoff, until the next scheduled start\ntime.",
"type": "string"
},
"scheduleTime": {
"description": "Output only. The next time the job is scheduled. Note that this may be a\nretry of a previously failed attempt or the next execution time\naccording to the schedule.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "Output only. State of the job.",
"enum": [
"STATE_UNSPECIFIED",
"ENABLED",
"PAUSED",
"DISABLED",
"UPDATE_FAILED"
],
"enumDescriptions": [
"Unspecified state.",
"The job is executing normally.",
"The job is paused by the user. It will not execute. A user can\nintentionally pause the job using\nPauseJobRequest.",
"The job is disabled by the system due to error. The user\ncannot directly set a job to be disabled.",
"The job state resulting from a failed CloudScheduler.UpdateJob\noperation. To recover a job from this state, retry\nCloudScheduler.UpdateJob until a successful response is received."
],
"type": "string"
},
"status": {
"$ref": "Status",
"description": "Output only. The response from the target for the last attempted execution."
},
"timeZone": {
"description": "Specifies the time zone to be used in interpreting\nschedule. The value of this field must be a time\nzone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database).\n\nNote that some time zones include a provision for\ndaylight savings time. The rules for daylight saving time are\ndetermined by the chosen tz. For UTC use the string \"utc\". If a\ntime zone is not specified, the default will be in UTC (also known\nas GMT).",
"type": "string"
},
"userUpdateTime": {
"description": "Output only. The creation time of the job.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"ListJobsResponse": {
"description": "Response message for listing jobs using ListJobs.",
"id": "ListJobsResponse",
"properties": {
"jobs": {
"description": "The list of jobs.",
"items": {
"$ref": "Job"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in the\npage_token field in the subsequent call to\nListJobs to retrieve the next page of results.\nIf this is empty it indicates that there are no more results\nthrough which to paginate.\n\nThe page token is valid for only 2 hours.",
"type": "string"
}
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"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 job. The caller\nmust have iam.serviceAccounts.actAs permission for the service account.",
"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 job. The caller\nmust have iam.serviceAccounts.actAs permission for the service account.",
"type": "string"
}
},
"type": "object"
},
"PauseJobRequest": {
"description": "Request message for PauseJob.",
"id": "PauseJobRequest",
"properties": {},
"type": "object"
},
"PubsubMessage": {
"description": "A message that is published by publishers and consumed by subscribers. The\nmessage must contain either a non-empty data field or at least one attribute.\nNote that client libraries represent this object differently\ndepending on the language. See the corresponding\n<a href=\"https://cloud.google.com/pubsub/docs/reference/libraries\">client\nlibrary documentation</a> for more information. See\n<a href=\"https://cloud.google.com/pubsub/quotas\">Quotas and limits</a>\nfor more information about message limits.",
"id": "PubsubMessage",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Optional attributes for this message.",
"type": "object"
},
"data": {
"description": "The message data field. If this field is empty, the message must contain\nat least one attribute.",
"format": "byte",
"type": "string"
},
"messageId": {
"description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
"type": "string"
},
"publishTime": {
"description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"PubsubTarget": {
"description": "Pub/Sub target. The job will be delivered by publishing a message to\nthe given Pub/Sub topic.",
"id": "PubsubTarget",
"properties": {
"attributes": {
"additionalProperties": {
"type": "string"
},
"description": "Attributes for PubsubMessage.\n\nPubsub message must contain either non-empty data, or at least one\nattribute.",
"type": "object"
},
"data": {
"description": "The message payload for PubsubMessage.\n\nPubsub message must contain either non-empty data, or at least one\nattribute.",
"format": "byte",
"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.",
"type": "string"
}
},
"type": "object"
},
"ResumeJobRequest": {
"description": "Request message for ResumeJob.",
"id": "ResumeJobRequest",
"properties": {},
"type": "object"
},
"RetryConfig": {
"description": "Settings that determine the retry behavior.\n\nBy default, if a job does not complete successfully (meaning that\nan acknowledgement is not received from the handler, then it will be retried\nwith exponential backoff according to the settings in RetryConfig.",
"id": "RetryConfig",
"properties": {
"maxBackoffDuration": {
"description": "The maximum amount of time to wait before retrying a job after\nit fails.\n\nThe default value of this field is 1 hour.",
"format": "google-duration",
"type": "string"
},
"maxDoublings": {
"description": "The time between retries will double `max_doublings` times.\n\nA job's retry interval starts at\nmin_backoff_duration, then doubles\n`max_doublings` times, then increases linearly, and finally\nretries retries at intervals of\nmax_backoff_duration up to\nretry_count times.\n\nFor example, if min_backoff_duration is\n10s, max_backoff_duration is 300s, and\n`max_doublings` is 3, then the a job will first be retried in 10s. The\nretry interval will double three times, and then increase linearly by\n2^3 * 10s. Finally, the job will retry at intervals of\nmax_backoff_duration until the job has\nbeen attempted retry_count times. Thus, the\nrequests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....\n\nThe default value of this field is 5.",
"format": "int32",
"type": "integer"
},
"maxRetryDuration": {
"description": "The time limit for retrying a failed job, measured from time when an\nexecution was first attempted. If specified with\nretry_count, the job will be retried until both\nlimits are reached.\n\nThe default value for max_retry_duration is zero, which means retry\nduration is unlimited.",
"format": "google-duration",
"type": "string"
},
"minBackoffDuration": {
"description": "The minimum amount of time to wait before retrying a job after\nit fails.\n\nThe default value of this field is 5 seconds.",
"format": "google-duration",
"type": "string"
},
"retryCount": {
"description": "The number of attempts that the system will make to run a job using the\nexponential backoff procedure described by\nmax_doublings.\n\nThe default value of retry_count is zero.\n\nIf retry_count is zero, a job attempt will *not* be retried if\nit fails. Instead the Cloud Scheduler system will wait for the\nnext scheduled execution time.\n\nIf retry_count is set to a non-zero number then Cloud Scheduler\nwill retry failed attempts, using exponential backoff,\nretry_count times, or until the next scheduled execution time,\nwhichever comes first.\n\nValues greater than 5 and negative values are not allowed.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RunJobRequest": {
"description": "Request message for forcing a job to run now using\nRunJob.",
"id": "RunJobRequest",
"properties": {},
"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": "Cloud Scheduler API",
"version": "v1",
"version_module": true
}

12
etc/api/cloudscheduler/v1beta1/cloudscheduler-api.json
View File

@@ -417,7 +417,7 @@
}
}
},
"revision": "20190326",
"revision": "20190617",
"rootUrl": "https://cloudscheduler.googleapis.com/",
"schemas": {
"AppEngineHttpTarget": {
@@ -542,11 +542,11 @@
},
"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 be used when sending requests to a GCP\nendpoint."
"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 should be used when sending requests to third\nparty endpoints."
"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.",
@@ -707,7 +707,7 @@
"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 be used when sending requests to a GCP\nendpoint.",
"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": {
@@ -722,7 +722,7 @@
"type": "object"
},
"OidcToken": {
"description": "Contains information needed for generating an\n[OpenID Connect\ntoken](https://developers.google.com/identity/protocols/OpenIDConnect). This\ntype of authorization should be used when sending requests to third party\nendpoints.",
"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": {
@@ -838,7 +838,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": {

74
etc/api/cloudsearch/v1/cloudsearch-api.json
View File

@@ -38,7 +38,7 @@
"canonicalName": "Cloud Search",
"description": "Cloud Search provides cloud-based search capabilities over G Suite data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search.",
"discoveryVersion": "v1",
"documentationLink": "https://gsuite.google.com/products/cloud-search/",
"documentationLink": "https://developers.google.com/cloud-search/docs/guides/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -144,7 +144,7 @@
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -211,7 +211,7 @@
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -263,7 +263,7 @@
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -317,7 +317,7 @@
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -382,7 +382,7 @@
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -414,7 +414,7 @@
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -485,7 +485,7 @@
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -566,7 +566,7 @@
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -636,7 +636,7 @@
"type": "string"
},
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -926,12 +926,12 @@
"type": "string"
},
"requestOptions.debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
"requestOptions.languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.\nFor translations.",
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.\nFor translations.\n\nWhen specified, the documents in search results are biased towards the\nspecified language.\nSuggest API does not use this parameter. It autocompletes only based on\ncharacters in the query.",
"location": "query",
"type": "string"
},
@@ -993,7 +993,7 @@
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -1025,7 +1025,7 @@
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -1055,7 +1055,7 @@
"parameterOrder": [],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -1145,7 +1145,7 @@
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -1177,7 +1177,7 @@
],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -1207,7 +1207,7 @@
"parameterOrder": [],
"parameters": {
"debugOptions.enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"location": "query",
"type": "boolean"
},
@@ -1429,7 +1429,7 @@
}
}
},
"revision": "20190328",
"revision": "20190622",
"rootUrl": "https://cloudsearch.googleapis.com/",
"schemas": {
"BooleanOperatorOptions": {
@@ -1580,7 +1580,7 @@
"id": "DataSourceRestriction",
"properties": {
"filterOptions": {
"description": "Filter options restricting the results. If multiple filters\nare present, they are grouped by object type before joining.\nFilters with the same object type are joined conjunctively, then\nthe resulting expressions are joined disjunctively.\n\nThe maximum number of elements is 20.",
"description": "Filter options restricting the results. If multiple filters\nare present, they are grouped by object type before joining.\nFilters with the same object type are joined conjunctively, then\nthe resulting expressions are joined disjunctively.\n\nThe maximum number of elements is 20.\n\nNOTE: Suggest API supports only few filters at the moment:\n \"objecttype\", \"type\" and \"mimetype\".\nFor now, schema specific filters cannot be used to filter suggestions.",
"items": {
"$ref": "FilterOptions"
},
@@ -1663,7 +1663,7 @@
"id": "DebugOptions",
"properties": {
"enableDebugging": {
"description": "If set, the request will enable debugging features of Cloud Search.\nOnly turn on this field, if asked by Google to help with debugging.",
"description": "If you are asked by Google to help with debugging, set this field.\nOtherwise, ignore this field.",
"type": "boolean"
}
},
@@ -2923,7 +2923,7 @@
"id": "Metaline",
"properties": {
"properties": {
"description": "The list of displayed properties for the metaline.",
"description": "The list of displayed properties for the metaline. The maxiumum number of\nproperties is 5.",
"items": {
"$ref": "DisplayedProperty"
},
@@ -3008,7 +3008,7 @@
"id": "ObjectDisplayOptions",
"properties": {
"metalines": {
"description": "Defines the properties that will be displayed in the metalines of the\nsearch results. The property values will be displayed in the order given\nhere. If a property holds multiple values, all of the values will be\ndiplayed before the next properties. For this reason, it is a good practice\nto specify singular properties before repeated properties in this list. All\nof the properties must set\nis_returnable\nto true. The maximum number of elements is 3.",
"description": "Defines the properties that will be displayed in the metalines of the\nsearch results. The property values will be displayed in the order given\nhere. If a property holds multiple values, all of the values will be\ndiplayed before the next properties. For this reason, it is a good practice\nto specify singular properties before repeated properties in this list. All\nof the properties must set\nis_returnable\nto true. The maximum number of metalines is 3.",
"items": {
"$ref": "Metaline"
},
@@ -3084,7 +3084,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": {
@@ -3099,7 +3099,7 @@
"type": "object"
},
"PeopleSuggestion": {
"description": "A people suggestion.",
"description": "This field contains information about the person being suggested.",
"id": "PeopleSuggestion",
"properties": {
"person": {
@@ -3309,6 +3309,10 @@
"description": "Indicates that the property can be used for sorting. Cannot be true for\nproperties that are repeatable. Cannot be true for properties whose type\nis object or user identifier. IsReturnable must be true to set this option.\nOnly supported for Boolean, Date, Double, Integer, and Timestamp\nproperties.",
"type": "boolean"
},
"isWildcardSearchable": {
"description": "Indicates that users can perform wildcard search for this\nproperty. Only supported for Text properties. IsReturnable must be true to\nset this option. In a given datasource maximum of 5 properties can be\nmarked as is_wildcard_searchable.\n\nNote: This is an alpha feature and is enabled for whitelisted users only.",
"type": "boolean"
},
"name": {
"description": "The name of the property. Item indexing requests sent to the Indexing API\nshould set the property name\nequal to this value. For example, if name is *subject_line*, then indexing\nrequests for document items with subject fields should set the\nname for that field equal to\n*subject_line*. Use the name as the identifier for the object property.\nOnce registered as a property for an object, you cannot re-use this name\nfor another property within that object.\nThe name must start with a letter and can only contain letters (A-Z, a-z)\nor numbers (0-9).\nThe maximum length is 256 characters.",
"type": "string"
@@ -3552,7 +3556,7 @@
"type": "object"
},
"QuerySuggestion": {
"description": "A completed query suggestion.",
"description": "This field does not contain anything as of now and is just used as an\nindicator that the suggest result was a phrase completion.",
"id": "QuerySuggestion",
"properties": {},
"type": "object"
@@ -3610,7 +3614,7 @@
"description": "Debug options of the request"
},
"languageCode": {
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.\nFor translations.",
"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.\nFor translations.\n\nWhen specified, the documents in search results are biased towards the\nspecified language.\nSuggest API does not use this parameter. It autocompletes only based on\ncharacters in the query.",
"type": "string"
},
"searchApplicationId": {
@@ -4056,7 +4060,7 @@
"type": "string"
},
"url": {
"description": "The URL of the search result. The URL contains a Google redirect to the\nactual item.",
"description": "The URL of the search result. The URL contains a Google redirect to the\nactual item. This URL is signed and shouldn't be changed.",
"type": "string"
}
},
@@ -4255,7 +4259,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": {
@@ -4311,14 +4315,14 @@
"id": "SuggestRequest",
"properties": {
"dataSourceRestrictions": {
"description": "The sources to use for suggestions. If not specified, all data sources\nfrom the current search application are used.",
"description": "The sources to use for suggestions. If not specified, all data sources\nfrom the current search application are used.\nSuggestions are based on Gmail titles. Suggestions from third party sources\nare not available.",
"items": {
"$ref": "DataSourceRestriction"
},
"type": "array"
},
"query": {
"description": "Partial query for the completion suggestion.",
"description": "Partial query for which autocomplete suggestions will be shown.\nFor example, if the query is \"sea\", then the server might return\n\"season\", \"search\", \"seagull\" and so on.",
"type": "string"
},
"requestOptions": {
@@ -4333,7 +4337,7 @@
"id": "SuggestResponse",
"properties": {
"suggestResults": {
"description": "List of suggestion results.",
"description": "List of suggestions.",
"items": {
"$ref": "SuggestResult"
},
@@ -4347,10 +4351,12 @@
"id": "SuggestResult",
"properties": {
"peopleSuggestion": {
"$ref": "PeopleSuggestion"
"$ref": "PeopleSuggestion",
"description": "This is present when the suggestion indicates a person. It\ncontains more information about the person - like their email ID,\nname etc."
},
"querySuggestion": {
"$ref": "QuerySuggestion"
"$ref": "QuerySuggestion",
"description": "This field will be present if the suggested query is a word/phrase\ncompletion."
},
"source": {
"$ref": "Source",

6
etc/api/cloudshell/v1/cloudshell-api.json
View File

@@ -228,7 +228,7 @@
}
}
},
"revision": "20190330",
"revision": "20190701",
"rootUrl": "https://cloudshell.googleapis.com/",
"schemas": {
"CancelOperationRequest": {
@@ -337,7 +337,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": {
@@ -422,7 +422,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": {

6
etc/api/cloudshell/v1alpha1/cloudshell-api.json
View File

@@ -287,7 +287,7 @@
}
}
},
"revision": "20190330",
"revision": "20190701",
"rootUrl": "https://cloudshell.googleapis.com/",
"schemas": {
"AuthorizeEnvironmentRequest": {
@@ -403,7 +403,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": {
@@ -499,7 +499,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": {

22
etc/api/cloudtasks/v2/cloudtasks-api.json
View File

@@ -179,7 +179,7 @@
"queues": {
"methods": {
"create": {
"description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)\nbefore using this method.",
"description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues",
"httpMethod": "POST",
"id": "cloudtasks.projects.locations.queues.create",
@@ -207,7 +207,7 @@
]
},
"delete": {
"description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)\nbefore using this method.",
"description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
"httpMethod": "DELETE",
"id": "cloudtasks.projects.locations.queues.delete",
@@ -294,7 +294,7 @@
],
"parameters": {
"filter": {
"description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).\n\nSample filter \"state: PAUSED\".\n\nNote that using filters might cause fewer queues than the\nrequested page_size to be returned.",
"description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs\nFilters](https://cloud.google.com/logging/docs/view/advanced_filters).\n\nSample filter \"state: PAUSED\".\n\nNote that using filters might cause fewer queues than the\nrequested page_size to be returned.",
"location": "query",
"type": "string"
},
@@ -326,7 +326,7 @@
]
},
"patch": {
"description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)\nbefore using this method.",
"description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
"httpMethod": "PATCH",
"id": "cloudtasks.projects.locations.queues.patch",
@@ -416,7 +416,7 @@
]
},
"resume": {
"description": "Resume a queue.\n\nThis method resumes a queue after it has been\nPAUSED or\nDISABLED. The state of a queue is stored\nin the queue's state; after calling this method it\nwill be set to RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).",
"description": "Resume a queue.\n\nThis method resumes a queue after it has been\nPAUSED or\nDISABLED. The state of a queue is stored\nin the queue's state; after calling this method it\nwill be set to RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling\nRisks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
"httpMethod": "POST",
"id": "cloudtasks.projects.locations.queues.resume",
@@ -504,7 +504,7 @@
"tasks": {
"methods": {
"create": {
"description": "Creates a task and adds it to a queue.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* For App Engine queues, the maximum task size is\n 100KB.",
"description": "Creates a task and adds it to a queue.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* The maximum task size is 100KB.",
"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
"httpMethod": "POST",
"id": "cloudtasks.projects.locations.queues.tasks.create",
@@ -601,7 +601,7 @@
],
"parameters": {
"pageSize": {
"description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nnext_page_token in the\nresponse to determine if more tasks exist.",
"description": "Maximum page size.\n\nFewer tasks than requested might be returned, even if more tasks exist; use\nnext_page_token in the response to\ndetermine if more tasks exist.\n\nThe maximum page size is 1000. If unspecified, the page size will be the\nmaximum.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -674,11 +674,11 @@
}
}
},
"revision": "20190326",
"revision": "20190618",
"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\nThis proto can only be used for tasks in a queue which has\napp_engine_http_queue set.\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\nan HTTP response code in the range [`200` - `299`]. `503` is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error `503` will be retried regardless of\nretry configuration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.",
"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.",
"id": "AppEngineHttpRequest",
"properties": {
"appEngineRouting": {
@@ -783,7 +783,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -1120,7 +1120,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": {

22
etc/api/cloudtasks/v2beta2/cloudtasks-api.json
View File

@@ -179,7 +179,7 @@
"queues": {
"methods": {
"create": {
"description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)\nbefore using this method.",
"description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.",
"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
"httpMethod": "POST",
"id": "cloudtasks.projects.locations.queues.create",
@@ -207,7 +207,7 @@
]
},
"delete": {
"description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)\nbefore using this method.",
"description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.",
"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
"httpMethod": "DELETE",
"id": "cloudtasks.projects.locations.queues.delete",
@@ -294,7 +294,7 @@
],
"parameters": {
"filter": {
"description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.",
"description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs\nFilters](https://cloud.google.com/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.",
"location": "query",
"type": "string"
},
@@ -326,7 +326,7 @@
]
},
"patch": {
"description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)\nbefore using this method.",
"description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.",
"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
"httpMethod": "PATCH",
"id": "cloudtasks.projects.locations.queues.patch",
@@ -416,7 +416,7 @@
]
},
"resume": {
"description": "Resume a queue.\n\nThis method resumes a queue after it has been\nPAUSED or\nDISABLED. The state of a queue is stored\nin the queue's state; after calling this method it\nwill be set to RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).",
"description": "Resume a queue.\n\nThis method resumes a queue after it has been\nPAUSED or\nDISABLED. The state of a queue is stored\nin the queue's state; after calling this method it\nwill be set to RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling\nRisks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).",
"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
"httpMethod": "POST",
"id": "cloudtasks.projects.locations.queues.resume",
@@ -685,7 +685,7 @@
],
"parameters": {
"pageSize": {
"description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nnext_page_token in the\nresponse to determine if more tasks exist.",
"description": "Maximum page size.\n\nFewer tasks than requested might be returned, even if more tasks exist; use\nnext_page_token in the response to\ndetermine if more tasks exist.\n\nThe maximum page size is 1000. If unspecified, the page size will be the\nmaximum.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -786,7 +786,7 @@
}
}
},
"revision": "20190326",
"revision": "20190618",
"rootUrl": "https://cloudtasks.googleapis.com/",
"schemas": {
"AcknowledgeTaskRequest": {
@@ -802,7 +802,7 @@
"type": "object"
},
"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\nThis proto can only be used for tasks in a queue which has\napp_engine_http_target set.\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_url\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\nan HTTP response code in the range [`200` - `299`]. `503` is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error `503` will be retried regardless of\nretry configuration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.",
"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\nThis proto can only be used for tasks in a queue which has\napp_engine_http_target set.\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_url\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": {
@@ -914,7 +914,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -1025,7 +1025,7 @@
"type": "string"
},
"leaseDuration": {
"description": "\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.\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.",
"format": "google-duration",
"type": "string"
},
@@ -1387,7 +1387,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": {

131
etc/api/cloudtasks/v2beta3/cloudtasks-api.json
View File

@@ -179,7 +179,7 @@
"queues": {
"methods": {
"create": {
"description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)\nbefore using this method.",
"description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.",
"flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/queues",
"httpMethod": "POST",
"id": "cloudtasks.projects.locations.queues.create",
@@ -207,7 +207,7 @@
]
},
"delete": {
"description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)\nbefore using this method.",
"description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.",
"flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
"httpMethod": "DELETE",
"id": "cloudtasks.projects.locations.queues.delete",
@@ -294,7 +294,7 @@
],
"parameters": {
"filter": {
"description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).\n\nSample filter \"state: PAUSED\".\n\nNote that using filters might cause fewer queues than the\nrequested page_size to be returned.",
"description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs\nFilters](https://cloud.google.com/logging/docs/view/advanced_filters).\n\nSample filter \"state: PAUSED\".\n\nNote that using filters might cause fewer queues than the\nrequested page_size to be returned.",
"location": "query",
"type": "string"
},
@@ -326,7 +326,7 @@
]
},
"patch": {
"description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)\nbefore using this method.",
"description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.",
"flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
"httpMethod": "PATCH",
"id": "cloudtasks.projects.locations.queues.patch",
@@ -416,7 +416,7 @@
]
},
"resume": {
"description": "Resume a queue.\n\nThis method resumes a queue after it has been\nPAUSED or\nDISABLED. The state of a queue is stored\nin the queue's state; after calling this method it\nwill be set to RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).",
"description": "Resume a queue.\n\nThis method resumes a queue after it has been\nPAUSED or\nDISABLED. The state of a queue is stored\nin the queue's state; after calling this method it\nwill be set to RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling\nRisks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).",
"flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
"httpMethod": "POST",
"id": "cloudtasks.projects.locations.queues.resume",
@@ -504,7 +504,7 @@
"tasks": {
"methods": {
"create": {
"description": "Creates a task and adds it to a queue.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* For App Engine queues, the maximum task size is\n 100KB.",
"description": "Creates a task and adds it to a queue.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* The maximum task size is 100KB.",
"flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
"httpMethod": "POST",
"id": "cloudtasks.projects.locations.queues.tasks.create",
@@ -601,7 +601,7 @@
],
"parameters": {
"pageSize": {
"description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nnext_page_token in the\nresponse to determine if more tasks exist.",
"description": "Maximum page size.\n\nFewer tasks than requested might be returned, even if more tasks exist; use\nnext_page_token in the response to\ndetermine if more tasks exist.\n\nThe maximum page size is 1000. If unspecified, the page size will be the\nmaximum.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -674,7 +674,7 @@
}
}
},
"revision": "20190326",
"revision": "20190618",
"rootUrl": "https://cloudtasks.googleapis.com/",
"schemas": {
"AppEngineHttpQueue": {
@@ -689,7 +689,7 @@
"type": "object"
},
"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\nThis proto can only be used for tasks in a queue which has\napp_engine_http_queue set.\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\nan HTTP response code in the range [`200` - `299`]. `503` is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error `503` will be retried regardless of\nretry configuration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.",
"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.",
"id": "AppEngineHttpRequest",
"properties": {
"appEngineRouting": {
@@ -794,7 +794,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -870,6 +870,61 @@
"properties": {},
"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).",
"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": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
@@ -958,6 +1013,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",
@@ -1000,7 +1085,7 @@
"properties": {
"appEngineHttpQueue": {
"$ref": "AppEngineHttpQueue",
"description": "AppEngineHttpQueue settings apply only to\nApp Engine tasks in this queue."
"description": "AppEngineHttpQueue settings apply only to\nApp Engine tasks in this queue.\nHttp tasks are not affected by this proto."
},
"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.",
@@ -1019,6 +1104,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": [
@@ -1130,8 +1219,20 @@
},
"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). 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": {
@@ -1176,7 +1277,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"
},
@@ -1184,6 +1285,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 task's target.\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."

2
etc/api/cloudtrace/v1/cloudtrace-api.json
View File

@@ -250,7 +250,7 @@
}
}
},
"revision": "20190326",
"revision": "20190622",
"rootUrl": "https://cloudtrace.googleapis.com/",
"schemas": {
"Empty": {

4
etc/api/cloudtrace/v2/cloudtrace-api.json
View File

@@ -180,7 +180,7 @@
}
}
},
"revision": "20190326",
"revision": "20190622",
"rootUrl": "https://cloudtrace.googleapis.com/",
"schemas": {
"Annotation": {
@@ -495,7 +495,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": {

458
etc/api/commentanalyzer/v1alpha1/commentanalyzer-api.json Normal file
View File

@@ -0,0 +1,458 @@
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/userinfo.email": {
"description": "View your email address"
}
}
}
},
"basePath": "",
"baseUrl": "https://commentanalyzer.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Comment Analyzer",
"description": "The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the \"toxicity\" of a comment). Users can leverage the \"SuggestCommentScore\" method to submit corrections to improve Perspective over time. Users can set the \"doNotStore\" flag to ensure that all submitted comments are automatically deleted after scores are returned.",
"discoveryVersion": "v1",
"documentationLink": "https://github.com/conversationai/perspectiveapi/blob/master/README.md",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "commentanalyzer:v1alpha1",
"kind": "discovery#restDescription",
"name": "commentanalyzer",
"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": {
"comments": {
"methods": {
"analyze": {
"description": "Analyzes the provided text and returns scores for requested attributes.",
"flatPath": "v1alpha1/comments:analyze",
"httpMethod": "POST",
"id": "commentanalyzer.comments.analyze",
"parameterOrder": [],
"parameters": {},
"path": "v1alpha1/comments:analyze",
"request": {
"$ref": "AnalyzeCommentRequest"
},
"response": {
"$ref": "AnalyzeCommentResponse"
},
"scopes": [
"https://www.googleapis.com/auth/userinfo.email"
]
},
"suggestscore": {
"description": "Suggest comment scores as training data.",
"flatPath": "v1alpha1/comments:suggestscore",
"httpMethod": "POST",
"id": "commentanalyzer.comments.suggestscore",
"parameterOrder": [],
"parameters": {},
"path": "v1alpha1/comments:suggestscore",
"request": {
"$ref": "SuggestCommentScoreRequest"
},
"response": {
"$ref": "SuggestCommentScoreResponse"
},
"scopes": [
"https://www.googleapis.com/auth/userinfo.email"
]
}
}
}
},
"revision": "20190616",
"rootUrl": "https://commentanalyzer.googleapis.com/",
"schemas": {
"AnalyzeCommentRequest": {
"description": "The comment analysis request message.",
"id": "AnalyzeCommentRequest",
"properties": {
"clientToken": {
"description": "Opaque token that is echoed from the request to the response.",
"type": "string"
},
"comment": {
"$ref": "TextEntry",
"description": "The comment to analyze."
},
"communityId": {
"description": "Optional identifier associating this AnalyzeCommentRequest with a\nparticular client's community. Different communities may have different\nnorms and rules. Specifying this value enables us to explore building\ncommunity-specific models for clients.",
"type": "string"
},
"context": {
"$ref": "Context",
"description": "The context of the comment."
},
"doNotStore": {
"description": "Do not store the comment or context sent in this request. By default, the\nservice may store comments/context for debugging purposes.",
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"requestedAttributes": {
"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.",
"type": "object"
},
"sessionId": {
"description": "Session ID. Used to join related RPCs into a single session. For example,\nan interactive tool that calls both the AnalyzeComment and\nSuggestCommentScore RPCs should set all invocations of both RPCs to the\nsame Session ID, typically a random 64-bit integer.",
"type": "string"
},
"spanAnnotations": {
"description": "An advisory parameter that will return span annotations if the model\nis capable of providing scores with sub-comment resolution. This will\nlikely increase the size of the returned message.",
"type": "boolean"
}
},
"type": "object"
},
"AnalyzeCommentResponse": {
"description": "The comment analysis response message.",
"id": "AnalyzeCommentResponse",
"properties": {
"attributeScores": {
"additionalProperties": {
"$ref": "AttributeScores"
},
"description": "Scores for the requested attributes. The map keys are attribute names (same\nas the requested_attribute field in AnalyzeCommentRequest, for example\n\"ATTACK_ON_AUTHOR\", \"INFLAMMATORY\", etc).",
"type": "object"
},
"clientToken": {
"description": "Same token from the original AnalyzeCommentRequest.",
"type": "string"
},
"detectedLanguages": {
"description": "Contains the languages detected from the text content, sorted in order of\nlikelihood.",
"items": {
"type": "string"
},
"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",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ArticleAndParentComment": {
"description": "A type of context specific to a comment left on a single-threaded comment\nmessage board, where comments are either a top level comment or the child of\na top level comment.",
"id": "ArticleAndParentComment",
"properties": {
"article": {
"$ref": "TextEntry",
"description": "The source content about which the comment was made (article text, article\nsummary, video transcript, etc)."
},
"parentComment": {
"$ref": "TextEntry",
"description": "Refers to text that is a direct parent of the source comment, such as in a\none-deep threaded message board. This field will only be present for\ncomments that are replies to other comments and will not be populated for\ndirect comments on the article_text."
}
},
"type": "object"
},
"AttributeParameters": {
"description": "Configurable parameters for attribute scoring.",
"id": "AttributeParameters",
"properties": {
"scoreThreshold": {
"description": "Don't return scores for this attribute that are below this threshold. If\nunset, a default threshold will be applied. A FloatValue wrapper is used to\ndistinguish between 0 vs. default/unset.",
"format": "float",
"type": "number"
},
"scoreType": {
"description": "What type of scores to return. If unset, defaults to probability scores.",
"enum": [
"SCORE_TYPE_UNSPECIFIED",
"PROBABILITY",
"STD_DEV_SCORE",
"PERCENTILE",
"RAW"
],
"enumDescriptions": [
"Unspecified. Defaults to PROBABILITY scores if available, and otherwise\nRAW. Every model has a RAW score.",
"Probability scores are in the range [0, 1] and indicate level of confidence\nin the attribute label.",
"Standard deviation scores are in the range (-inf, +inf).",
"Percentile scores are in the range [0, 1] and indicate the percentile of\nthe raw score, normalized with a test dataset. This is not generally\nrecommended, as the normalization is dependent on the dataset used, which\nmay not match other usecases.",
"Raw scores are the raw values from the model, and may take any value. This\nis primarily for debugging/testing, and not generally recommended."
],
"type": "string"
}
},
"type": "object"
},
"AttributeScores": {
"description": "This holds score values for a single attribute. It contains both per-span\nscores as well as an overall summary score..",
"id": "AttributeScores",
"properties": {
"spanScores": {
"description": "Per-span scores.",
"items": {
"$ref": "SpanScore"
},
"type": "array"
},
"summaryScore": {
"$ref": "Score",
"description": "Overall score for comment as a whole."
}
},
"type": "object"
},
"Context": {
"description": "Context is typically something that a Comment is referencing or replying to\n(such as an article, or previous comment).\nNote: Populate only ONE OF the following fields. The oneof syntax cannot be\nused because that would require nesting entries inside another message and\nbreaking backwards compatibility. The server will return an error if more\nthan one of the following fields is present.",
"id": "Context",
"properties": {
"articleAndParentComment": {
"$ref": "ArticleAndParentComment",
"description": "Information about the source for which the original comment was made, and\nany parent comment info."
},
"entries": {
"description": "A list of messages. For example, a linear comments section or forum thread.",
"items": {
"$ref": "TextEntry"
},
"type": "array"
}
},
"type": "object"
},
"Score": {
"description": "Analysis scores are described by a value and a ScoreType.",
"id": "Score",
"properties": {
"type": {
"description": "The type of the above value.",
"enum": [
"SCORE_TYPE_UNSPECIFIED",
"PROBABILITY",
"STD_DEV_SCORE",
"PERCENTILE",
"RAW"
],
"enumDescriptions": [
"Unspecified. Defaults to PROBABILITY scores if available, and otherwise\nRAW. Every model has a RAW score.",
"Probability scores are in the range [0, 1] and indicate level of confidence\nin the attribute label.",
"Standard deviation scores are in the range (-inf, +inf).",
"Percentile scores are in the range [0, 1] and indicate the percentile of\nthe raw score, normalized with a test dataset. This is not generally\nrecommended, as the normalization is dependent on the dataset used, which\nmay not match other usecases.",
"Raw scores are the raw values from the model, and may take any value. This\nis primarily for debugging/testing, and not generally recommended."
],
"type": "string"
},
"value": {
"description": "Score value. Semantics described by type below.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"SpanScore": {
"description": "This is a single score for a given span of text.",
"id": "SpanScore",
"properties": {
"begin": {
"description": "\"begin\" and \"end\" describe the span of the original text that the attribute\nscore applies to. The values are the UTF-16 codepoint range. \"end\" is\nexclusive. For example, with the text \"Hi there\", the begin/end pair (0,2)\ndescribes the text \"Hi\".\n\nIf \"begin\" and \"end\" are unset, the score applies to the full text.",
"format": "int32",
"type": "integer"
},
"end": {
"format": "int32",
"type": "integer"
},
"score": {
"$ref": "Score",
"description": "The score value."
}
},
"type": "object"
},
"SuggestCommentScoreRequest": {
"description": "The comment score suggestion request message.",
"id": "SuggestCommentScoreRequest",
"properties": {
"attributeScores": {
"additionalProperties": {
"$ref": "AttributeScores"
},
"description": "Attribute scores for the comment. The map keys are attribute names, same as\nthe requested_attribute field in AnalyzeCommentRequest (for example\n\"ATTACK_ON_AUTHOR\", \"INFLAMMATORY\", etc.). This field has the same type as\nthe `attribute_scores` field in AnalyzeCommentResponse.\n\nTo specify an overall attribute score for the entire comment as a whole,\nuse the `summary_score` field of the mapped AttributeScores object. To\nspecify scores on specific subparts of the comment, use the `span_scores`\nfield. All SpanScore objects must have begin and end fields set.\n\nAll Score objects must be explicitly set (for binary classification, use\nthe score values 0 and 1). If Score objects don't include a ScoreType,\n`PROBABILITY` is assumed.\n\n`attribute_scores` must not be empty. The mapped AttributeScores objects\nalso must not be empty. An `INVALID_ARGUMENT` error is returned for all\nmalformed requests.",
"type": "object"
},
"clientToken": {
"description": "Opaque token that is echoed from the request to the response.",
"type": "string"
},
"comment": {
"$ref": "TextEntry",
"description": "The comment being scored."
},
"communityId": {
"description": "Optional identifier associating this comment score suggestion with a\nparticular sub-community. Different communities may have different norms\nand rules. Specifying this value enables training community-specific\nmodels.",
"type": "string"
},
"context": {
"$ref": "Context",
"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.",
"items": {
"type": "string"
},
"type": "array"
},
"sessionId": {
"description": "Session ID. Used to join related RPCs into a single session. For example,\nan interactive tool that calls both the AnalyzeComment and\nSuggestCommentScore RPCs should set all invocations of both RPCs to the\nsame Session ID, typically a random 64-bit integer.",
"type": "string"
}
},
"type": "object"
},
"SuggestCommentScoreResponse": {
"description": "The comment score suggestion response message.",
"id": "SuggestCommentScoreResponse",
"properties": {
"clientToken": {
"description": "Same token from the original SuggestCommentScoreRequest.",
"type": "string"
},
"detectedLanguages": {
"description": "The list of languages detected from the comment text.",
"items": {
"type": "string"
},
"type": "array"
},
"requestedLanguages": {
"description": "The list of languages provided in the request.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TextEntry": {
"description": "Represents a body of text.",
"id": "TextEntry",
"properties": {
"text": {
"description": "UTF-8 encoded text.",
"type": "string"
},
"type": {
"description": "Type of the text field.",
"enum": [
"TEXT_TYPE_UNSPECIFIED",
"PLAIN_TEXT",
"HTML"
],
"enumDescriptions": [
"The content type is not specified. Text will be interpreted as plain text\nby default.",
"Plain text.",
"HTML."
],
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Perspective Comment Analyzer API",
"version": "v1alpha1",
"version_module": true
}

24
etc/api/composer/v1/composer-api.json
View File

File diff suppressed because one or more lines are too long

24
etc/api/composer/v1beta1/composer-api.json
View File

File diff suppressed because one or more lines are too long

2951
etc/api/compute/alpha/compute-api.json
View File

File diff suppressed because it is too large Load Diff

4032
etc/api/compute/beta/compute-api.json
View File

File diff suppressed because it is too large Load Diff

2624
etc/api/compute/v1/compute-api.json
View File

File diff suppressed because it is too large Load Diff

318
etc/api/container/v1/container-api.json
View File

@@ -106,10 +106,59 @@
"resources": {
"projects": {
"resources": {
"aggregated": {
"resources": {
"usableSubnetworks": {
"methods": {
"list": {
"description": "Lists subnetworks that are usable for creating clusters in a project.",
"flatPath": "v1/projects/{projectsId}/aggregated/usableSubnetworks",
"httpMethod": "GET",
"id": "container.projects.aggregated.usableSubnetworks.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Filtering currently only supports equality on the networkProjectId and must\nbe in the form: \"networkProjectId=[PROJECTID]\", where `networkProjectId`\nis the project which owns the listed subnetworks. This defaults to the\nparent project ID.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The max number of results per page that should be returned. If the number\nof available results is larger than `page_size`, a `next_page_token` is\nreturned which can be used to get the next page of results in subsequent\nrequests. Acceptable values are 0 to 500, inclusive. (Default: 500)",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Specifies a page token to use. Set this to the nextPageToken returned by\nprevious list requests to get the next page of results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "The parent project where subnetworks are usable.\nSpecified in the format 'projects/*'.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/aggregated/usableSubnetworks",
"response": {
"$ref": "ListUsableSubnetworksResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"locations": {
"methods": {
"getServerConfig": {
"description": "Returns configuration info about the Kubernetes Engine service.",
"description": "Returns configuration info about the Google Kubernetes Engine service.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serverConfig",
"httpMethod": "GET",
"id": "container.projects.locations.getServerConfig",
@@ -176,7 +225,7 @@
]
},
"create": {
"description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
"description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe Kubelet creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range the cluster is using.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.create",
@@ -204,7 +253,7 @@
]
},
"delete": {
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster,\nsuch as load balancer resources, are not deleted if they weren't present\nwhen the cluster was initially created.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
"httpMethod": "DELETE",
"id": "container.projects.locations.clusters.delete",
@@ -284,7 +333,7 @@
]
},
"getJwks": {
"description": "GetJSONWebKeys gets the public component of the cluster signing keys in\nJSON Web Key format.\nThis API is not yet intended for general use, and is not available for all\nclusters.",
"description": "Gets the public component of the cluster signing keys in\nJSON Web Key format.\nThis API is not yet intended for general use, and is not available for all\nclusters.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/jwks",
"httpMethod": "GET",
"id": "container.projects.locations.clusters.getJwks",
@@ -303,10 +352,7 @@
"path": "v1/{+parent}/jwks",
"response": {
"$ref": "GetJSONWebKeysResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"list": {
"description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
@@ -484,7 +530,7 @@
]
},
"setMasterAuth": {
"description": "Used to set master auth materials. Currently supports :-\nChanging the admin password for a specific cluster.\nThis can be either via password generation or explicitly set the password.",
"description": "Sets master auth materials. Currently supports changing the admin password\nor a specific cluster, either via password generation or explicitly setting\nthe password.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.setMasterAuth",
@@ -540,7 +586,7 @@
]
},
"setNetworkPolicy": {
"description": "Enables/Disables Network Policy for a cluster.",
"description": "Enables or disables Network Policy for a cluster.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.setNetworkPolicy",
@@ -596,7 +642,7 @@
]
},
"startIpRotation": {
"description": "Start master IP rotation.",
"description": "Starts master IP rotation.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.startIpRotation",
@@ -757,7 +803,7 @@
]
},
"get": {
"description": "Retrieves the node pool requested.",
"description": "Retrieves the requested node pool.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
"httpMethod": "GET",
"id": "container.projects.locations.clusters.nodePools.get",
@@ -842,7 +888,7 @@
]
},
"rollback": {
"description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
"description": "Rolls back a previously Aborted or Failed NodePool upgrade.\nThis makes no changes if the last upgrade successfully completed.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.nodePools.rollback",
@@ -870,7 +916,7 @@
]
},
"setAutoscaling": {
"description": "Sets the autoscaling settings for a specific node pool.",
"description": "Sets the autoscaling settings for the specified node pool.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.nodePools.setAutoscaling",
@@ -954,7 +1000,7 @@
]
},
"update": {
"description": "Updates the version and/or image type for a specific node pool.",
"description": "Updates the version and/or image type for the specified node pool.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
"httpMethod": "PUT",
"id": "container.projects.locations.clusters.nodePools.update",
@@ -986,7 +1032,7 @@
"well-known": {
"methods": {
"getOpenid-configuration": {
"description": "GetOpenIDConfig gets the OIDC discovery document for the cluster.\nSee the OpenID Connect Discovery 1.0 specification for details.\nhttps://openid.net/specs/openid-connect-discovery-1_0.html\nThis API is not yet intended for general use, and is not available for all\nclusters.",
"description": "Gets the OIDC discovery document for the cluster.\nSee the\n[OpenID Connect Discovery 1.0\nspecification](https://openid.net/specs/openid-connect-discovery-1_0.html)\nfor details.\nThis API is not yet intended for general use, and is not available for all\nclusters.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/.well-known/openid-configuration",
"httpMethod": "GET",
"id": "container.projects.locations.clusters.well-known.getOpenid-configuration",
@@ -1005,10 +1051,7 @@
"path": "v1/{+parent}/.well-known/openid-configuration",
"response": {
"$ref": "GetOpenIDConfigResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
@@ -1126,7 +1169,7 @@
"zones": {
"methods": {
"getServerconfig": {
"description": "Returns configuration info about the Kubernetes Engine service.",
"description": "Returns configuration info about the Google Kubernetes Engine service.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
"httpMethod": "GET",
"id": "container.projects.zones.getServerconfig",
@@ -1248,7 +1291,7 @@
]
},
"create": {
"description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
"description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe Kubelet creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range the cluster is using.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.create",
@@ -1282,7 +1325,7 @@
]
},
"delete": {
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster,\nsuch as load balancer resources, are not deleted if they weren't present\nwhen the cluster was initially created.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"httpMethod": "DELETE",
"id": "container.projects.zones.clusters.delete",
@@ -1691,7 +1734,7 @@
]
},
"setMasterAuth": {
"description": "Used to set master auth materials. Currently supports :-\nChanging the admin password for a specific cluster.\nThis can be either via password generation or explicitly set the password.",
"description": "Sets master auth materials. Currently supports changing the admin password\nor a specific cluster, either via password generation or explicitly setting\nthe password.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.setMasterAuth",
@@ -1732,7 +1775,7 @@
]
},
"setNetworkPolicy": {
"description": "Enables/Disables Network Policy for a cluster.",
"description": "Enables or disables Network Policy for a cluster.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.setNetworkPolicy",
@@ -1773,7 +1816,7 @@
]
},
"startIpRotation": {
"description": "Start master IP rotation.",
"description": "Starts master IP rotation.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.startIpRotation",
@@ -1859,7 +1902,7 @@
"nodePools": {
"methods": {
"autoscaling": {
"description": "Sets the autoscaling settings for a specific node pool.",
"description": "Sets the autoscaling settings for the specified node pool.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.nodePools.autoscaling",
@@ -1998,7 +2041,7 @@
]
},
"get": {
"description": "Retrieves the node pool requested.",
"description": "Retrieves the requested node pool.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
"httpMethod": "GET",
"id": "container.projects.zones.clusters.nodePools.get",
@@ -2091,7 +2134,7 @@
]
},
"rollback": {
"description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
"description": "Rolls back a previously Aborted or Failed NodePool upgrade.\nThis makes no changes if the last upgrade successfully completed.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.nodePools.rollback",
@@ -2235,7 +2278,7 @@
]
},
"update": {
"description": "Updates the version and/or image type for a specific node pool.",
"description": "Updates the version and/or image type for the specified node pool.",
"flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.nodePools.update",
@@ -2415,7 +2458,7 @@
}
}
},
"revision": "20190316",
"revision": "20190610",
"rootUrl": "https://container.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
@@ -2448,7 +2491,7 @@
},
"kubernetesDashboard": {
"$ref": "KubernetesDashboard",
"description": "Configuration for the Kubernetes Dashboard."
"description": "Configuration for the Kubernetes Dashboard.\nThis addon is deprecated, and will be disabled in 1.15. It is recommended\nto use the Cloud Console to manage and monitor your Kubernetes clusters,\nworkloads and applications. For more information, see:\nhttps://cloud.google.com/kubernetes-engine/docs/concepts/dashboards"
},
"networkPolicyConfig": {
"$ref": "NetworkPolicyConfig",
@@ -2472,6 +2515,17 @@
},
"type": "object"
},
"BigQueryDestination": {
"description": "Parameters for using BigQuery as the destination of resource usage export.",
"id": "BigQueryDestination",
"properties": {
"datasetId": {
"description": "The ID of a BigQuery Dataset.",
"type": "string"
}
},
"type": "object"
},
"CancelOperationRequest": {
"description": "CancelOperationRequest cancels a single operation.",
"id": "CancelOperationRequest",
@@ -2554,9 +2608,13 @@
"type": "integer"
},
"currentNodeVersion": {
"description": "[Output only] Deprecated, use\n[NodePool.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePool)\ninstead. The current version of the node software components. If they are\ncurrently at multiple versions because they're in the process of being\nupgraded, this reflects the minimum version of all nodes.",
"description": "[Output only] Deprecated, use\n[NodePools.version](/kubernetes-engine/docs/reference/rest/v1/projects.zones.clusters.nodePools)\ninstead. The current version of the node software components. If they are\ncurrently at multiple versions because they're in the process of being\nupgraded, this reflects the minimum version of all nodes.",
"type": "string"
},
"defaultMaxPodsConstraint": {
"$ref": "MaxPodsConstraint",
"description": "The default constraint on the maximum number of pods that can be run\nsimultaneously on a node in the node pool of this cluster. Only honored\nif cluster created with IP Alias support."
},
"description": {
"description": "An optional description of this cluster.",
"type": "string"
@@ -2582,7 +2640,7 @@
"type": "string"
},
"initialNodeCount": {
"description": "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine <a href=\"/compute/docs/resource-quotas\">resource quota</a>\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.",
"description": "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine <a href=\"/compute/docs/resource-quotas\">resource quota</a>\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\n\nThis field is deprecated, use node_pool.initial_node_count instead.",
"format": "int32",
"type": "integer"
},
@@ -2617,7 +2675,7 @@
"type": "array"
},
"loggingService": {
"description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.",
"description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* \"logging.googleapis.com/kubernetes\" - the Google Cloud Logging\nservice with Kubernetes-native resource model in Stackdriver\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.",
"type": "string"
},
"maintenancePolicy": {
@@ -2654,10 +2712,10 @@
},
"nodeConfig": {
"$ref": "NodeConfig",
"description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used."
"description": "Parameters used in creating the cluster's nodes.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool. (For configuration of each node pool, see\n`node_pool.config`)\n\nIf unspecified, the defaults are used.\nThis field is deprecated, use node_pool.config instead."
},
"nodeIpv4CidrSize": {
"description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange.",
"description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange. This field will only be set when cluster is in route-based network\nmode.",
"format": "int32",
"type": "integer"
},
@@ -2679,6 +2737,10 @@
"description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.",
"type": "object"
},
"resourceUsageExportConfig": {
"$ref": "ResourceUsageExportConfig",
"description": "Configuration for exporting resource usages. Resource usage export is\ndisabled when this config is unspecified."
},
"selfLink": {
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
@@ -2747,6 +2809,10 @@
},
"type": "array"
},
"desiredLoggingService": {
"description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* \"logging.googleapis.com/kubernetes\" - the Google Cloud Logging\nservice with Kubernetes-native resource model in Stackdriver\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no logs will be exported from the cluster",
"type": "string"
},
"desiredMasterAuthorizedNetworksConfig": {
"$ref": "MasterAuthorizedNetworksConfig",
"description": "The desired configuration options for master authorized networks feature."
@@ -2756,7 +2822,7 @@
"type": "string"
},
"desiredMonitoringService": {
"description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
"description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com/kubernetes\" - the Google Cloud Monitoring\nservice with Kubernetes-native resource model in Stackdriver\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
"type": "string"
},
"desiredNodePoolAutoscaling": {
@@ -2770,6 +2836,10 @@
"desiredNodeVersion": {
"description": "The Kubernetes version to change the nodes to (typically an\nupgrade).\n\nUsers may specify either explicit versions offered by\nKubernetes Engine or version aliases, which have the following behavior:\n\n- \"latest\": picks the highest valid Kubernetes version\n- \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version\n- \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version\n- \"1.X.Y-gke.N\": picks an explicit Kubernetes version\n- \"-\": picks the Kubernetes master version",
"type": "string"
},
"desiredResourceUsageExportConfig": {
"$ref": "ResourceUsageExportConfig",
"description": "The desired configuration for exporting resource usage."
}
},
"type": "object"
@@ -2797,6 +2867,17 @@
},
"type": "object"
},
"ConsumptionMeteringConfig": {
"description": "Parameters for controlling consumption metering.",
"id": "ConsumptionMeteringConfig",
"properties": {
"enabled": {
"description": "Whether to enable consumption metering for this cluster. If enabled, a\nsecond BigQuery table will be created to hold resource consumption\nrecords.",
"type": "boolean"
}
},
"type": "object"
},
"CreateClusterRequest": {
"description": "CreateClusterRequest creates a cluster.",
"id": "CreateClusterRequest",
@@ -2856,7 +2937,7 @@
"type": "string"
},
"startTime": {
"description": "Time within the maintenance window to start the maintenance operations.\nTime format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"HH:MM\u201d, where HH : [00-23] and MM : [00-59] GMT.",
"description": "Time within the maintenance window to start the maintenance operations.\nTime format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"HH:MM\", where HH : [00-23] and MM : [00-59] GMT.",
"type": "string"
}
},
@@ -2887,43 +2968,43 @@
"id": "GetOpenIDConfigResponse",
"properties": {
"claims_supported": {
"description": "NOLINT",
"description": "Supported claims.",
"items": {
"type": "string"
},
"type": "array"
},
"grant_types": {
"description": "NOLINT",
"description": "Supported grant types.",
"items": {
"type": "string"
},
"type": "array"
},
"id_token_signing_alg_values_supported": {
"description": "NOLINT",
"description": "supported ID Token signing Algorithms.",
"items": {
"type": "string"
},
"type": "array"
},
"issuer": {
"description": "NOLINT",
"description": "OIDC Issuer.",
"type": "string"
},
"jwks_uri": {
"description": "NOLINT",
"description": "JSON Web Key uri.",
"type": "string"
},
"response_types_supported": {
"description": "NOLINT",
"description": "Supported response types.",
"items": {
"type": "string"
},
"type": "array"
},
"subject_types_supported": {
"description": "NOLINT",
"description": "Supported subject types.",
"items": {
"type": "string"
},
@@ -3014,39 +3095,39 @@
"id": "Jwk",
"properties": {
"alg": {
"description": "NOLINT",
"description": "Algorithm.",
"type": "string"
},
"crv": {
"description": "NOLINT",
"description": "Used for ECDSA keys.",
"type": "string"
},
"e": {
"description": "NOLINT",
"description": "Used for RSA keys.",
"type": "string"
},
"kid": {
"description": "NOLINT",
"description": "Key ID.",
"type": "string"
},
"kty": {
"description": "NOLINT",
"description": "Key Type.",
"type": "string"
},
"n": {
"description": "Fields for RSA keys.\nNOLINT",
"description": "Used for RSA keys.",
"type": "string"
},
"use": {
"description": "NOLINT",
"description": "Permitted uses for the public keys.",
"type": "string"
},
"x": {
"description": "Fields for ECDSA keys.\nNOLINT",
"description": "Used for ECDSA keys.",
"type": "string"
},
"y": {
"description": "NOLINT",
"description": "Used for ECDSA keys.",
"type": "string"
}
},
@@ -3130,6 +3211,24 @@
},
"type": "object"
},
"ListUsableSubnetworksResponse": {
"description": "ListUsableSubnetworksResponse is the response of\nListUsableSubnetworksRequest.",
"id": "ListUsableSubnetworksResponse",
"properties": {
"nextPageToken": {
"description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `page_size`, use the\n`next_page_token` as a value for the query parameter `page_token` in the\nnext request. The value will become empty when there are no more pages.",
"type": "string"
},
"subnetworks": {
"description": "A list of usable subnetworks in the specified network project.",
"items": {
"$ref": "UsableSubnetwork"
},
"type": "array"
}
},
"type": "object"
},
"MaintenancePolicy": {
"description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
"id": "MaintenancePolicy",
@@ -3188,7 +3287,7 @@
"id": "MasterAuthorizedNetworksConfig",
"properties": {
"cidrBlocks": {
"description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.",
"description": "cidr_blocks define up to 50 external networks that could access\nKubernetes master through HTTPS.",
"items": {
"$ref": "CidrBlock"
},
@@ -3201,6 +3300,18 @@
},
"type": "object"
},
"MaxPodsConstraint": {
"description": "Constraints applied to pods.",
"id": "MaxPodsConstraint",
"properties": {
"maxPodsPerNode": {
"description": "Constraint enforced on the max num of pods per node.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"NetworkConfig": {
"description": "NetworkConfig reports the relative names of network & subnetwork.",
"id": "NetworkConfig",
@@ -3294,7 +3405,7 @@
"additionalProperties": {
"type": "string"
},
"description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the reserved keys:\n \"cluster-location\"\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"containerd-configure-sh\"\n \"enable-os-login\"\n \"gci-update-strategy\"\n \"gci-ensure-gke-docker\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
"description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the reserved keys:\n \"cluster-location\"\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"containerd-configure-sh\"\n \"enable-os-login\"\n \"gci-update-strategy\"\n \"gci-ensure-gke-docker\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"user-data\"\n \"disable-address-manager\"\n \"windows-startup-script-ps1\"\n \"common-psm1\"\n \"k8s-node-setup-psm1\"\n \"install-ssh-psm1\"\n \"user-profile-psm1\"\n \"serial-port-logging-enable\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
"type": "object"
},
"minCpuPlatform": {
@@ -3387,10 +3498,19 @@
"$ref": "NodeManagement",
"description": "NodeManagement configuration for this NodePool."
},
"maxPodsConstraint": {
"$ref": "MaxPodsConstraint",
"description": "The constraint on the maximum number of pods that can be run\nsimultaneously on a node in the node pool."
},
"name": {
"description": "The name of the node pool.",
"type": "string"
},
"podIpv4CidrSize": {
"description": "[Output only] The pod CIDR block size per node in this node pool.",
"format": "int32",
"type": "integer"
},
"selfLink": {
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
@@ -3624,6 +3744,25 @@
},
"type": "object"
},
"ResourceUsageExportConfig": {
"description": "Configuration for exporting cluster resource usages.",
"id": "ResourceUsageExportConfig",
"properties": {
"bigqueryDestination": {
"$ref": "BigQueryDestination",
"description": "Configuration to use BigQuery as usage export destination."
},
"consumptionMeteringConfig": {
"$ref": "ConsumptionMeteringConfig",
"description": "Configuration to enable resource consumption metering."
},
"enableNetworkEgressMetering": {
"description": "Whether to enable network egress metering for this cluster. If enabled, a\ndaemonset will be created in the cluster to meter network egress traffic.",
"type": "boolean"
}
},
"type": "object"
},
"RollbackNodePoolUpgradeRequest": {
"description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.",
"id": "RollbackNodePoolUpgradeRequest",
@@ -3911,7 +4050,7 @@
"type": "string"
},
"monitoringService": {
"description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
"description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com/kubernetes\" - the Google Cloud Monitoring\nservice with Kubernetes-native resource model in Stackdriver\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster",
"type": "string"
},
"name": {
@@ -4194,6 +4333,69 @@
}
},
"type": "object"
},
"UsableSubnetwork": {
"description": "UsableSubnetwork resource returns the subnetwork name, its associated network\nand the primary CIDR range.",
"id": "UsableSubnetwork",
"properties": {
"ipCidrRange": {
"description": "The range of internal addresses that are owned by this subnetwork.",
"type": "string"
},
"network": {
"description": "Network Name.\nExample: projects/my-project/global/networks/my-network",
"type": "string"
},
"secondaryIpRanges": {
"description": "Secondary IP ranges.",
"items": {
"$ref": "UsableSubnetworkSecondaryRange"
},
"type": "array"
},
"statusMessage": {
"description": "A human readable status message representing the reasons for cases where\nthe caller cannot use the secondary ranges under the subnet. For example if\nthe secondary_ip_ranges is empty due to a permission issue, an insufficient\npermission message will be given by status_message.",
"type": "string"
},
"subnetwork": {
"description": "Subnetwork Name.\nExample: projects/my-project/regions/us-central1/subnetworks/my-subnet",
"type": "string"
}
},
"type": "object"
},
"UsableSubnetworkSecondaryRange": {
"description": "Secondary IP range of a usable subnetwork.",
"id": "UsableSubnetworkSecondaryRange",
"properties": {
"ipCidrRange": {
"description": "The range of IP addresses belonging to this subnetwork secondary range.",
"type": "string"
},
"rangeName": {
"description": "The name associated with this subnetwork secondary range, used when adding\nan alias IP range to a VM instance.",
"type": "string"
},
"status": {
"description": "This field is to determine the status of the secondary range programmably.",
"enum": [
"UNKNOWN",
"UNUSED",
"IN_USE_SERVICE",
"IN_USE_SHAREABLE_POD",
"IN_USE_MANAGED_POD"
],
"enumDescriptions": [
"UNKNOWN is the zero value of the Status enum. It's not a valid status.",
"UNUSED denotes that this range is unclaimed by any cluster.",
"IN_USE_SERVICE denotes that this range is claimed by a cluster for\nservices. It cannot be used for other clusters.",
"IN_USE_SHAREABLE_POD denotes this range was created by the network admin\nand is currently claimed by a cluster for pods. It can only be used by\nother clusters as a pod range.",
"IN_USE_MANAGED_POD denotes this range was created by GKE and is claimed\nfor pods. It cannot be used for other clusters."
],
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",

268
etc/api/container/v1beta1/container-api.json
View File

@@ -111,7 +111,7 @@
"usableSubnetworks": {
"methods": {
"list": {
"description": "Lists subnetworks that are usable for creating clusters in a project.",
"description": "Lists subnetworks that can be used for creating clusters in a project.",
"flatPath": "v1beta1/projects/{projectsId}/aggregated/usableSubnetworks",
"httpMethod": "GET",
"id": "container.projects.aggregated.usableSubnetworks.list",
@@ -158,7 +158,7 @@
"locations": {
"methods": {
"getServerConfig": {
"description": "Returns configuration info about the Kubernetes Engine service.",
"description": "Returns configuration info about the Google Kubernetes Engine service.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
"httpMethod": "GET",
"id": "container.projects.locations.getServerConfig",
@@ -193,7 +193,7 @@
]
},
"list": {
"description": "Used to fetch locations that offer GKE.",
"description": "Fetches locations that offer Google Kubernetes Engine.",
"flatPath": "v1beta1/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "container.projects.locations.list",
@@ -250,7 +250,7 @@
]
},
"create": {
"description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
"description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe Kubelet creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range the cluster is using.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.create",
@@ -278,7 +278,7 @@
]
},
"delete": {
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster,\nsuch as load balancer resources, are not deleted if they weren't present\nwhen the cluster was initially created.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
"httpMethod": "DELETE",
"id": "container.projects.locations.clusters.delete",
@@ -358,7 +358,7 @@
]
},
"getJwks": {
"description": "GetJSONWebKeys gets the public component of the cluster signing keys in\nJSON Web Key format.\nThis API is not yet intended for general use, and is not available for all\nclusters.",
"description": "Gets the public component of the cluster signing keys in\nJSON Web Key format.\nThis API is not yet intended for general use, and is not available for all\nclusters.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/jwks",
"httpMethod": "GET",
"id": "container.projects.locations.clusters.getJwks",
@@ -377,10 +377,7 @@
"path": "v1beta1/{+parent}/jwks",
"response": {
"$ref": "GetJSONWebKeysResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"list": {
"description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
@@ -558,7 +555,7 @@
]
},
"setMasterAuth": {
"description": "Used to set master auth materials. Currently supports :-\nChanging the admin password for a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
"description": "Sets master auth materials. Currently supports changing the admin password\nor a specific cluster, either via password generation or explicitly setting\nthe password.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.setMasterAuth",
@@ -614,7 +611,7 @@
]
},
"setNetworkPolicy": {
"description": "Enables/Disables Network Policy for a cluster.",
"description": "Enables or disables Network Policy for a cluster.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.setNetworkPolicy",
@@ -670,7 +667,7 @@
]
},
"startIpRotation": {
"description": "Start master IP rotation.",
"description": "Starts master IP rotation.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.startIpRotation",
@@ -831,7 +828,7 @@
]
},
"get": {
"description": "Retrieves the node pool requested.",
"description": "Retrieves the requested node pool.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
"httpMethod": "GET",
"id": "container.projects.locations.clusters.nodePools.get",
@@ -916,7 +913,7 @@
]
},
"rollback": {
"description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
"description": "Rolls back a previously Aborted or Failed NodePool upgrade.\nThis makes no changes if the last upgrade successfully completed.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
"httpMethod": "POST",
"id": "container.projects.locations.clusters.nodePools.rollback",
@@ -1060,7 +1057,7 @@
"well-known": {
"methods": {
"getOpenid-configuration": {
"description": "GetOpenIDConfig gets the OIDC discovery document for the cluster.\nSee the OpenID Connect Discovery 1.0 specification for details.\nhttps://openid.net/specs/openid-connect-discovery-1_0.html\nThis API is not yet intended for general use, and is not available for all\nclusters.",
"description": "Gets the OIDC discovery document for the cluster.\nSee the\n[OpenID Connect Discovery 1.0\nspecification](https://openid.net/specs/openid-connect-discovery-1_0.html)\nfor details.\nThis API is not yet intended for general use, and is not available for all\nclusters.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/.well-known/openid-configuration",
"httpMethod": "GET",
"id": "container.projects.locations.clusters.well-known.getOpenid-configuration",
@@ -1079,10 +1076,7 @@
"path": "v1beta1/{+parent}/.well-known/openid-configuration",
"response": {
"$ref": "GetOpenIDConfigResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
@@ -1159,7 +1153,7 @@
]
},
"list": {
"description": "Lists all operations in a project in a specific zone or all zones.",
"description": "Lists all operations in a project in the specified zone or all zones.",
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "container.projects.locations.operations.list",
@@ -1200,7 +1194,7 @@
"zones": {
"methods": {
"getServerconfig": {
"description": "Returns configuration info about the Kubernetes Engine service.",
"description": "Returns configuration info about the Google Kubernetes Engine service.",
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
"httpMethod": "GET",
"id": "container.projects.zones.getServerconfig",
@@ -1322,7 +1316,7 @@
]
},
"create": {
"description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.",
"description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe Kubelet creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range the cluster is using.",
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.create",
@@ -1356,7 +1350,7 @@
]
},
"delete": {
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.",
"description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster,\nsuch as load balancer resources, are not deleted if they weren't present\nwhen the cluster was initially created.",
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
"httpMethod": "DELETE",
"id": "container.projects.zones.clusters.delete",
@@ -1765,7 +1759,7 @@
]
},
"setMasterAuth": {
"description": "Used to set master auth materials. Currently supports :-\nChanging the admin password for a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.",
"description": "Sets master auth materials. Currently supports changing the admin password\nor a specific cluster, either via password generation or explicitly setting\nthe password.",
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.setMasterAuth",
@@ -1806,7 +1800,7 @@
]
},
"setNetworkPolicy": {
"description": "Enables/Disables Network Policy for a cluster.",
"description": "Enables or disables Network Policy for a cluster.",
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.setNetworkPolicy",
@@ -1847,7 +1841,7 @@
]
},
"startIpRotation": {
"description": "Start master IP rotation.",
"description": "Starts master IP rotation.",
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.startIpRotation",
@@ -2072,7 +2066,7 @@
]
},
"get": {
"description": "Retrieves the node pool requested.",
"description": "Retrieves the requested node pool.",
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
"httpMethod": "GET",
"id": "container.projects.zones.clusters.nodePools.get",
@@ -2165,7 +2159,7 @@
]
},
"rollback": {
"description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.",
"description": "Rolls back a previously Aborted or Failed NodePool upgrade.\nThis makes no changes if the last upgrade successfully completed.",
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
"httpMethod": "POST",
"id": "container.projects.zones.clusters.nodePools.rollback",
@@ -2447,7 +2441,7 @@
]
},
"list": {
"description": "Lists all operations in a project in a specific zone or all zones.",
"description": "Lists all operations in a project in the specified zone or all zones.",
"flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations",
"httpMethod": "GET",
"id": "container.projects.zones.operations.list",
@@ -2489,7 +2483,7 @@
}
}
},
"revision": "20190316",
"revision": "20190610",
"rootUrl": "https://container.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
@@ -2530,7 +2524,7 @@
},
"kubernetesDashboard": {
"$ref": "KubernetesDashboard",
"description": "Configuration for the Kubernetes Dashboard."
"description": "Configuration for the Kubernetes Dashboard.\nThis addon is deprecated, and will be disabled in 1.15. It is recommended\nto use the Cloud Console to manage and monitor your Kubernetes clusters,\nworkloads and applications. For more information, see:\nhttps://cloud.google.com/kubernetes-engine/docs/concepts/dashboards"
},
"networkPolicyConfig": {
"$ref": "NetworkPolicyConfig",
@@ -2569,6 +2563,24 @@
},
"type": "object"
},
"AutoprovisioningNodePoolDefaults": {
"description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool created\nby NAP.",
"id": "AutoprovisioningNodePoolDefaults",
"properties": {
"oauthScopes": {
"description": "Scopes that are used by NAP when creating node pools. If oauth_scopes are\nspecified, service_account should be empty.",
"items": {
"type": "string"
},
"type": "array"
},
"serviceAccount": {
"description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nservice_account is specified, scopes should be empty.",
"type": "string"
}
},
"type": "object"
},
"BigQueryDestination": {
"description": "Parameters for using BigQuery as the destination of resource usage export.",
"id": "BigQueryDestination",
@@ -2696,7 +2708,7 @@
"type": "integer"
},
"currentNodeVersion": {
"description": "[Output only] Deprecated, use\n[NodePool.version](/kubernetes-engine/docs/reference/rest/v1beta1/projects.zones.clusters.nodePool)\ninstead. The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.",
"description": "[Output only] Deprecated, use\n[NodePool.version](/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools)\ninstead. The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.",
"type": "string"
},
"databaseEncryption": {
@@ -2732,7 +2744,7 @@
"type": "string"
},
"initialNodeCount": {
"description": "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine <a href=\"/compute/docs/resource-quotas\">resource quota</a>\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.",
"description": "The number of nodes to create in this cluster. You must ensure that your\nCompute Engine <a href=\"/compute/docs/resource-quotas\">resource quota</a>\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\n\nThis field is deprecated, use node_pool.initial_node_count instead.",
"format": "int32",
"type": "integer"
},
@@ -2808,10 +2820,10 @@
},
"nodeConfig": {
"$ref": "NodeConfig",
"description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used."
"description": "Parameters used in creating the cluster's nodes.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool. (For configuration of each node pool, see\n`node_pool.config`)\n\nIf unspecified, the defaults are used.\nThis field is deprecated, use node_pool.config instead."
},
"nodeIpv4CidrSize": {
"description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange.",
"description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange. This field will only be set when cluster is in route-based network\nmode.",
"format": "int32",
"type": "integer"
},
@@ -2883,6 +2895,10 @@
"description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected. On output this shows the subnetwork ID instead of\nthe name.",
"type": "string"
},
"tierSettings": {
"$ref": "TierSettings",
"description": "Cluster tier settings."
},
"tpuIpv4CidrBlock": {
"description": "[Output only] The IP address range of the Cloud TPUs in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`).",
"type": "string"
@@ -2891,6 +2907,10 @@
"$ref": "VerticalPodAutoscaling",
"description": "Cluster-level Vertical Pod Autoscaling configuration."
},
"workloadIdentityConfig": {
"$ref": "WorkloadIdentityConfig",
"description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM\npolicies."
},
"zone": {
"description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use location instead.",
"type": "string"
@@ -2902,6 +2922,17 @@
"description": "ClusterAutoscaling contains global, per-cluster information\nrequired by Cluster Autoscaler to automatically adjust\nthe size of the cluster and create/delete\nnode pools based on the current needs.",
"id": "ClusterAutoscaling",
"properties": {
"autoprovisioningLocations": {
"description": "The list of Google Compute Engine [zones](/compute/docs/zones#available)\nin which the NodePool's nodes can be created by NAP.",
"items": {
"type": "string"
},
"type": "array"
},
"autoprovisioningNodePoolDefaults": {
"$ref": "AutoprovisioningNodePoolDefaults",
"description": "AutoprovisioningNodePoolDefaults contains defaults for a node pool\ncreated by NAP."
},
"enableNodeAutoprovisioning": {
"description": "Enables automatic node pool creation and deletion.",
"type": "boolean"
@@ -2972,7 +3003,7 @@
"description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool."
},
"desiredNodePoolId": {
"description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.",
"description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\",\n\"desired_node_pool_autoscaling\", or \"desired_workload_metadata_config\"\nis specified and there is more than one node pool on the cluster.",
"type": "string"
},
"desiredNodeVersion": {
@@ -2983,6 +3014,10 @@
"$ref": "PodSecurityPolicyConfig",
"description": "The desired configuration options for the PodSecurityPolicy feature."
},
"desiredPrivateClusterConfig": {
"$ref": "PrivateClusterConfig",
"description": "The desired private cluster configuration."
},
"desiredResourceUsageExportConfig": {
"$ref": "ResourceUsageExportConfig",
"description": "The desired configuration for exporting resource usage."
@@ -2990,6 +3025,10 @@
"desiredVerticalPodAutoscaling": {
"$ref": "VerticalPodAutoscaling",
"description": "Cluster-level Vertical Pod Autoscaling configuration."
},
"desiredWorkloadIdentityConfig": {
"$ref": "WorkloadIdentityConfig",
"description": "Configuration for Workload Identity."
}
},
"type": "object"
@@ -3017,6 +3056,17 @@
},
"type": "object"
},
"ConsumptionMeteringConfig": {
"description": "Parameters for controlling consumption metering.",
"id": "ConsumptionMeteringConfig",
"properties": {
"enabled": {
"description": "Whether to enable consumption metering for this cluster. If enabled, a\nsecond BigQuery table will be created to hold resource consumption\nrecords.",
"type": "boolean"
}
},
"type": "object"
},
"CreateClusterRequest": {
"description": "CreateClusterRequest creates a cluster.",
"id": "CreateClusterRequest",
@@ -3076,7 +3126,7 @@
"type": "string"
},
"startTime": {
"description": "Time within the maintenance window to start the maintenance operations.\nIt must be in format \"HH:MM\u201d, where HH : [00-23] and MM : [00-59] GMT.",
"description": "Time within the maintenance window to start the maintenance operations.\nIt must be in format \"HH:MM\", where HH : [00-23] and MM : [00-59] GMT.",
"type": "string"
}
},
@@ -3100,7 +3150,7 @@
"enumDescriptions": [
"Should never be set",
"Secrets in etcd are encrypted.",
"Secrets in etcd are stored in plain text (at etcd level) - this is\nunrelated to GCE level full disk encryption."
"Secrets in etcd are stored in plain text (at etcd level) - this is\nunrelated to Google Compute Engine level full disk encryption."
],
"type": "string"
}
@@ -3132,43 +3182,43 @@
"id": "GetOpenIDConfigResponse",
"properties": {
"claims_supported": {
"description": "NOLINT",
"description": "Supported claims.",
"items": {
"type": "string"
},
"type": "array"
},
"grant_types": {
"description": "NOLINT",
"description": "Supported grant types.",
"items": {
"type": "string"
},
"type": "array"
},
"id_token_signing_alg_values_supported": {
"description": "NOLINT",
"description": "supported ID Token signing Algorithms.",
"items": {
"type": "string"
},
"type": "array"
},
"issuer": {
"description": "NOLINT",
"description": "OIDC Issuer.",
"type": "string"
},
"jwks_uri": {
"description": "NOLINT",
"description": "JSON Web Key uri.",
"type": "string"
},
"response_types_supported": {
"description": "NOLINT",
"description": "Supported response types.",
"items": {
"type": "string"
},
"type": "array"
},
"subject_types_supported": {
"description": "NOLINT",
"description": "Supported subject types.",
"items": {
"type": "string"
},
@@ -3297,39 +3347,39 @@
"id": "Jwk",
"properties": {
"alg": {
"description": "NOLINT",
"description": "Algorithm.",
"type": "string"
},
"crv": {
"description": "NOLINT",
"description": "Used for ECDSA keys.",
"type": "string"
},
"e": {
"description": "NOLINT",
"description": "Used for RSA keys.",
"type": "string"
},
"kid": {
"description": "NOLINT",
"description": "Key ID.",
"type": "string"
},
"kty": {
"description": "NOLINT",
"description": "Key Type.",
"type": "string"
},
"n": {
"description": "Fields for RSA keys.\nNOLINT",
"description": "Used for RSA keys.",
"type": "string"
},
"use": {
"description": "NOLINT",
"description": "Permitted uses for the public keys.",
"type": "string"
},
"x": {
"description": "Fields for ECDSA keys.\nNOLINT",
"description": "Used for ECDSA keys.",
"type": "string"
},
"y": {
"description": "NOLINT",
"description": "Used for ECDSA keys.",
"type": "string"
}
},
@@ -3517,7 +3567,6 @@
"type": "string"
},
"clusterCaCertificate": {
"description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.",
"type": "string"
},
"password": {
@@ -3683,7 +3732,7 @@
"additionalProperties": {
"type": "string"
},
"description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the reserved keys:\n \"cluster-location\"\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"containerd-configure-sh\"\n \"enable-oslogin\"\n \"gci-ensure-gke-docker\"\n \"gci-update-strategy\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
"description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the reserved keys:\n \"cluster-location\"\n \"cluster-name\"\n \"cluster-uid\"\n \"configure-sh\"\n \"containerd-configure-sh\"\n \"enable-oslogin\"\n \"gci-ensure-gke-docker\"\n \"gci-update-strategy\"\n \"instance-template\"\n \"kube-env\"\n \"startup-script\"\n \"user-data\"\n \"disable-address-manager\"\n \"windows-startup-script-ps1\"\n \"common-psm1\"\n \"k8s-node-setup-psm1\"\n \"install-ssh-psm1\"\n \"user-profile-psm1\"\n \"serial-port-logging-enable\"\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
"type": "object"
},
"minCpuPlatform": {
@@ -3701,10 +3750,18 @@
"description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninforamtion about preemptible VM instances.",
"type": "boolean"
},
"sandboxConfig": {
"$ref": "SandboxConfig",
"description": "Sandbox configuration for this node."
},
"serviceAccount": {
"description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used.",
"type": "string"
},
"shieldedInstanceConfig": {
"$ref": "ShieldedInstanceConfig",
"description": "Shielded Instance options."
},
"tags": {
"description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035.",
"items": {
@@ -3776,6 +3833,13 @@
},
"type": "array"
},
"locations": {
"description": "The list of Google Compute Engine [zones](/compute/docs/zones#available)\nin which the NodePool's nodes should be located.",
"items": {
"type": "string"
},
"type": "array"
},
"management": {
"$ref": "NodeManagement",
"description": "NodeManagement configuration for this NodePool."
@@ -3788,6 +3852,11 @@
"description": "The name of the node pool.",
"type": "string"
},
"podIpv4CidrSize": {
"description": "[Output only] The pod CIDR block size per node in this node pool.",
"format": "int32",
"type": "integer"
},
"selfLink": {
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
@@ -4060,6 +4129,10 @@
"description": "Configuration options for private clusters.",
"id": "PrivateClusterConfig",
"properties": {
"enablePeeringRouteSharing": {
"description": "Whether to enable route sharing over the network peering.",
"type": "boolean"
},
"enablePrivateEndpoint": {
"description": "Whether the master's internal IP address is used as the cluster endpoint.",
"type": "boolean"
@@ -4112,6 +4185,10 @@
"$ref": "BigQueryDestination",
"description": "Configuration to use BigQuery as usage export destination."
},
"consumptionMeteringConfig": {
"$ref": "ConsumptionMeteringConfig",
"description": "Configuration to enable resource consumption metering."
},
"enableNetworkEgressMetering": {
"description": "Whether to enable network egress metering for this cluster. If enabled, a\ndaemonset will be created in the cluster to meter network egress traffic.",
"type": "boolean"
@@ -4146,6 +4223,17 @@
},
"type": "object"
},
"SandboxConfig": {
"description": "SandboxConfig contains configurations of the sandbox to use for the node.",
"id": "SandboxConfig",
"properties": {
"sandboxType": {
"description": "Type of the sandbox to use for the node (e.g. 'gvisor')",
"type": "string"
}
},
"type": "object"
},
"ServerConfig": {
"description": "Kubernetes Engine service configuration.",
"id": "ServerConfig",
@@ -4545,6 +4633,21 @@
},
"type": "object"
},
"ShieldedInstanceConfig": {
"description": "A set of Shielded Instance options.",
"id": "ShieldedInstanceConfig",
"properties": {
"enableIntegrityMonitoring": {
"description": "Defines whether the instance has integrity monitoring enabled.\n\nEnables monitoring and attestation of the boot integrity of the instance.\nThe attestation is performed against the integrity policy baseline. This\nbaseline is initially derived from the implicitly trusted boot image when\nthe instance is created.",
"type": "boolean"
},
"enableSecureBoot": {
"description": "Defines whether the instance has Secure Boot enabled.\n\nSecure Boot helps ensure that the system only runs authentic software by\nverifying the digital signature of all boot components, and halting the\nboot process if signature verification fails.",
"type": "boolean"
}
},
"type": "object"
},
"StartIPRotationRequest": {
"description": "StartIPRotationRequest creates a new IP for the cluster and then performs\na node upgrade on each node pool to point to the new IP.",
"id": "StartIPRotationRequest",
@@ -4601,6 +4704,27 @@
},
"type": "object"
},
"TierSettings": {
"description": "Cluster tier settings.",
"id": "TierSettings",
"properties": {
"tier": {
"description": "Cluster tier.",
"enum": [
"UNSPECIFIED",
"STANDARD",
"ADVANCED"
],
"enumDescriptions": [
"UNSPECIFIED is the default value. If this value is set during create or\nupdate, it defaults to the project level tier setting.",
"Represents the standard tier or base Google Kubernetes Engine offering.",
"Represents the advanced tier."
],
"type": "string"
}
},
"type": "object"
},
"UpdateClusterRequest": {
"description": "UpdateClusterRequest updates the settings of a cluster.",
"id": "UpdateClusterRequest",
@@ -4667,6 +4791,13 @@
"description": "The desired image type for the node pool.",
"type": "string"
},
"locations": {
"description": "The desired list of Google Compute Engine\n[zones](/compute/docs/zones#available) in which the node pool's nodes\nshould be located. Changing the locations for a node pool will result\nin nodes being either created or removed from the node pool, depending\non whether locations are being added or removed.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name (project, location, cluster, node pool) of the node pool to\nupdate. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.",
"type": "string"
@@ -4683,6 +4814,10 @@
"description": "Deprecated. The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field has been deprecated and replaced by the name field.",
"type": "string"
},
"workloadMetadataConfig": {
"$ref": "WorkloadMetadataConfig",
"description": "The desired image type for the node pool."
},
"zone": {
"description": "Deprecated. The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field has been deprecated and replaced by the name field.",
"type": "string"
@@ -4764,21 +4899,34 @@
},
"type": "object"
},
"WorkloadIdentityConfig": {
"description": "Configuration for the use of Kubernetes Service Accounts in GCP IAM\npolicies.",
"id": "WorkloadIdentityConfig",
"properties": {
"identityNamespace": {
"description": "IAM Identity Namespace to attach all Kubernetes Service Accounts to.",
"type": "string"
}
},
"type": "object"
},
"WorkloadMetadataConfig": {
"description": "WorkloadMetadataConfig defines the metadata configuration to expose to\nworkloads on the node pool.",
"id": "WorkloadMetadataConfig",
"properties": {
"nodeMetadata": {
"description": "NodeMetadata is the configuration for how to expose the node metadata to\nthe workload running on the node.",
"description": "NodeMetadata is the configuration for how to expose metadata to the\nworkloads running on the node.",
"enum": [
"UNSPECIFIED",
"SECURE",
"EXPOSE"
"EXPOSE",
"GKE_METADATA_SERVER"
],
"enumDescriptions": [
"Not set.",
"Prevent workloads not in hostNetwork from accessing certain VM metadata,\nspecifically kube-env, which contains Kubelet credentials, and the\ninstance identity token.\n\nMetadata concealment is a temporary security solution available while the\nbootstrapping process for cluster nodes is being redesigned with\nsignificant security improvements. This feature is scheduled to be\ndeprecated in the future and later removed.",
"Expose all VM metadata to pods."
"Expose all VM metadata to pods.",
"Run the GKE Metadata Server on this node. The GKE Metadata Server exposes\na metadata API to workloads that is compatible with the V1 Compute\nMetadata APIs exposed by the Compute Engine and App Engine Metadata\nServers. This feature can only be enabled if Workload Identity is enabled\nat the cluster level."
],
"type": "string"
}

16
etc/api/containeranalysis/v1alpha1/containeranalysis-api.json
View File

@@ -1204,7 +1204,7 @@
}
}
},
"revision": "20190401",
"revision": "20190625",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"Artifact": {
@@ -1333,7 +1333,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -1653,7 +1653,7 @@
},
"maxAffectedVersion": {
"$ref": "Version",
"description": "The max version of the package in which the vulnerability exists.\nThis field can be used as a filter in list requests."
"description": "The max version of the package in which the vulnerability exists."
},
"minAffectedVersion": {
"$ref": "Version",
@@ -2389,7 +2389,7 @@
},
"resource": {
"$ref": "Resource",
"description": "The resource for which the `Occurrence` applies."
"description": "\nThe resource for which the `Occurrence` applies."
},
"resourceUrl": {
"description": "The unique URL of the image or the container for which the `Occurrence`\napplies. For example, https://gcr.io/project/image@sha256:foo This field\ncan be used as a filter in list requests.",
@@ -2428,7 +2428,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": {
@@ -2579,7 +2579,7 @@
"type": "object"
},
"Resource": {
"description": "Resource is an entity that can have metadata. E.g., a Docker image.",
"description": "\nResource is an entity that can have metadata. E.g., a Docker image.",
"id": "Resource",
"properties": {
"contentHash": {
@@ -2712,7 +2712,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": {
@@ -2913,7 +2913,7 @@
},
"version": {
"$ref": "Version",
"description": "The version of the package being described.\nThis field can be used as a filter in list requests."
"description": "The version of the package being described. This field can be used as a\nfilter in list requests."
}
},
"type": "object"

153
etc/api/containeranalysis/v1beta1/containeranalysis-api.json
View File

@@ -852,7 +852,7 @@
}
}
},
"revision": "20190401",
"revision": "20190625",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"AliasContext": {
@@ -1054,7 +1054,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
"description": "The condition that is associated with this binding.\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",
@@ -1190,6 +1190,143 @@
},
"type": "object"
},
"CVSSv3": {
"description": "Common Vulnerability Scoring System version 3.\nFor details, see https://www.first.org/cvss/specification-document",
"id": "CVSSv3",
"properties": {
"attackComplexity": {
"enum": [
"ATTACK_COMPLEXITY_UNSPECIFIED",
"ATTACK_COMPLEXITY_LOW",
"ATTACK_COMPLEXITY_HIGH"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"attackVector": {
"description": "Base Metrics\nRepresents the intrinsic characteristics of a vulnerability that are\nconstant over time and across user environments.",
"enum": [
"ATTACK_VECTOR_UNSPECIFIED",
"ATTACK_VECTOR_NETWORK",
"ATTACK_VECTOR_ADJACENT",
"ATTACK_VECTOR_LOCAL",
"ATTACK_VECTOR_PHYSICAL"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"availabilityImpact": {
"enum": [
"IMPACT_UNSPECIFIED",
"IMPACT_HIGH",
"IMPACT_LOW",
"IMPACT_NONE"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"baseScore": {
"description": "The base score is a function of the base metric scores.",
"format": "float",
"type": "number"
},
"confidentialityImpact": {
"enum": [
"IMPACT_UNSPECIFIED",
"IMPACT_HIGH",
"IMPACT_LOW",
"IMPACT_NONE"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"exploitabilityScore": {
"format": "float",
"type": "number"
},
"impactScore": {
"format": "float",
"type": "number"
},
"integrityImpact": {
"enum": [
"IMPACT_UNSPECIFIED",
"IMPACT_HIGH",
"IMPACT_LOW",
"IMPACT_NONE"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"privilegesRequired": {
"enum": [
"PRIVILEGES_REQUIRED_UNSPECIFIED",
"PRIVILEGES_REQUIRED_NONE",
"PRIVILEGES_REQUIRED_LOW",
"PRIVILEGES_REQUIRED_HIGH"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"scope": {
"enum": [
"SCOPE_UNSPECIFIED",
"SCOPE_UNCHANGED",
"SCOPE_CHANGED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"userInteraction": {
"enum": [
"USER_INTERACTION_UNSPECIFIED",
"USER_INTERACTION_NONE",
"USER_INTERACTION_REQUIRED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"CloudRepoSourceContext": {
"description": "A CloudRepoSourceContext denotes a particular revision in a Google Cloud\nSource Repo.",
"id": "CloudRepoSourceContext",
@@ -1364,7 +1501,7 @@
},
"maxAffectedVersion": {
"$ref": "Version",
"description": "The max version of the package in which the vulnerability exists."
"description": "Deprecated, do not use. Use fixed_location instead.\n\nThe max version of the package in which the vulnerability exists."
},
"minAffectedVersion": {
"$ref": "Version",
@@ -2397,10 +2534,10 @@
"properties": {
"contentHash": {
"$ref": "Hash",
"description": "The hash of the resource content. For example, the Docker digest."
"description": "Deprecated, do not use. Use uri instead.\n\nThe hash of the resource content. For example, the Docker digest."
},
"name": {
"description": "The name of the resource. For example, the name of a Docker image -\n\"Debian\".",
"description": "Deprecated, do not use. Use uri instead.\n\nThe name of the resource. For example, the name of a Docker image -\n\"Debian\".",
"type": "string"
},
"uri": {
@@ -2527,7 +2664,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": {
@@ -2626,6 +2763,10 @@
"format": "float",
"type": "number"
},
"cvssV3": {
"$ref": "CVSSv3",
"description": "The full description of the CVSSv3."
},
"details": {
"description": "All information about the package to specifically identify this\nvulnerability. One entry per (version range and cpe_uri) the package\nvulnerability has manifested in.",
"items": {

118
etc/api/content/v2.1/content-api.json
View File

@@ -15,7 +15,7 @@
"description": "Manages product items, inventory, and Merchant Center accounts for Google Shopping.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/shopping-content",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/uh6pImLtAzfcW3qnOu2tIOip1lc\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Ip5eh1SzEl02M2LdgZypXgqt0eQ\"",
"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"
@@ -233,7 +233,7 @@
]
},
"link": {
"description": "Performs an action on a link between a Merchant Center account and another account.",
"description": "Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.",
"httpMethod": "POST",
"id": "content.accounts.link",
"parameterOrder": [
@@ -1219,7 +1219,7 @@
"orderinvoices": {
"methods": {
"createchargeinvoice": {
"description": "Creates a charge invoice for a shipment group, and triggers a charge capture for non-facilitated payment orders.",
"description": "Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.",
"httpMethod": "POST",
"id": "content.orderinvoices.createchargeinvoice",
"parameterOrder": [
@@ -1253,7 +1253,7 @@
]
},
"createrefundinvoice": {
"description": "Creates a refund invoice for one or more shipment groups, and triggers a refund for non-facilitated payment orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice.",
"description": "Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice.",
"httpMethod": "POST",
"id": "content.orderinvoices.createrefundinvoice",
"parameterOrder": [
@@ -1874,7 +1874,7 @@
"type": "boolean"
},
"maxResults": {
"description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.\nKnown issue: All List calls will return all Orders without limit regardless of the value of this field.",
"description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.",
"format": "uint32",
"location": "query",
"type": "integer"
@@ -1887,15 +1887,7 @@
"type": "string"
},
"orderBy": {
"description": "The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. \"placedDate desc\" stands for listing orders by placement date, from oldest to most recent. \"placedDate asc\" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.",
"enum": [
"placedDate asc",
"placedDate desc"
],
"enumDescriptions": [
"",
""
],
"description": "Order results by placement date in descending or ascending order.\n\nAcceptable values are:\n- placedDateAsc\n- placedDateDesc",
"location": "query",
"type": "string"
},
@@ -1915,7 +1907,7 @@
"type": "string"
},
"statuses": {
"description": "Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.",
"description": "Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled.",
"enum": [
"active",
"canceled",
@@ -2452,6 +2444,12 @@
"productId"
],
"parameters": {
"feedId": {
"description": "The Content API Supplemental Feed ID.",
"format": "uint64",
"location": "query",
"type": "string"
},
"merchantId": {
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"format": "uint64",
@@ -2510,6 +2508,12 @@
"merchantId"
],
"parameters": {
"feedId": {
"description": "The Content API Supplemental Feed ID.",
"format": "uint64",
"location": "query",
"type": "string"
},
"merchantId": {
"description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
"format": "uint64",
@@ -2886,7 +2890,7 @@
}
}
},
"revision": "20190327",
"revision": "20190702",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Account": {
@@ -3753,6 +3757,19 @@
},
"type": "object"
},
"BusinessDayConfig": {
"id": "BusinessDayConfig",
"properties": {
"businessDays": {
"description": "Regular business days. May not be empty.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CarrierRate": {
"id": "CarrierRate",
"properties": {
@@ -4347,6 +4364,10 @@
"$ref": "CutoffTime",
"description": "Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST."
},
"handlingBusinessDayConfig": {
"$ref": "BusinessDayConfig",
"description": "The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed."
},
"holidayCutoffs": {
"description": "Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.",
"items": {
@@ -4370,13 +4391,17 @@
"type": "integer"
},
"minTransitTimeInDays": {
"description": "Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both.",
"description": "Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both.",
"format": "uint32",
"type": "integer"
},
"transitBusinessDayConfig": {
"$ref": "BusinessDayConfig",
"description": "The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed."
},
"transitTimeTable": {
"$ref": "TransitTable",
"description": "Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both."
"description": "Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}TransitTimeInDays or transitTimeTable can be set, but not both."
}
},
"type": "object"
@@ -5071,7 +5096,7 @@
},
"deliveryDetails": {
"$ref": "OrderDeliveryDetails",
"description": "The details for the delivery."
"description": "Delivery details for shipments."
},
"id": {
"description": "The REST ID of the order. Globally unique.",
@@ -5233,7 +5258,7 @@
},
"marketingRightsInfo": {
"$ref": "OrderCustomerMarketingRightsInfo",
"description": "Customer's marketing preferences."
"description": "Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order."
}
},
"type": "object"
@@ -5242,7 +5267,7 @@
"id": "OrderCustomerMarketingRightsInfo",
"properties": {
"explicitMarketingPreference": {
"description": "Last known user selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty.",
"description": "Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected granted in their most recent order, they can be subscribed to marketing emails. Customers who have chosen denied must not be subscribed, or must be unsubscribed if already opted-in.",
"type": "string"
},
"lastUpdatedTimestamp": {
@@ -5273,6 +5298,13 @@
"OrderLineItem": {
"id": "OrderLineItem",
"properties": {
"adjustments": {
"description": "Price and tax adjustments applied on the line item.",
"items": {
"$ref": "OrderLineItemAdjustment"
},
"type": "array"
},
"annotations": {
"description": "Annotations that are attached to the line item.",
"items": {
@@ -5351,6 +5383,24 @@
},
"type": "object"
},
"OrderLineItemAdjustment": {
"id": "OrderLineItemAdjustment",
"properties": {
"priceAdjustment": {
"$ref": "Price",
"description": "Adjustment for total price of the line item."
},
"taxAdjustment": {
"$ref": "Price",
"description": "Adjustment for total tax of the line item."
},
"type": {
"description": "Type of this adjustment.",
"type": "string"
}
},
"type": "object"
},
"OrderLineItemProduct": {
"id": "OrderLineItemProduct",
"properties": {
@@ -5798,7 +5848,7 @@
"id": "OrderShipment",
"properties": {
"carrier": {
"description": "The carrier handling the shipment.\n\nAcceptable values for US are: \n- \"gsx\" \n- \"ups\" \n- \"usps\" \n- \"fedex\" \n- \"dhl\" \n- \"ecourier\" \n- \"cxt\" \n- \"google\" \n- \"ontrac\" \n- \"emsy\" \n- \"ont\" \n- \"deliv\" \n- \"dynamex\" \n- \"lasership\" \n- \"mpx\" \n- \"uds\" \n\nAcceptable values for FR are: \n- \"colissimo\" \n- \"chronopost\"",
"description": "The carrier handling the shipment.\n\nAcceptable values for US are: \n- \"gsx\" \n- \"ups\" \n- \"usps\" \n- \"fedex\" \n- \"dhl\" \n- \"ecourier\" \n- \"cxt\" \n- \"google\" \n- \"ontrac\" \n- \"emsy\" \n- \"ont\" \n- \"deliv\" \n- \"dynamex\" \n- \"lasership\" \n- \"mpx\" \n- \"uds\" \n- \"efw\" \n\nAcceptable values for FR are: \n- \"colissimo\" \n- \"chronopost\" \n- \"gls\" \n- \"dpd\" \n- \"bpost\"",
"type": "string"
},
"creationDate": {
@@ -7636,7 +7686,7 @@
"description": "Price of the item."
},
"productTypes": {
"description": "Categories of the item (formatted as in products feed specification).",
"description": "Categories of the item (formatted as in products data specification).",
"items": {
"type": "string"
},
@@ -7654,7 +7704,7 @@
"description": "Advertised sale price of the item."
},
"salePriceEffectiveDate": {
"description": "Date range during which the item is on sale (see products feed specification).",
"description": "Date range during which the item is on sale (see products data specification).",
"type": "string"
},
"sellOnGoogleQuantity": {
@@ -7717,6 +7767,10 @@
"description": "The CLDR territory code for the item.",
"type": "string"
},
"taxCategory": {
"description": "The tax category of the product, used to configure detailed tax nexus in account-level tax settings.",
"type": "string"
},
"taxes": {
"description": "Tax information.",
"items": {
@@ -7728,6 +7782,10 @@
"description": "Title of the item.",
"type": "string"
},
"transitTimeLabel": {
"description": "The transit time label of the product, used to group product in account-level transit time tables.",
"type": "string"
},
"unitPricingBaseMeasure": {
"$ref": "ProductUnitPricingBaseMeasure",
"description": "The preference of the denominator of the unit price."
@@ -8007,6 +8065,11 @@
"format": "uint32",
"type": "integer"
},
"feedId": {
"description": "The ContentAPI feed id.",
"format": "uint64",
"type": "string"
},
"merchantId": {
"description": "The ID of the managing account.",
"format": "uint64",
@@ -8861,6 +8924,13 @@
"description": "The two-letter ISO 639-1 language code for the item.",
"type": "string"
},
"fees": {
"description": "Fees for the item. Optional.",
"items": {
"$ref": "OrderLineItemProductFee"
},
"type": "array"
},
"gtin": {
"description": "Global Trade Item Number (GTIN) of the item. Optional.",
"type": "string"

75
etc/api/content/v2/content-api.json
View File

@@ -15,7 +15,7 @@
"description": "Manages product items, inventory, and Merchant Center accounts for Google Shopping.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/shopping-content",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/7PFs3tHKr0DPRTFG-ieZAJUpS6U\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/Uj8dqhaMoa_WrlzoiCKu1I4cNbk\"",
"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"
@@ -250,7 +250,7 @@
]
},
"link": {
"description": "Performs an action on a link between a Merchant Center account and another account.",
"description": "Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.",
"httpMethod": "POST",
"id": "content.accounts.link",
"parameterOrder": [
@@ -1524,7 +1524,7 @@
"orderinvoices": {
"methods": {
"createchargeinvoice": {
"description": "Creates a charge invoice for a shipment group, and triggers a charge capture for non-facilitated payment orders.",
"description": "Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.",
"httpMethod": "POST",
"id": "content.orderinvoices.createchargeinvoice",
"parameterOrder": [
@@ -1558,7 +1558,7 @@
]
},
"createrefundinvoice": {
"description": "Creates a refund invoice for one or more shipment groups, and triggers a refund for non-facilitated payment orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice.",
"description": "Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice.",
"httpMethod": "POST",
"id": "content.orderinvoices.createrefundinvoice",
"parameterOrder": [
@@ -2334,7 +2334,7 @@
"type": "boolean"
},
"maxResults": {
"description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.\nKnown issue: All List calls will return all Orders without limit regardless of the value of this field.",
"description": "The maximum number of orders to return in the response, used for paging. The default value is 25 orders per page, and the maximum allowed value is 250 orders per page.",
"format": "uint32",
"location": "query",
"type": "integer"
@@ -2347,15 +2347,7 @@
"type": "string"
},
"orderBy": {
"description": "The ordering of the returned list. The only supported value are placedDate desc and placedDate asc for now, which returns orders sorted by placement date. \"placedDate desc\" stands for listing orders by placement date, from oldest to most recent. \"placedDate asc\" stands for listing orders by placement date, from most recent to oldest. In future releases we'll support other sorting criteria.",
"enum": [
"placedDate asc",
"placedDate desc"
],
"enumDescriptions": [
"",
""
],
"description": "Order results by placement date in descending or ascending order.\n\nAcceptable values are:\n- placedDateAsc\n- placedDateDesc",
"location": "query",
"type": "string"
},
@@ -2375,7 +2367,7 @@
"type": "string"
},
"statuses": {
"description": "Obtains orders that match any of the specified statuses. Multiple values can be specified with comma separation. Additionally, please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped , partiallyDelivered, delivered, partiallyReturned, returned, and canceled.",
"description": "Obtains orders that match any of the specified statuses. Please note that active is a shortcut for pendingShipment and partiallyShipped, and completed is a shortcut for shipped, partiallyDelivered, delivered, partiallyReturned, returned, and canceled.",
"enum": [
"active",
"canceled",
@@ -3484,7 +3476,7 @@
}
}
},
"revision": "20190327",
"revision": "20190702",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Account": {
@@ -4430,6 +4422,19 @@
},
"type": "object"
},
"BusinessDayConfig": {
"id": "BusinessDayConfig",
"properties": {
"businessDays": {
"description": "Regular business days. May not be empty.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CarrierRate": {
"id": "CarrierRate",
"properties": {
@@ -5057,6 +5062,10 @@
"$ref": "CutoffTime",
"description": "Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST."
},
"handlingBusinessDayConfig": {
"$ref": "BusinessDayConfig",
"description": "The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed."
},
"holidayCutoffs": {
"description": "Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.",
"items": {
@@ -5080,13 +5089,17 @@
"type": "integer"
},
"minTransitTimeInDays": {
"description": "Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}transitTimeInDays or transitTimeTable must be set, but not both.",
"description": "Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both.",
"format": "uint32",
"type": "integer"
},
"transitBusinessDayConfig": {
"$ref": "BusinessDayConfig",
"description": "The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed."
},
"transitTimeTable": {
"$ref": "TransitTable",
"description": "Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}transitTimeInDays or transitTimeTable can be set, but not both."
"description": "Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}TransitTimeInDays or transitTimeTable can be set, but not both."
}
},
"type": "object"
@@ -6047,7 +6060,7 @@
},
"deliveryDetails": {
"$ref": "OrderDeliveryDetails",
"description": "The details for the delivery."
"description": "Delivery details for shipments."
},
"id": {
"description": "The REST ID of the order. Globally unique.",
@@ -6221,7 +6234,7 @@
},
"marketingRightsInfo": {
"$ref": "OrderCustomerMarketingRightsInfo",
"description": "Customer's marketing preferences."
"description": "Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order."
}
},
"type": "object"
@@ -6230,7 +6243,7 @@
"id": "OrderCustomerMarketingRightsInfo",
"properties": {
"explicitMarketingPreference": {
"description": "Last known user selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty.",
"description": "Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected granted in their most recent order, they can be subscribed to marketing emails. Customers who have chosen denied must not be subscribed, or must be unsubscribed if already opted-in.",
"type": "string"
},
"lastUpdatedTimestamp": {
@@ -6792,7 +6805,7 @@
"id": "OrderShipment",
"properties": {
"carrier": {
"description": "The carrier handling the shipment.\n\nAcceptable values for US are: \n- \"gsx\" \n- \"ups\" \n- \"usps\" \n- \"fedex\" \n- \"dhl\" \n- \"ecourier\" \n- \"cxt\" \n- \"google\" \n- \"ontrac\" \n- \"emsy\" \n- \"ont\" \n- \"deliv\" \n- \"dynamex\" \n- \"lasership\" \n- \"mpx\" \n- \"uds\" \n\nAcceptable values for FR are: \n- \"colissimo\" \n- \"chronopost\"",
"description": "The carrier handling the shipment.\n\nAcceptable values for US are: \n- \"gsx\" \n- \"ups\" \n- \"usps\" \n- \"fedex\" \n- \"dhl\" \n- \"ecourier\" \n- \"cxt\" \n- \"google\" \n- \"ontrac\" \n- \"emsy\" \n- \"ont\" \n- \"deliv\" \n- \"dynamex\" \n- \"lasership\" \n- \"mpx\" \n- \"uds\" \n- \"efw\" \n\nAcceptable values for FR are: \n- \"colissimo\" \n- \"chronopost\" \n- \"gls\" \n- \"dpd\" \n- \"bpost\"",
"type": "string"
},
"creationDate": {
@@ -9070,7 +9083,7 @@
"type": "array"
},
"additionalProductTypes": {
"description": "Additional categories of the item (formatted as in products feed specification).",
"description": "Additional categories of the item (formatted as in products data specification).",
"items": {
"type": "string"
},
@@ -9331,7 +9344,7 @@
"description": "Price of the item."
},
"productType": {
"description": "Your category of the item (formatted as in products feed specification).",
"description": "Your category of the item (formatted as in products data specification).",
"type": "string"
},
"promotionIds": {
@@ -9346,7 +9359,7 @@
"description": "Advertised sale price of the item."
},
"salePriceEffectiveDate": {
"description": "Date range during which the item is on sale (see products feed specification).",
"description": "Date range during which the item is on sale (see products data specification).",
"type": "string"
},
"sellOnGoogleQuantity": {
@@ -9798,6 +9811,11 @@
"format": "uint32",
"type": "integer"
},
"feedId": {
"description": "The ContentAPI feed id.",
"format": "uint64",
"type": "string"
},
"merchantId": {
"description": "The ID of the managing account.",
"format": "uint64",
@@ -10591,6 +10609,13 @@
"description": "The two-letter ISO 639-1 language code for the item.",
"type": "string"
},
"fees": {
"description": "Fees for the item. Optional.",
"items": {
"$ref": "OrderLineItemProductFee"
},
"type": "array"
},
"gtin": {
"description": "Global Trade Item Number (GTIN) of the item. Optional.",
"type": "string"

2
etc/api/customsearch/v1/customsearch-api.json
View File

@@ -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": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/DuDrBlvHLFXE8uorI6UhfoH-kUs\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/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"

434
etc/api/dataflow/v1b3/dataflow-api.json
View File

@@ -113,6 +113,43 @@
"resources": {
"projects": {
"methods": {
"deleteSnapshots": {
"description": "Deletes a snapshot.",
"flatPath": "v1b3/projects/{projectId}/snapshots",
"httpMethod": "DELETE",
"id": "dataflow.projects.deleteSnapshots",
"parameterOrder": [
"projectId"
],
"parameters": {
"location": {
"description": "The location that contains this snapshot.",
"location": "query",
"type": "string"
},
"projectId": {
"description": "The ID of the Cloud Platform project that the snapshot belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"snapshotId": {
"description": "The ID of the snapshot.",
"location": "query",
"type": "string"
}
},
"path": "v1b3/projects/{projectId}/snapshots",
"response": {
"$ref": "DeleteSnapshotResponse"
},
"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"
]
},
"workerMessages": {
"description": "Send a worker_message to the service.",
"flatPath": "v1b3/projects/{projectId}/WorkerMessages",
@@ -1266,6 +1303,51 @@
}
}
},
"snapshots": {
"methods": {
"list": {
"description": "Lists snapshots.",
"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshots",
"httpMethod": "GET",
"id": "dataflow.projects.locations.jobs.snapshots.list",
"parameterOrder": [
"projectId",
"location",
"jobId"
],
"parameters": {
"jobId": {
"description": "If specified, list snapshots created from this job.",
"location": "path",
"required": true,
"type": "string"
},
"location": {
"description": "The location to list snapshots in.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "The project ID to list snapshots for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshots",
"response": {
"$ref": "ListSnapshotsResponse"
},
"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"
]
}
}
},
"workItems": {
"methods": {
"lease": {
@@ -1360,6 +1442,172 @@
}
}
},
"snapshots": {
"methods": {
"delete": {
"description": "Deletes a snapshot.",
"flatPath": "v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}",
"httpMethod": "DELETE",
"id": "dataflow.projects.locations.snapshots.delete",
"parameterOrder": [
"projectId",
"location",
"snapshotId"
],
"parameters": {
"location": {
"description": "The location that contains this snapshot.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "The ID of the Cloud Platform project that the snapshot belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"snapshotId": {
"description": "The ID of the snapshot.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}",
"response": {
"$ref": "DeleteSnapshotResponse"
},
"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"
]
},
"get": {
"description": "Gets information about a snapshot.",
"flatPath": "v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}",
"httpMethod": "GET",
"id": "dataflow.projects.locations.snapshots.get",
"parameterOrder": [
"projectId",
"location",
"snapshotId"
],
"parameters": {
"location": {
"description": "The location that contains this snapshot.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "The ID of the Cloud Platform project that the snapshot belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"snapshotId": {
"description": "The ID of the snapshot.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}",
"response": {
"$ref": "Snapshot"
},
"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"
]
},
"list": {
"description": "Lists snapshots.",
"flatPath": "v1b3/projects/{projectId}/locations/{location}/snapshots",
"httpMethod": "GET",
"id": "dataflow.projects.locations.snapshots.list",
"parameterOrder": [
"projectId",
"location"
],
"parameters": {
"jobId": {
"description": "If specified, list snapshots created from this job.",
"location": "query",
"type": "string"
},
"location": {
"description": "The location to list snapshots in.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "The project ID to list snapshots for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1b3/projects/{projectId}/locations/{location}/snapshots",
"response": {
"$ref": "ListSnapshotsResponse"
},
"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"
]
}
}
},
"sql": {
"methods": {
"validate": {
"description": "Validates a GoogleSQL query for Cloud Dataflow syntax. Will always\nconfirm the given query parses correctly, and if able to look up\nschema information from DataCatalog, will validate that the query\nanalyzes properly as well.",
"flatPath": "v1b3/projects/{projectId}/locations/{location}/sql:validate",
"httpMethod": "GET",
"id": "dataflow.projects.locations.sql.validate",
"parameterOrder": [
"projectId",
"location"
],
"parameters": {
"location": {
"description": "The [regional endpoint]\n(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to\nwhich to direct the request.",
"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"
},
"query": {
"description": "The sql query to validate.",
"location": "query",
"type": "string"
}
},
"path": "v1b3/projects/{projectId}/locations/{location}/sql:validate",
"response": {
"$ref": "ValidateResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/userinfo.email"
]
}
}
},
"templates": {
"methods": {
"create": {
@@ -1507,6 +1755,86 @@
}
}
},
"snapshots": {
"methods": {
"get": {
"description": "Gets information about a snapshot.",
"flatPath": "v1b3/projects/{projectId}/snapshots/{snapshotId}",
"httpMethod": "GET",
"id": "dataflow.projects.snapshots.get",
"parameterOrder": [
"projectId",
"snapshotId"
],
"parameters": {
"location": {
"description": "The location that contains this snapshot.",
"location": "query",
"type": "string"
},
"projectId": {
"description": "The ID of the Cloud Platform project that the snapshot belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"snapshotId": {
"description": "The ID of the snapshot.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1b3/projects/{projectId}/snapshots/{snapshotId}",
"response": {
"$ref": "Snapshot"
},
"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"
]
},
"list": {
"description": "Lists snapshots.",
"flatPath": "v1b3/projects/{projectId}/snapshots",
"httpMethod": "GET",
"id": "dataflow.projects.snapshots.list",
"parameterOrder": [
"projectId"
],
"parameters": {
"jobId": {
"description": "If specified, list snapshots created from this job.",
"location": "query",
"type": "string"
},
"location": {
"description": "The location to list snapshots in.",
"location": "query",
"type": "string"
},
"projectId": {
"description": "The project ID to list snapshots for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1b3/projects/{projectId}/snapshots",
"response": {
"$ref": "ListSnapshotsResponse"
},
"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"
]
}
}
},
"templates": {
"methods": {
"create": {
@@ -1644,7 +1972,7 @@
}
}
},
"revision": "20190322",
"revision": "20190628",
"rootUrl": "https://dataflow.googleapis.com/",
"schemas": {
"ApproximateProgress": {
@@ -2239,6 +2567,12 @@
},
"type": "object"
},
"DeleteSnapshotResponse": {
"description": "Response from deleting a snapshot.",
"id": "DeleteSnapshotResponse",
"properties": {},
"type": "object"
},
"DerivedSource": {
"description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.",
"id": "DerivedSource",
@@ -2728,6 +3062,26 @@
},
"type": "object"
},
"HotKeyDetection": {
"description": "Proto describing a hot key detected on a given WorkItem.",
"id": "HotKeyDetection",
"properties": {
"hotKeyAge": {
"description": "The age of the hot key measured from when it was first detected.",
"format": "google-duration",
"type": "string"
},
"systemName": {
"description": "System-defined name of the step containing this hot key.\nUnique across the workflow.",
"type": "string"
},
"userStepName": {
"description": "User-provided name of the step that contains this hot key.",
"type": "string"
}
},
"type": "object"
},
"InstructionInput": {
"description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
"id": "InstructionInput",
@@ -3216,6 +3570,17 @@
},
"description": "The runtime parameters to pass to the job.",
"type": "object"
},
"transformNameMapping": {
"additionalProperties": {
"type": "string"
},
"description": "Only applicable when updating a pipeline. Map of transform name prefixes of\nthe job to be replaced to the corresponding name prefixes of the new job.",
"type": "object"
},
"update": {
"description": "If set, replace the existing pipeline with the name specified by jobName\nwith this pipeline, preserving state.",
"type": "boolean"
}
},
"type": "object"
@@ -3350,6 +3715,20 @@
},
"type": "object"
},
"ListSnapshotsResponse": {
"description": "List of snapshots.",
"id": "ListSnapshotsResponse",
"properties": {
"snapshots": {
"description": "Returned snapshots.",
"items": {
"$ref": "Snapshot"
},
"type": "array"
}
},
"type": "object"
},
"MapTask": {
"description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.",
"id": "MapTask",
@@ -3944,13 +4323,17 @@
"additionalProperties": {
"type": "string"
},
"description": "Additional user labels attached to the job.",
"description": "Additional user labels to be specified for the job.\nKeys and values should follow the restrictions specified in the [labeling\nrestrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions)\npage.",
"type": "object"
},
"bypassTempDirValidation": {
"description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
"type": "boolean"
},
"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"
},
"machineType": {
"description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.",
"type": "string"
@@ -4224,6 +4607,26 @@
"description": "The job this snapshot was created from.",
"type": "string"
},
"state": {
"description": "State of the snapshot.",
"enum": [
"UNKNOWN_SNAPSHOT_STATE",
"PENDING",
"RUNNING",
"READY",
"FAILED",
"DELETED"
],
"enumDescriptions": [
"Unknown state.",
"Snapshot intent to create has been persisted, snapshotting of state has not\nyet started.",
"Snapshotting is being performed.",
"Snapshot has been created and is ready to be used.",
"Snapshot failed to be created.",
"Snapshot has been deleted."
],
"type": "string"
},
"ttl": {
"description": "The time after which this snapshot will be automatically deleted.",
"format": "google-duration",
@@ -4571,7 +4974,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": {
@@ -5078,6 +5481,17 @@
},
"type": "object"
},
"ValidateResponse": {
"description": "Response to the validation request.",
"id": "ValidateResponse",
"properties": {
"errorMessage": {
"description": "Will be empty if validation succeeds.",
"type": "string"
}
},
"type": "object"
},
"WorkItem": {
"description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.",
"id": "WorkItem",
@@ -5164,6 +5578,10 @@
"description": "Other data returned by the service, specific to the particular\nworker harness.",
"type": "object"
},
"hotKeyDetection": {
"$ref": "HotKeyDetection",
"description": "A hot key is a symptom of poor data distribution in which there are enough\nelements mapped to a single key to impact pipeline performance. When\npresent, this field includes metadata associated with any hot key."
},
"leaseExpireTime": {
"description": "Time at which the current lease will expire.",
"format": "google-datetime",
@@ -5280,6 +5698,10 @@
"description": "WorkerHealthReport contains information about the health of a worker.\n\nThe VM should be identified by the labels attached to the WorkerMessage that\nthis health ping belongs to.",
"id": "WorkerHealthReport",
"properties": {
"msg": {
"description": "A message describing any unusual health reports.",
"type": "string"
},
"pods": {
"description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.",
"items": {
@@ -5296,8 +5718,12 @@
"format": "google-duration",
"type": "string"
},
"vmIsBroken": {
"description": "Whether the VM is in a permanently broken state.\nBroken VMs should be abandoned or deleted ASAP to avoid assigning or\ncompleting any work.",
"type": "boolean"
},
"vmIsHealthy": {
"description": "Whether the VM is healthy.",
"description": "Whether the VM is currently healthy.",
"type": "boolean"
},
"vmStartupTime": {

1400
etc/api/datafusion/v1beta1/datafusion-api.json Normal file
View File

File diff suppressed because it is too large Load Diff

269
etc/api/dataproc/v1/dataproc-api.json
View File

@@ -108,6 +108,94 @@
"resources": {
"locations": {
"resources": {
"autoscalingPolicies": {
"methods": {
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.locations.autoscalingPolicies.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.locations.autoscalingPolicies.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataproc.projects.locations.autoscalingPolicies.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"workflowTemplates": {
"methods": {
"create": {
@@ -415,6 +503,94 @@
},
"regions": {
"resources": {
"autoscalingPolicies": {
"methods": {
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.autoscalingPolicies.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.autoscalingPolicies.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataproc.projects.regions.autoscalingPolicies.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"clusters": {
"methods": {
"create": {
@@ -1634,7 +1810,7 @@
}
}
},
"revision": "20190313",
"revision": "20190620",
"rootUrl": "https://dataproc.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
@@ -1659,7 +1835,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently."
"description": "The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:\nallUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.\nallAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.\nuser:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .\nserviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.\ngroup:{emailid}: An email address that represents a Google group. For example, admins@example.com.\ndomain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.",
@@ -1743,7 +1919,7 @@
"description": "Optional. The shared Compute Engine config settings for all instances in a cluster."
},
"initializationActions": {
"description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
"description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google\nhttp://metadata/computeMetadata/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
"items": {
"$ref": "NodeInitializationAction"
},
@@ -1757,6 +1933,10 @@
"$ref": "InstanceGroupConfig",
"description": "Optional. The Compute Engine config settings for additional worker instances in a cluster."
},
"securityConfig": {
"$ref": "SecurityConfig",
"description": "Optional. Security settings for the cluster."
},
"softwareConfig": {
"$ref": "SoftwareConfig",
"description": "Optional. The config settings for software inside the cluster."
@@ -2071,7 +2251,7 @@
"type": "array"
},
"subnetworkUri": {
"description": "Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0",
"description": "Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0\nprojects/[project_id]/regions/us-east1/subnetworks/sub0\nsub0",
"type": "string"
},
"tags": {
@@ -2439,6 +2619,70 @@
},
"type": "object"
},
"KerberosConfig": {
"description": "Specifies Kerberos related configuration.",
"id": "KerberosConfig",
"properties": {
"crossRealmTrustAdminServer": {
"description": "Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.",
"type": "string"
},
"crossRealmTrustKdc": {
"description": "Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.",
"type": "string"
},
"crossRealmTrustRealm": {
"description": "Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.",
"type": "string"
},
"crossRealmTrustSharedPasswordUri": {
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.",
"type": "string"
},
"enableKerberos": {
"description": "Optional. Flag to indicate whether to Kerberize the cluster.",
"type": "boolean"
},
"kdcDbKeyUri": {
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.",
"type": "string"
},
"keyPasswordUri": {
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.",
"type": "string"
},
"keystorePasswordUri": {
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.",
"type": "string"
},
"keystoreUri": {
"description": "Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.",
"type": "string"
},
"kmsKeyUri": {
"description": "Required. The uri of the KMS key used to encrypt various sensitive files.",
"type": "string"
},
"rootPrincipalPasswordUri": {
"description": "Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.",
"type": "string"
},
"tgtLifetimeHours": {
"description": "Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.",
"format": "int32",
"type": "integer"
},
"truststorePasswordUri": {
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.",
"type": "string"
},
"truststoreUri": {
"description": "Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.",
"type": "string"
}
},
"type": "object"
},
"ListClustersResponse": {
"description": "The list of all clusters in a project.",
"id": "ListClustersResponse",
@@ -2610,7 +2854,7 @@
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.",
"type": "string"
},
"response": {
@@ -2845,6 +3089,17 @@
},
"type": "object"
},
"SecurityConfig": {
"description": "Security related configuration, including Kerberos.",
"id": "SecurityConfig",
"properties": {
"kerberosConfig": {
"$ref": "KerberosConfig",
"description": "Kerberos related configuration."
}
},
"type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for SetIamPolicy method.",
"id": "SetIamPolicyRequest",
@@ -2861,7 +3116,7 @@
"id": "SoftwareConfig",
"properties": {
"imageVersion": {
"description": "Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as \"1.2\" (including a subminor version, such as \"1.2.29\"), or the \"preview\" version. If unspecified, it defaults to the latest version.",
"description": "Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as \"1.2\" (including a subminor version, such as \"1.2.29\"), or the \"preview\" version. If unspecified, it defaults to the latest Debian version.",
"type": "string"
},
"optionalComponents": {
@@ -2990,7 +3245,7 @@
"type": "object"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {

46
etc/api/dataproc/v1beta2/dataproc-api.json
View File

@@ -223,7 +223,7 @@
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return in each response.",
"description": "Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -727,7 +727,7 @@
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy",
"httpMethod": "POST",
"httpMethod": "GET",
"id": "dataproc.projects.regions.autoscalingPolicies.getIamPolicy",
"parameterOrder": [
"resource"
@@ -742,9 +742,6 @@
}
},
"path": "v1beta2/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
@@ -762,7 +759,7 @@
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return in each response.",
"description": "Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -2086,7 +2083,7 @@
}
}
},
"revision": "20190313",
"revision": "20190620",
"rootUrl": "https://dataproc.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
@@ -2196,7 +2193,7 @@
"properties": {
"condition": {
"$ref": "Expr",
"description": "Unimplemented. The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently."
"description": "The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:\nallUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.\nallAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.\nuser:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .\nserviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.\ngroup:{emailid}: An email address that represents a Google group. For example, admins@example.com.\ndomain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.",
@@ -2646,7 +2643,7 @@
"type": "array"
},
"subnetworkUri": {
"description": "Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0",
"description": "Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0\nprojects/[project_id]/regions/us-east1/subnetworks/sub0\nsub0",
"type": "string"
},
"tags": {
@@ -2778,6 +2775,7 @@
"type": "integer"
},
"weight": {
"description": "Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.",
"format": "int32",
"type": "integer"
}
@@ -3072,7 +3070,7 @@
"type": "string"
},
"crossRealmTrustSharedPasswordUri": {
"description": "Optional. The GCS uri of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.",
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.",
"type": "string"
},
"enableKerberos": {
@@ -3080,19 +3078,19 @@
"type": "boolean"
},
"kdcDbKeyUri": {
"description": "Optional. The GCS uri of a KMS encrypted file containing the master key of the KDC database.",
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.",
"type": "string"
},
"keyPasswordUri": {
"description": "Optional. The GCS uri of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.",
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.",
"type": "string"
},
"keystorePasswordUri": {
"description": "Optional. The GCS uri of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.",
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.",
"type": "string"
},
"keystoreUri": {
"description": "Optional. The GCS uri of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.",
"description": "Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.",
"type": "string"
},
"kmsKeyUri": {
@@ -3100,7 +3098,7 @@
"type": "string"
},
"rootPrincipalPasswordUri": {
"description": "Required. The GCS uri of a KMS encrypted file containing the root principal password.",
"description": "Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.",
"type": "string"
},
"tgtLifetimeHours": {
@@ -3109,11 +3107,11 @@
"type": "integer"
},
"truststorePasswordUri": {
"description": "Optional. The GCS uri of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.",
"description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.",
"type": "string"
},
"truststoreUri": {
"description": "Optional. The GCS uri of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.",
"description": "Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.",
"type": "string"
}
},
@@ -3330,7 +3328,7 @@
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.",
"type": "string"
},
"response": {
@@ -3667,7 +3665,7 @@
"id": "SoftwareConfig",
"properties": {
"imageVersion": {
"description": "Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as \"1.2\" (including a subminor version, such as \"1.2.29\"), or the \"preview\" version. If unspecified, it defaults to the latest version.",
"description": "Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as \"1.2\" (including a subminor version, such as \"1.2.29\"), or the \"preview\" version. If unspecified, it defaults to the latest Debian version.",
"type": "string"
},
"optionalComponents": {
@@ -3675,25 +3673,25 @@
"enumDescriptions": [
"Unspecified component.",
"The Anaconda python distribution.",
"The Druid query engine.",
"The Hive Web HCatalog (the REST service for accessing HCatalog).",
"The Jupyter Notebook.",
"The Kerberos security feature.",
"The Presto query engine.",
"The Zeppelin notebook.",
"The Zookeeper service.",
"The Druid query engine."
"The Zookeeper service."
],
"items": {
"enum": [
"COMPONENT_UNSPECIFIED",
"ANACONDA",
"DRUID",
"HIVE_WEBHCAT",
"JUPYTER",
"KERBEROS",
"PRESTO",
"ZEPPELIN",
"ZOOKEEPER",
"DRUID"
"ZOOKEEPER"
],
"type": "string"
},
@@ -3847,7 +3845,7 @@
"type": "object"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {

12
etc/api/datastore/v1/datastore-api.json
View File

@@ -564,7 +564,7 @@
}
}
},
"revision": "20190105",
"revision": "20190421",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
"AllocateIdsRequest": {
@@ -645,7 +645,7 @@
],
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
"Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions\n[here](https://cloud.google.com/datastore/docs/concepts/transactions).",
"Non-transactional: The mutations may not apply as all or none."
],
"type": "string"
@@ -1322,7 +1322,7 @@
"type": "object"
},
"GqlQuery": {
"description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
"description": "A [GQL\nquery](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
"id": "GqlQuery",
"properties": {
"allowLiterals": {
@@ -1637,7 +1637,7 @@
"type": "array"
},
"endCursor": {
"description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same\nquery](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"format": "byte",
"type": "string"
},
@@ -1677,7 +1677,7 @@
"type": "array"
},
"startCursor": {
"description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same\nquery](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"format": "byte",
"type": "string"
}
@@ -1877,7 +1877,7 @@
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[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 message,\nand 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). 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.",
"id": "Status",
"properties": {
"code": {

4
etc/api/datastore/v1beta1/datastore-api.json
View File

@@ -166,7 +166,7 @@
}
}
},
"revision": "20190105",
"revision": "20190421",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
"GoogleDatastoreAdminV1CommonMetadata": {
@@ -602,7 +602,7 @@
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[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 message,\nand 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). 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.",
"id": "Status",
"properties": {
"code": {

10
etc/api/datastore/v1beta3/datastore-api.json
View File

@@ -306,7 +306,7 @@
}
}
},
"revision": "20190105",
"revision": "20190421",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
"AllocateIdsRequest": {
@@ -387,7 +387,7 @@
],
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
"Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions\n[here](https://cloud.google.com/datastore/docs/concepts/transactions).",
"Non-transactional: The mutations may not apply as all or none."
],
"type": "string"
@@ -860,7 +860,7 @@
"type": "object"
},
"GqlQuery": {
"description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
"description": "A [GQL\nquery](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
"id": "GqlQuery",
"properties": {
"allowLiterals": {
@@ -1175,7 +1175,7 @@
"type": "array"
},
"endCursor": {
"description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same\nquery](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"format": "byte",
"type": "string"
},
@@ -1215,7 +1215,7 @@
"type": "array"
},
"startCursor": {
"description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same\nquery](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).",
"format": "byte",
"type": "string"
}

2
etc/api/deploymentmanager/alpha/deploymentmanager-api.json
View File

@@ -24,7 +24,7 @@
"description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/deployment-manager/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/OmfS0K_Z1wKMS2BW_65KIAugN-I\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/OmfS0K_Z1wKMS2BW_65KIAugN-I\"",
"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"

2
etc/api/deploymentmanager/v2/deploymentmanager-api.json
View File

@@ -24,7 +24,7 @@
"description": "Declares, configures, and deploys complex solutions on Google Cloud Platform.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/deployment-manager/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/mx4kSCi5JnN1R9XewhgmOLsHV0s\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/mx4kSCi5JnN1R9XewhgmOLsHV0s\"",
"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"

2
etc/api/deploymentmanager/v2beta/deploymentmanager-api.json
View File

@@ -24,7 +24,7 @@
"description": "The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/deployment-manager/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/YoLKMCopNCizJ_CWKjyBdDdQP1k\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/YoLKMCopNCizJ_CWKjyBdDdQP1k\"",
"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"

6
etc/api/dfareporting/v3.1/dfareporting-api.json
View File

@@ -20,7 +20,7 @@
"description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/doubleclick-advertisers/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/c-GUPwy7XyX1YYYxtbib1bcrYqQ\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/VH4PGjfB6GO21wO-Z1pan3itmoM\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
"x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
@@ -2183,6 +2183,7 @@
"OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
"OBJECT_FLOODLIGHT_ACTVITY",
"OBJECT_FLOODLIGHT_CONFIGURATION",
"OBJECT_FLOODLIGHT_DV360_LINK",
"OBJECT_INSTREAM_CREATIVE",
"OBJECT_LANDING_PAGE",
"OBJECT_MEDIA_ORDER",
@@ -2241,6 +2242,7 @@
"",
"",
"",
"",
""
],
"location": "query",
@@ -9523,7 +9525,7 @@
}
}
},
"revision": "20190206",
"revision": "20190531",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Account": {

6
etc/api/dfareporting/v3.2/dfareporting-api.json
View File

@@ -20,7 +20,7 @@
"description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/doubleclick-advertisers/",
"etag": "\"VPK3KBfpaEgZ16pozGOoMYfKc0U/LujvsVuGeaUSXxPEAwz2rjziDZ8\"",
"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/m_e1pg763lT2azOGbaicH23tu28\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
"x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
@@ -2190,6 +2190,7 @@
"OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
"OBJECT_FLOODLIGHT_ACTVITY",
"OBJECT_FLOODLIGHT_CONFIGURATION",
"OBJECT_FLOODLIGHT_DV360_LINK",
"OBJECT_INSTREAM_CREATIVE",
"OBJECT_LANDING_PAGE",
"OBJECT_MEDIA_ORDER",
@@ -2248,6 +2249,7 @@
"",
"",
"",
"",
""
],
"location": "query",
@@ -9530,7 +9532,7 @@
}
}
},
"revision": "20190206",
"revision": "20190531",
"rootUrl": "https://www.googleapis.com/",
"schemas": {
"Account": {

Some files were not shown because too many files have changed in this diff Show More